Open Documentation Menu

Configuring d.velop process

In this topic, you can find information about configuring d.velop process.

Configuring the database

You need a database for the application. It is assumed that you have already created a database for the application to save data in. In addition, two users are required so that the application can log in to the database. For all Unicode characters to be processed correctly, ensure that you set the sorting accordingly when creating the database schema.

The following data is required for the configuration:

  • Database type: The database management system used, e.g. Microsoft SQL Server.

  • Hostname: The name or the IP address of the host on which the database can be accessed.

  • Port: The port at which the database can be accessed on the indicated host.

  • Database name: The name of the database.

  • Database administrator: The name of the user possessing the rights to implement schema changes (e.g. creation of tables or indexes).

  • Password of the database administrator: The password of the administrator

  • Database user: The name of the user to be used during the runtime for access to the database.

  • Password of the database user: The password of the user

To configure the database, proceed as follows.

This is how it works

  1. Select the feature Configuration.

  2. Select the entry Database in the Process settings section.

  3. Enter the connection data.

  4. Select Save configuration.

  5. Restart the application.

Note

For Microsoft SQL Server, the JDBC driver is included in the d.velop process delivery.

If you use a different database, you need a JDBC driver that meets the system requirements. By using the proper JDBC driver, you ensure communication with the database management system.

Using a Microsoft SQL Server database

Please note the following for the use and configuration of a Microsoft SQL Server database:

  • To establish a connection with the database, please enable the TCP/IP protocol for the SQL server.

  • The tables are created in the default schema of the administrative database user.

  • The administrative user must be authorized to create tables and indexes in his/her default schema.

  • The runtime user must use the same default schema as the administrative user.

  • In this schema, the runtime user needs the permissions SELECT, INSERT, UPDATE and DELETE.

  • The two switches ALLOW_SNAPSHOT_ISOLATION and READ_COMMITTED_SNAPSHOT must be configured in the database with the value ON.

Using an Oracle database

Please note the following for the use and configuration of an Oracle database:

  • The administrative user requires the permissions CREATE TABLE and CREATE SESSION. The tables and indexes are created in the schema and in the default tablespace of this user. The user needs the appropriate quota for the tablespace.

  • To establish a connection with the database, a Net Listener with TCP protocol is required. Enter the port of the Listener under Port.

  • Under Database name enter the service name or the SID. This name must be available on the Net Listener.

  • The user names are case sensitive.

  • The runtime user requires the permission CREATE SESSION.

  • The runtime user will be assigned the permissions SELECT, INSERT, UPDATE and DELETE for the tables in the schema of the administrative user.

Changing the host name and port for d.ecs http gateway registration (optional)

The local computer name and the port configured in the setup are normally used for the d.ecs http gateway registration of the application.

If you want to change this data, you can specify the changes in a configuration file. You can find the configuration file under <installation directory of the application>\conf\process-app.properties. If the file does not exist, you can create a file with this name.

You can enter the properties port and serverName in the file.

serverName=myhost.mydomain
port=8087

After applying a change, you need to restart the application for the changes to take effect.

Setting up user roles (optional)

You can use the entry User roles in the feature Configuration to assign a user role to users. All authenticated users are automatically assigned the role of Process user after the setup of d.velop process.

You can assign the following roles to users:

  • Process administrator: Has all permissions for working with d.velop process.

  • Process user: Can start single-use processes and deploy processes.

For example, if you want to assign the role of Process administrator to a user, simply enter the user name in the appropriate field and select him/her.

Setting up HTTPS (optional)

You can encrypt the communication between d.ecs http gateway and the application using HTTPS.

This is how it works

  1. Create a P12 file with the name keystore.p12 in the configuration dossier of the installation directory of the application (\conf\keystore.p12).

  2. Optionally, create the file process-app.properties in the same directory if it does not exist already.

  3. Add the following lines to the file:

    keystorePass=Passwort_des_Keystores

    keyAlias=alias_of_certificate (optional, if only one alias exists in the keystore, this is applied automatically)

  4. Restart the application to complete the setup.

Setting up a cluster

To install multiple instances of the application in a cluster, you need to ensure that all instances use the same configuration. To ensure this, a jStore with a cluster configuration must exist on each system on which the application is to be installed. This way, the installations register with the same d.ecs http gateway.

You also need to ensure that the database configuration is the same for all installations.

This is how it works

  1. Terminate all instances of the application except for one. This way, you ensure that exactly one instance is configured.

  2. Configure the database for the application.

  3. Start the configured instance again to apply the changes.

  4. Copy the files conf\process-app-db.properties and lib\pa-jdbc-*.jar in the installation directory of this instance.

  5. Paste these files into the installation directory of all other instances of the application.

  6. Start all instances.

You can also follow this procedure if you want to apply a change of the connection data for the database.

Warning

Procedure for a software update:

Please note that all instances of the application must be closed before importing a new software version. Afterwards, only restart the instances that have already been updated.

Configuring protocol exports

You would like to configure exports for protocols into a d.3 repository in order to save protocols for long periods.

What you need to know

  • You need a configured d.3 repository in which the protocol exports are saved.

  • You must be logged on with a user that can administer mappings for the d.3 repository.

  • You must create a document type in your repository that has four alphanumeric (or text, depending on your system) properties with a maximum length of 250 characters. Assign these new properties to the process properties next. Enter descriptive names for the properties that match the process properties, e.g. Process, Process Instance, Business Key, and Attachment.

  • If one of the values is longer than 250 characters (or 255 bytes), this value is truncated as appropriate during the export. Three periods indicate the truncated point.

  • If metadata is truncated or if there is an error during the export process, you will see an appropriate note for the process instance in both process monitoring and in the protocol view.

  • You need to create an API key for a user who has administration rights. In addition, the user needs read and write access for this type of document.

This is how it works

  1. Open the Assignments feature.

  2. Add a new mapping.

  3. Select the source Processes.

  4. Add a category and link the source Process log to the required document type.

  5. Link all the properties of the source with document properties of the target. Make sure that all four properties have been mapped.

  6. Save the mapping.

  7. Open the feature Configuration and select DMS export configuration in the section Process settings.

  8. Select the target repository and enter the API key.

  9. Save the changes.

After you have configured the protocol export, you can activate the option for exporting the protocol during the definition of a process.

Changing the base client address (optional)

d.velop process generates URLs, e.g. for notifications, which can be opened by a client (e.g. web browser). The URLs start with the base address of the system.

You can specify an alternate base address for the URL in a configuration file if needed. You can find the file in <installation directory of the application>\conf\process-app.properties\.

Enter the property in the clientBaseUri file.

clientBaseUri=https://myhost.mydomain

Then restart the application for the changes to take effect.