Views: 4510 (Data available since 06.02.2017)
Last Modified: 02.07.2013

The business process template parameters form includes the following tabs: General, Parameters, Variables and Access.

General

The General tab, among the fields common for most of the objects (Name and Description) includes the options controlling the way the process is started.

A business process can be started when a document is created (When added is checked) and/or modified (When changed is checked). Note that the business process can be only started manually if you uncheck both options.

Parameters

Being a standalone service routine is rare for a business process. Usually, a business process requires start-up parameters like documents on which they will run. To make your business process aware of the input entities to operate upon, click the Parameters tab.

Click Add Parameter and fill in the fields:

  • ID is the symbolic identifier to be associated with this parameter;
  • type any meaningful Name and Description you find appropriate;
  • select the data Type for the start-up parameter;
  • specify whether the parameter is Required to be set when running the business process;
  • Multiple: this option allows to give one parameter as many values as required;
  • provide the default value that will be used if the parameter is missing.
    Note: some data types allow to select the default value by clicking [...] button which opens the Insert Value form.

Having provided the parameter data, click OK to save and return to the parameters form:

Variables

The variables are temporary storage for data used by the business process. The variable values exist while the process is running. Once the process is completed, the variables are no longer available.

The Variables tab allows to add such "variables" to a business process:

Just like with the parameters, click Add Variable to create variables for your business process.

Access

To avoid mess and misuse, remember to give users the proper permission to access the business process. You can use the variables here:

Finally, click Save.



Courses developed by «Bitrix», Inc.