Module Upload and Execution

Once you have designed a module, you can upload it to an LSPS server and run it. Note that only a module that is executable can be run or instantiated.

To upload modules from PDS, first connect PDS to a server with LSPS Application Once you have established the connection, you can upload a model to the server and execute it.

Note: You can use also command-line console as well as from the Management Console to deploy and instantiate your model. However, you need to export your Modeling as a deployable bundle first.

When you upload a module with a data model that contains shared Records, tables for the related data is created in the database. If you modify the shared Records and pertinent relationships and upload the module with the same name and version again, the already existing tables need to be adjusted.

Therefore, whenever you are uploading or running a module, you need to define, how to handle such a situation:

• Do nothing with database schema: data-model tables remain unchanged.
• Update the schema by model: New tables, columns and relationships are added; no data is deleted.
• Validate schema first: data-model tables are validated against the new model. In case of inconsistencies, the model upload or launching fails.
• Drop/create schema: data-model tables are dropped and created anew.

Important: The Database Schema Update Strategy setting does not impact LSPS runtime information, such as, data on uploaded models, model instances in the current execution status, persons details, etc. and the data remains unchanged regardless of the setting. Only tables based on module data models are subject to the strategy.

Server Connection from PDS

PDS connections to LSPS servers are set under Runtime Connections > Runtime Connection Settings. The connections to embedded servers are added automatically when the servers are generated (For the PDS Embedded Server, when first started and for the SDK Embedded Server, when the LSPS Application is generated). Other connections must be configured manually.

Connecting PDS to an LSPS Server

To connect PDS to a server with LSPS Application other than the PDS or SDK Embedded Server, do the following:

