×

Please give details of the problem

Docs

Find

Internal Parameters

Internal parameters are set automatically at process runtime and when opening a web interface.

info_1 The prefix P_ is used by the engine, its use is strictly reserved for internal variables.

Process runtime variables

Persisted variables

The following are available in the internal parameters of the request, they can be used during request execution.

${P_result}: the result of the current executed task; the value of this parameter is modified each time a new task is executed.

${P_task}: the unique identifier of the current process task ${P_task.id}. The value of this parameter is modified each time a new task is executed.

${P_task_url}: the unique url of the manual task form to validate or cancel a given process.

${P_index}: in the case of a task including a loop, this is the current iteration index.

${P_customer}: the customer identifier.

${P_message}: the error message when a task has failed.

${P_request}: the unique identifier of the current process request.

${P_mode}: the execution mode of a launched process - TEST or LIVE.

${P_version}: the version of the launched process.

${P_status}: the execution status of the last action. It has the following structure: {"name":"OK","desc":"The request has succeeded","code":200}

${P_request}: the unique identifier of the current process request.

${P_branch_xxx}: when a process includes a parallel path, all variables of path xxx are grouped under that variable name (where xxx is the identifier of the branch's first step).

${P_user.xxx}: this parameter relates to the person in the current organization who has recently modified the process status (i.e. he has launched a process or has performed a manual task). xxx can take values:

  • login (${P_user.login})
  • name (${P_user.name})
  • id (${P_user.id})

${P_user.extended.xxx} allows you to access the user's metadata e.g. ${P_user.preferences.xxx} allows you to access the user's preferences.

${P_connected_user.xxx}: this parameter relates to the user who is currently connected to a web form (application form or manual task form). xxx can take values:

  • login (${P_connected_user.login})
  • name (${P_connected_user.name})
  • id (${P_connected_user.id})

${P_connected_user.extended.xxx} allows you to access the user's metadata e.g. ${P_connected_user.extended.company}.

${P_initiator}: this parameter takes the same structure as P_user. The initiator is the user in the current organization who started the process.

Web Service variables

The following persisted variables are only accessible following a call to a web service i.e. after using a Connector whose Provider is using the HTTP or HTTPS protocol.

${P_cookie}: the value of the cookie set by the provider in the HTTP header.

${P_header}: this is a structure variable which contains the different parameters of a HTTP request header (e.g. P_header.cookie is equivalent to P_cookie).

Non-persisent request variables

The following variables are NOT persisted in the internal parameters of the request, but you can use them during the request execution.

${P_current_request}: the id of the current request (could be different to P_request in the case of a nested sub process)

${P_branch}: structure which contains all the variable of the current branch (the branch where the code is executed).

Web Interface variables

${context}: the responsive context from which the web interface is accessed. The context can take the following values :

  • web from a desktop browser (default value)
  • mobile from a mobile browser or from RunMyApp on a mobile
  • tablet from a tablet browser or from RunMyApp on a tablet