Views: 11220 (Data available since 06.02.2017)
Last Modified: 12.04.2019
The business process template parameters form includes the following tabs: General, Parameters, Variables, Constants and Access.
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 an information block element 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 are used to directly specify values that will be used during this business process. Such parameter values are set directly before launching a business process in special fields.
To make your business process aware of the input entities to operate upon, click the Add parameter link in the Parameters tab and fill out the following fields:
- ID is the symbolic identifier to be associated with this parameter;
- Name - parameter name;
- Description - type any meaningful you find appropriate;
- Type - select
- select the data Type for the start-up parameter;
- Required -
- 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;
- Default value - is specified depending on the selected type of data.
some data types allow to select the default value by clicking [...]
button which opens the Insert Value
Having provided the parameter data, click OK to save and return to the parameters form:
The method, described above, is used to create all parameters, required to start a business process. Such links as Edit and Delete, located in the column Actions allow to modify each parameter correspondingly.
The links Up/Down are used to organize a large list of parameters. The sorting order for parameters does not affect the business process itself.
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.
But, when a specific variable must be saved (for example, a file), use the Modify Element action. It allows saving the variable into a additional pre-created document field of corresponding type (a file, for example).
Just like with the parameters, click Add Variable to create variables for your business process. The Variables tab allows to add such "variables" to a business process:
Constants are required to store data which values must not change during this business process. Such values must be configured before launching a business process.
Constants are added by the And Constant link in the corresponding tab.
The Constant value field indicates the value during this business process.
After the necessary fields are filled out, click OK to save the created constant. When all constants are added, click Save.
To avoid mess and misuse, remember to give users the proper permission to access the business process. You can use the variables in the next Access tab.
Note: Please, be advised that Access tab is available only for Bitrix24 Self-Hosted editions. However, for Bitrix24 Cloud editions, access permissions can be set up in general settings for elements and documents (information blocks/lists, etc.) that are used within a business process.
Finally, when your configuration is complete, don't forget to click Save.