1. Set up the connection configuration:
   1. On the menu bar, under Runtime Connections, click Runtime Connection Settings.
   2. In the Runtime Connections part of the Preferences dialog box, click Add and define the connection settings:
      • Server name: arbitrary name of the connection
      • Server URL: URL of the server instance to connect to (for example, for the PDS Embedded server http://localhost:8080/lsps-application)
      • User and Password
      • Application URL: URL to the LSPS Application on the server
      • Default Database Schema Update Strategy: the strategy which is set by default on configurations of module upload and run. The configurations are used when uploading and running modules from the Modeling perspective and are created when the module is run or uploaded for the first time from the Modeling perspective.
   3. Click Test Connection to make sure the settings are correct.
   4. Optionally, select the connection: the selected connection is used as default: if you trigger a module upload or run a model from the Modeling perspective and PDS is not connected to an LSPS server, the selected connection is established.
      

      The remote connection set as preferred
2. If required, define a proxy server for your connection.
3. Go to Runtime Connections > Select and click the connection. If you selected the connection as default, simply upload or run a model.

Connecting to an LSPS Server using a Proxy Server

To use a proxy server to connect from PDS to an LSPS Server, do the following:

1. Go to Window > Preferences.
2. In the Preferences dialog, go to General > Network Connections
3. Set the Active Provider option:
   • Direct: no proxy server

   • Manual: as defined in Proxy entries below

     You can define in the Proxy bypass table, the hosts that should be excluded from the proxying.

   • Native: as defined by the operating system
4. Click apply.

Connecting to the PDS Embedded Server

The PDS Embedded Server is an application server with LSPS Server accessible on http://localhost:8080.

To launch the PDS Embedded Server and connect the Process Design Suite to the server, do the following:

1. Go to Runtime Connections -> LSPS Embedded Server.
2. Optionally, select the connection: the selected connection is used as default. If you trigger a module upload or run a model from the Modeling perspective and PDS is not connected to an LSPS server, the selected connection is established.
   

   Runtime Connection page of the Preferences dialog box with connection to PDS Embedded Server as default
3. Click Start.

Alternatively, click the Start Embedded Server ( ) button on the main toolbar.

On start, if the server does not exist, it is created in the .LSPSEmbedded directory of your workspace. To reinstall it, delete the directory and start the server again.

Loading and Resetting Database of the PDS Embedded Server

The content of the LSPS database includes the runtime information, such as uploaded models, model instances in the current execution status, persons details, etc. Before you reset the database consider exporting it so you can load it if necessary. When resetting the database, all data is lost.

To save, restore, or reset the LSPS Embedded Server database, do the following:

1. Stop the Embedded Server.
2. Under Runtime Connections, select LSPS Embedded Server and Database Management.
3. In the Embedded Database Management dialog box:
   • Select a database name and click Load to restore a database.

     Important: If a database is restored, the current database goes lost.

   • Click Save and provide the database name in the displayed dialog box to save the current database.
   • Click Reset to erase the database.

Note: The database is stored in the current workspace in the .LSPSEmbedded folder.

Model Upload

When you upload a module, the module and all its imported modules are uploaded to the LSPS Server of the server to which PDS is connected. An uploaded module is identified by its name and version and if a module with the given name and version is already present on the LSPS Server, its is replaced.

You can upload your modules to your LSPS Server from the Modeling perspective or from the Management Perspective. The upload is performed based on the upload configuration: when you are uploading a module for the first time, PDS automatically creates an upload configuration, which is then used for upload.

Uploading a Module from the Modeling Perspective

Note: Ensure that the server with LSPS Server is running and your PDS is connected to it (Information on the current connection is in the line at the bottom of PDS).

Address line with connection established

To upload a module for the first time, do the following:

1. In GO-BPMN Explorer, right-click the module.
2. In the context menu, click Upload As > Model.

This creates an upload and run configuration, which is used for the next upload and run of the module from the Modeling perspective: To adjust the configuration, do the following:

1. Go to Run > Run Configuration or Upload Configuration.
2. Select the configuration under Model.
3. Adjust the properties of the configuration in the tabs on the right.

Run and upload configuration for the main module

Uploading a Module from the Management Perspective

Note: Ensure that the server with LSPS Server is running and your PDS is connected to it (Information on the current connection is in the line at the bottom of PDS).

Address line with connection established

To upload a module to the LSPS Server to which your PDS is connected, do the following:

1. Display the Module Management view (in the toolbar, click the Management Views button ( ) and click Module Management).
2. In Module Management view, click the Upload ( ) button.
3. In the Model Upload dialog box define the model details. Every model has to be valid (the system validates it on upload); otherwise uploading fails.
4. Click OK. The selected Model is uploaded to the current LSPS Server.
5. If you selected the Do not execute schema update scripts flag, the scripts are available in the Schema Update Scripts tab of the Module Management view. Double-click the respective row to have the script displayed.

You can check the list of uploaded Modules in the Module Management view.

Model Instantiation

Once you uploaded an executable module with its module imports to an LSPS Server, you can run it as a model instance. Typically, you will instantiate Models from the Management perspective, but PDS allows you to upload and instantiate a Model directly from your workspace.

On Model instantiation, the Execution Engine of the LSPS Server creates a runtime version of a model: a model instance. Since you can create multiple model instances of a model, each model instance is created with a unique ID.

In additional, a model instance may define specific properties in the form of key-value pairs. For more information on Model instance lifecycle, refer to the GO-BPMN Modeling Language User Guide.

Instantiating a Model from the Management Perspective

To create a model instance of an uploaded Model from the Management perspective, do the following:

1. In the main toolbar, click the arrow in the Management Views ( ) button and select Model Instances.
2. In the toolbar of the displayed Model Instances view, click Create ( ).
3. In the Model drop-down box of the Model Instance Creation dialog box, choose a model, and click OK.
4. If necessary, in the Properties table, edit the key-value pairs attached to the model instance.

Note: If a Model instance remains in the status Created, check the Error Log for errors. Error Log may contain also error entries of the server if these were caused by a Process Design Suite feature, which appear primarily in the Console view.

Error Log with error entries

Creating a model instance based on an uploaded executable module

Instantiating a Model from the Modeling Perspective

Note: Ensure that the server with LSPS Server is running and your PDS is connected to it (Information on the current connection is in the line at the bottom of PDS).

Address line with connection established

To instantiate a model of a module for the first time, do the following:

1. In GO-BPMN Explorer, right-click the module.
2. In the context menu, click Run As > Model.

This creates an upload and run configuration, and instantiates the module. Next time you run the module from the Modeling perspective, the created configuration is used.

To adjust the configuration, do the following:

1. Go to Run > Run Configuration or Upload Configuration.
2. Select the configuration under Model.
3. Adjust the properties of the configuration in the tabs on the right.

Run and upload configuration for the main module