i2Camunda Configuration Object

From i2Rest
Jump to: navigation, search

i2Camunda configuration is a JSON object which contains all settings required to start and run instance of i2Camunda.

Field Type Description Default value
camunda_url string REQUIRED. URL of Camunda engine

Use this parameter to define URL of Camunda's REST API
Example:

  • http://1.2.3.4:5678/engine-rest/
fetch_filter object REQUIRED. Fetch filter object

This object will be used by fetchAndLock API to get piece of work to i2Camunda instance. See description of fetchAndLock API for details of required fetch_filter parameter
You don't have to define workerId parameter of fetch_object. By default it will created in format "JOB#nnnnnn", where nnnnnn is the number of job of the i2Camunda instance
Pay attention to the variables array - it has to include variable name that will be used as i2camunda_parameters_variable parameter (see below)
Example:

"fetch_filter" :
{
   "maxTasks":1,
   "asyncResponseTimeout":60000,
   "topics": 
   [
      {
         "topicName":"I2CAMUNDA", 
         "lockDuration":10000, 
         "variables":["i2camunda_parameters"]
      }
   ]
},

!!! asyncResponseTimeout parameter used for Long Polling and supported by Camunda 7.9 and higher !!!

i2camunda_parameters_variable string Name of i2Camunda parameters variable

Use this parameter to define the name of variable that will be used in BPMN diagram to pass parameters to i2Camunda instance

i2camunda_parameters
i2camunda_response_variable string Name of i2Camunda response variable

Use this parameter to define the name of variable that will be used in BPMN diagram to get response from i2Camunda instance

i2camunda_response
variables_section string Where to place response variables

It is used to define the place where Camunda stores task's variables. Up to and include Camunda 7.8, it was "variables" section. Starting from Camunda 7.9, the "localVariables" section was introduced to be able to store local variables, visible to this task only.

localVariables
debug integer Debug level

Minimal level of message severity which will be logged at console or syslog.

Valid values

  • 0 - Emergency
  • 1 - Alert
  • 2 - Critical
  • 3 - Error
  • 4 - Warning
  • 5 - Notice
  • 6 - Info
  • 7 - Full
3
syslog string
URL of syslog server

If present, i2Camunda will send logging message to this syslogd server
i2Rest can send logging messages to UDP or to TCP-IP syslog endpoints.
It is possible to start syslogd server on your IBM i - for more information, look at Using syslog with i2Rest Server
Examples:

  • udp://localhost:514
  • http://localhost:1234
Not set, i2Camunda will send log messages to stdout
dcm_client_id string Id of DCM Client application

In case of using https protocol to connect Camunda and/or REST services, i2Camunda will use this identifier of DCM client application to secure connections