BpmFlow
  • BPM Flow Manual
  • Introduction
    • Road Map
  • Installation
    • GemStone/S
      • Login to GemStone/S
        • Login to GemStone/S with JADE
        • Login to GemStone/S with Topaz
    • BPM Flow
      • Run Web Server from Interactive Session
      • Run Web Server from Script
    • Highcharts
    • Orbeon
  • Application Setup
    • Scripts to run the Application
    • Listing OS Processes
    • Indexing
  • Application Manuals
    • Backoffice Manual
      • Main Menu
        • Applications
          • Manage Environments
          • Manage Applications
          • Manage Orbeon Forms
          • Manage Calendars
        • Processes
          • Processes Definitions
          • Define New Process
            • Performers and Roles
            • Gateways Conditions
            • Versioning
            • Remove BPM Process Definition
            • Define a Task to run a Script
            • Bizagi Extended Attributes
            • RACI roles
            • Import Errors Codes
              • Generic errors codes
              • Activities error codes
              • Gateways error codes
              • Subprocess error codes
              • Runtime evaluations error codes
              • Interprocess Comunication codes
              • Integration error codes
              • Unsupported elements error codes
              • Transitions errors codes
          • Monitor Processes
          • Browse Timers
          • Process Categories
          • Cancelled Processes
        • Users and Roles
          • Monitor Users
          • Manage Users
          • Manage Roles
          • Import Roles and Users
          • Export Roles and Users
        • Messages
          • Inbox
          • Outbox
        • Configuration
          • User Preferences
          • Server Setup
          • Login Mode
          • Change Password
          • Set Language
          • Internationalization
    • Frontoffice Manual
      • Main Menu
        • My Tasks
          • Current Tasks
            • View Process Status
          • Finished Tasks
          • Process Categories
        • Unassigned Tasks
          • View Unassgined Tasks
        • New Process
          • Available Processes
          • Granted Tasks
        • Messages
          • Inbox
          • Outbox
        • Configuration
          • Change Password
          • Display References
          • Set Language
      • Main Menu
    • BI Manual
      • Main Menu
        • Dashboards
          • Current Dashboards
          • Old Dashboard
          • Historical Dashboard
        • User Charts
          • My Charts
        • System Charts
          • Global Charts
          • Applications Charts
          • Untitled
          • Processes Charts
            • Creation Day
            • Field Values
            • Field Evolution
            • Processes Average Time
            • Processes Instances
            • Tasks HeatMap
          • Roles Charts
            • Number of Tasks
            • Number of Users
            • Unassigned Tasks
            • Users in Time
          • Users Charts
            • Current Tasks by Type
            • Possible Tasks
            • Finished Tasks by Type
            • Tasks Average Time
        • Compare Fields
          • Field Comparison
        • Chart Repository
  • Functional and Technical Information
    • Anonymous Process Creation
    • Scalable Vector Graphics Support
    • Timers
      • Event Monitor Timespan
      • Process Creation Timer
      • Task Timers
      • Timers and Caledars
    • States
      • Process States
    • Tasks Assignation Policy
    • Partial Execution Framework
      • Technical Information
      • Functional Information
    • Roles and Performers
    • Debugging Process Execution
      • Manually inspect a BPM Process Instance
      • Automatically Generate a Test Case
  • Engineering Models
    • 4+1 Architecture Models
      • Logical View
        • BPM Components Architecture
        • BPM Environments or Tenants
        • Users & Roles - Processes & Forms
        • BPM Model
        • Orbeon Form Model
        • Seaside Component Model
        • Task Creation Clockwork
        • XPDL Process Generator
        • User Messages
          • User Inbox
          • User Outbox
        • Searching Field values in Bpm Processes
      • Development View
      • Process View
        • Seaside Orbeon Integration
          • GemStone to Orbeon
          • Orbeon to GemStone
      • Physical View
      • Scenarios
    • Architecture for Atop Applications
      • Atop Model Integration with BPM Flow
        • User Methods
          • asBpmUser
          • canDelete
          • finalizeAssignment
          • getAllAvailableTaskAssignmentsIn
          • getAllTaskAssignmentsWithId
          • getApplicationsIn
          • getBackofficeApplicationsIn
          • getBpmEnvironments
          • getCurrentAssignmentsIn
          • getMyTaskAssignmentsWithId
          • getProcessInstanceCategoriesFor
          • getProperty
          • getVisibleRolesIn
          • getVisibleUsersIn
          • isInAdminsEnvironment
          • languageName
          • lateralListPagingSize
          • regularListPagingSize
          • roleName
          • rolesIn
          • take
          • transitionDisplayModeIsExpanded
          • untake
          • username
          • userOptions
        • Role Methods
          • asBpmRole
          • bpmApplication
          • bpmEnvironment
          • getApplicationName
          • isBackofficeRole
          • isGranted
      • BPM Subclassification
        • Create subclass of Bpm Process Browser
        • Create subclass of Process Task List
        • Create subclass of Role Manager
        • Create subclass of User Manager
        • Create subclass of Unassigned Tasks Bag
  • Troubleshooting
    • Requests from Orbeon
  • Orbeon Integration
    • Orbeon Persistence Layer for GemStone/S
      • Install GemStone/S
      • Install Persistence Layer
      • Manage Persistence Layer
        • workwith script
        • List of Scripts
        • upgradeGemStone script
      • Manual Configuration
        • Restrictions when Saving Forms
        • Path for Attachments
        • Maintenance of OS Files and Attachments
        • Search Types
        • Indexing
        • Forms Audit
        • Deferred Processing
      • Service Diagrams
        • Form Runner Home
        • Publish or Unpublish Forms in Form Runner
        • Form Builder Summary
        • Orbeon Form Builder Toolbox
        • Forms Summary
        • Save Form Definition in Orbeon Builder
        • Publish Form Definition in Orbeon Builder
        • New Form with one draft
        • New Form with more than one draft
        • Edit
      • Service Http Methods
        • PUT
        • GET
        • POST
        • DELETE
        • LOCK & UNLOCK
      • Technical Information
        • 4+1 Architectual Model
          • Logical View
            • Objects relation Summary
          • Development View
          • Process view
          • Physical view
          • Scenarios
          • Troubleshooting
            • Request From Orbeon
      • Migration from Relational Database to GemStone/S
        • Migration from MySQL
    • Persistence Layer Backoffice
      • Orbeon Server Configuration
      • Orbeon Application Viewer
      • Create Charts with Highcharts
        • Chart Examples
      • Migrate from Relational Database
