This group contains all the remaining commands.
Activity block
Activity block is intended to group a set of actions into one block that can be 'folded' to save space. It permits you to significantly save labor resources by using standard activity blocks when creating a business process template. Once created and set up, the activity block can be saved in the group My Actions and used repeatedly.
Create QR code
This action creates personalized QR codes for any marketing purpose.
Create new workgroup
This action creates a new workgroup.
Action parameters
Group name - specify the name of the workgroup.
Group owner - specify the user who will own the workgroup. Note that there can be only one owner.
Group members - specify the users who will be the workgroup members.
Departments - you can add a whole department to the workgroup.
Target site - specify the site where a workgroup will be created. You can also create an extranet workgroup this way.
Generate code
This action generates a code of a specific length and format.
The generated code can be found in the Additional results section of the Insert Value form.
Action Parameters
String length – specify the number of symbols in the code.
Alphabet – specify the type of symbols in the code.
Log entry
This action permits you to add arbitrary entries to the report and log, accordingly.
Entries to the report can be conveniently used, for example, during business process debugging to save the data of a necessary stage to the report.
Action Parameters
Load log for use by business process – permits you to obtain the contents of the entire report as a part of a business process for further actions (e.g., sending by email) by using the Additional results section of the Insert Value form. Otherwise, the report data will be impossible to obtain as a part of a business process and will be available only in the log.
The Load log for use by business process option can be useful at the stage of the completion of a business process in order to generate a final report without making excessive queries to the base.
Action Results
The results of this action can be obtained using the form Insert value - Additional results where they will be available immediately after adding the action to the template.
The following is available:
- Log;
A specific variable will be created for each entry to the log in the section Additional results. If the option Load log for use by business process is enabled, it will help you to obtain the log which was already generated at the stage of this action. The log of each subsequent action will include the log of the previous actions. If the option was not marked, the variable will be empty.
Outbound webhook
This action adds an outbound webhook. It does not return any data but sends information to other systems. In Bitrix24 Self-Hosted version the action is available only if the REST module is installed and active.
Action parameters
Handler – the URL address you need to use to send data from your Bitrix24.
PHP Code
This action permits you to execute an arbitrary PHP code.
-
Only a user with administrator’s rights can set the PHP code.
-
The code must be indicated with no opening or closing tags (
<?,?>). -
It is not recommended to use statements like
{=...}in the body of the code. They may contain the parameters that any account user is allowed to edit. -
For example, instead of
{=Variable:COMPANY_NAME}it is better to use$root->GetVariable('COMPANY_NAME').
Examples of application
Setting a value for the variable
$this->SetVariable('Variable1', 12345);
where:
Variable1 – identifier of the variable to which a value will be assigned (12345 number).
Entering several users to the User type variable
$this->SetVariable("user", array("user_1", "user_2"));
where:
array("user_1", "user_2") – an array of users in the format user_[user_identifier_in_the_system].
The use of PHP code and values of fields/variables to obtain the name of the infoblock element
$arFilter = Array("IBLOCK_ID" => {=Variable:Variable1_printable}, "ID" => {=Document:PROPERTY_1});
$dc = CIBlockElement::GetList(array(), $arFilter, array("NAME"));
$br = $dc->Fetch();
$Pbrr = $br["NAME"];
$this -> SetVariable('Variable2', $Pbrr);
where:
{=Variable:Variable1_printable} – value of the variable containing the infoblock identifier;
{=Document:PROPERTY_1} – field of the document containing the infoblock element identifier;
Variable2 – identifier of the variable which will be assigned the calculated name of the infoblock element.
Pause Execution
This action permits you to postpone the execution of the next action for a specified time.
Action Parameters
Mode:
-
Period – indicates the period after which the business process will be resumed;
-
Time – indicates the specific time for resuming the business process.
- Save pause information to workflow log - with this option enabled, pause information will be written to the business process status.
-
A pause cannot be interrupted in any way for a business process that is already running.
-
Pauses depend on users' visits to the account. If you have an account created only for automating activities and there are no users constantly visiting it, then business processes (BP) and automation rules may be paused late. To avoid this error, you need to organize periodic user activity on the account. For example a daily visit of one user to the account.
Select Employee
This action permits you to automatically select an employee for their further use in the process.
Action Parameters
Type:
-
any – random selection of a regular employee;
-
supervisor – selection of a supervisor for the indicated employee. In this case, you will need to additionally complete From users and Supervisor Level parameters.
From users – indicates users or groups from which one employee will be selected.
For user – indicates the user for whom a supervisor will be selected.
Supervisor Level (the more the higher) – selects the level of a supervisor for the indicated user.
Backup users – indicates the users who will be selected in case it is impossible to select from the main users indicated above. For example, if the group indicated in the field From users contains no employees, someone from among reserved users will be selected.
Escalate to higher level if absent – permits you to automatically omit absent employees, for example, if they are on vacation.
Skip checked out employees – permits you to automatically omit clocked-out employees.
If it is impossible to select the main supervisor, for example, if they are on vacation, and the Escalate to higher level if absent option is equal to Yes, the action will automatically continue selecting a supervisor but of a higher level. If the top-level supervisor is also unavailable, the selection will be effected from among the employees indicated in the Backup users parameter.
If the option Escalate to higher level if absent is equal to No, the action will terminate and, notwithstanding the absence, a supervisor of the relevant level will be selected.
If all supervisors are unavailable or the employee has no supervisor, the action will return an empty value.
Set Permission
This action permits establishing the rights of access to the document.
Action Parameters
"..." permission is granted to – set up the permissions to the element for the indicated users/user groups.
Overwrite existing permissions – permits you to not add rights but replace them. In this case, we work only with the permissions that are set inside the business process.
Set Variables
This action permits changing the values of the variables set in template settings.
Action Parameters
Drop-down lists are used to select variables and set the necessary values for them.
Terminate business process
This action permits you to terminate the execution of a business process.
Action Parameters
Status Text – specify the text that will be written to the business process status.
Delete workflow data – use this parameter to remove all the data related to the business process after its completion.