15.2.3. Configuring the Activiti Engine

Whether you use the embedded Activiti engine, or a remote Activiti engine, you configure the OpenIDM Activiti module in a file named /path/to/openidm/conf/workflow.json. If this file is absent from the configuration, the workflow module is unavailable for use. In the default OpenIDM installation, the workflow.json file assumes an embedded Activiti engine, and has the following configuration: 

{
   "enabled"  : "true"
}

You can disable the workflow module by setting the "enabled" property in this file to "false".

A sample workflow.json file, with all configurable properties, is provided in /path/to/openidm/samples/misc. To configure an Activiti engine beyond the default configuration that is provided, edit this file as required and copy it to the /path/to/openidm/conf directory.

The sample workflow.json file contains the following configuration: 

  {
    "enabled"  : "true",
    "location" : "remote",
    "engine" : {
        "url" : "http://localhost:9090/openidm-workflow-remote-",
        "username" : "youractivitiuser",
        "password" : "youractivitipassword"
    },
    "mail" : {
        "host" : "yourserver.smtp.com",
        "port" : 587,
        "username" : "yourusername",
        "password" : "yourpassword",
        "starttls" : true
    },
    "history" : "audit"
}

These fields have the following meaning:

  • enabled. Indicates whether the Activiti module is enabled for use. Possible values are true or false. The default value is true.

  • location. Indicates whether the Activiti engine is embedded with OpenIDM, or remote. Possible values are embedded or remote. If remote, you must provide details for the engine property, below.

  • engine. Specifies the details of the remote Activiti engine. The following fields must be defined:

    • url. The URL of the remote engine, including the host name and port number.

    • username. A user name for the remote Activiti engine.

    • password. The password for the user specified above.

  • mail. Specifies the details of the mail server that Activiti will use to send email notifications. By default, Activiti uses the mail server localhost:25. To specify a different mail server, enter the details of the mail server here.

    • host. The host of the mail server.

    • port. The port number of the mail server.

    • username. The user name of the account that connects to the mail server.

    • password. The password for the user specified above.

    • startTLS. Whether startTLS should be used to secure the connection.

  • history. Determines the history level that should be used for the Activiti engine. For more information, see Configuring the Activiti History Level.