Powered by GitBook
On this page
  1. Application Setup

Scripts to run the Application

PreviousApplication SetupNextListing OS Processes

Last updated 5 years ago

In this section scripts to manage the Web Application will be explained.

Prerequisites:

  • GemStone/S installed and running

  • BPM application installed.

For more technical information about Gem processes used in these scripts see:

Prerequisites:

The scripts/shell commands can be found in $GS_HOME/shared/repos/BpmFlow directory.

In order to use these scritps the Shell session must have defined the environment variable [GS_HOME]. To set this variable the following bash code can be executed:

export GS_HOME=/home/gemstone/GsDevKit_home
export PATH=$GS_HOME/bin:$PATH

Where [gemstone] is the name of the Linux user and [GsDevKit_home] is where GemStone/S DevKit has been installed.

List of Scripts

The whole project is installed at: /home/linux-user-name/GsDevKit_home/shared/repos/BpmFlow

There are six scripts or shell command in order to manage the Web Application:

install-all.sh stoneName Install all components of BPM Flow on GemStone/S named "stoneName". $ sh install-all.sh devKit_351

register-application.sh stoneName $ sh register-application.sh devKit_351 Register the Web Server to serve requests on GemStone/S named "stoneName". This shell command has to be executed only once. This script read data in ports-all.ini file and register all ports in this file. For example if ports-all.ini has the following content: 8787,8888,8989

This will register the Web Application to be used in ports: 8787,8888,8989. Comma is used to separate ports. The ini's files are in the same directory as the scripts.

unregister-application.sh stoneName $ sh unregister-application.sh devKit_351 To unregister the Web Server on GemStone/S named "stoneName". This shell command has to be used in coordination with register-application.sh script.

start-all.sh stoneName $ sh start-all.sh devKit_351 This command will start a multi-thread Web Application Server on GemStone/S named "stoneName" where each port will be attended by a different (Gem) process. Following the previous example three Gem processes will be created to attend each port. The ports to be attended are defined in ports-all.ini. At registration time (register-application.sh) there is a list of ports in ports-all.ini and each will be active when this script is executed. After executing this script some pid and log files will be create at $GS_HOME/server/stones/devKit_34/logs/. In this case is the path includes devKit_34 because the Stone was created with that name. The pid and log files will be like BPM_server-8787.log and BPM_server-8787.pid. A pair of these file will be create per each port defined in ports-all.ini.

stop-all.sh stoneName $ sh stop-all.sh devKit_351 This command will stop all Gem processes serving the Web Application on all ports on GemStone/S named "stoneName". The Web Application will no longer answer http requests.

start-on.sh stoneName portNumber This command will start a Gem Process on GemStone/S named "stoneName" and port "portNumber". The port number argument must be defined in ports-all.ini file. $ sh start-on.sh devKit_351 8787

stop-on.sh This command will stop the Gem Process running on GemStone/S named "stoneName" and port "portNumber". $sh stop-on.sh devKit_351 8787

start-zn.sh $sh start-zn.sh devKit_351 This command is similar to [start-all.sh] but instead of starting a Gem Process for each port it only start a subset of all ports. The subset is defined in [zn-ports.ini] file.

stop-zn.sh $sh stop-zn.sh devKit_351 This command is similar to [stop-all.sh] but instead of stop all Gem Process in each port it only stop a subset of all ports. The subset is defined in [zn-ports.ini] file.

start-timers-loop.sh $sh start-timers-loop devKit_351 This command will start a Gem Process to process all Timers in the system and should be execute only once.

start-deferred-scripts-loop.sh $sh start-deferred-scripts devKit_351 This command will start a Gem Process to process all deferred Scripts in the system and should be execute only once.

More about Timers here:

https://github.com/GsDevKit/gsApplicationTools/blob/master/docs/gettingStarted.md
Timers