search string side menu

Business process designer > Process designer tabs / Settings tab

Settings tab

Here you can:

  • Schedule automatic process start on a timer.
  • Add a name template.
  • Edit the instance summary page.
  • Select the activity stream that will be displayed on the task and process instance page.
  • Check API correctness.
  • Restore the previous version of the process.
  • Set the form to process debugging start.
  • Configure rules for interrupting a parent and child process.

Start settings

You can determine how the business process can be started.

  • Create button. This option adds the process to the Create button’s context menu. The user will be able to start the process by clicking its name in the list. By default, the button can be found on the main page of the system, but it can also be added to forms and pages. Read more in the Create button article.
  • Schedule. You can set a schedule to automatically start the process on specific days, weeks, or months. You can set the time considering the current business calendar. The settings are the same as for the start event.

settings_tab_01

Process logging

settings_tab_02

If you check the Show in Tasks assigned by me option, information about all started process instances will be shown in the Task section on the Assigned by me page. Click on an instance name to view its details: the process history, its context, and map. To learn more, see Business process instance.
assigned_instances

If you check the Notify about start option, a notification will pop-up whenever the process is started. A notification will also be posted to your #Activity stream. This option is enabled by default.
proc_started

Name

settings_tab_03

On this tab, as well as in the settings of the Start event, you can add a name template for the process instance. Once it’s done, you won’t need to name a process instance manually every time the process is started.

In the Template field, enter a name for the process instance. You can also add a context variable if necessary (for example, the full name of the initiator). To access the list of available variables, click the {+} icon on the right of the field.

With the f(x) icon you can add conditions and functions to the template. This will generate a more informative name

If you have created a name template in the settings of the start event, it will be displayed in this section.

Instance summary page

settings-tab-4

In this section, you can configure the layout of the instance summary page. By default, the page displays all the context variables of the process. To hide certain variables, uncheck the Show all fields option. Then drag the variables you need to see on the page from the Context column to the Name on form column.

If necessary, you can configure a custom form for the instance summary page, add or delete tabs, move fields, and change the content of the sidebar. To do this, use the form editor. Click the <Default> link in the upper left corner and select +Create Form. Read more about how to work with the form editor in Forms tab.

You can find the instance summary page in Tasks > Assigned by me.

Associated activity stream

bp_associated_stream

Select which activity stream will be shown in process tasks and on the instance summary page:

  • Associated activity stream of the business process. Messages sent to the task activity stream will be displayed on the process instance summary page.
  • Associated activity stream of an app of file. In the field provided below, select a variable of the App of File type. Then, the activity stream of the app item or file stored in the variable will be displayed on the process task and process instance pages. So, if a variable of the App type is selected and a message is sent during a process in a task, you will see it on the item page of that app. In case the variable is empty, the message will be displayed only in the process instance activity stream.

 

Example of applying associated activity stream settings

 

  1. A contract approval process associated with the Outgoing Contracts app
  2. In process settings, select the Associated activity stream of an App or File option and specify a variable of the App type that refers to the Outgoing Contracts app.
  3. If an outgoing contract is sent for approval, on its page you can view the list of process tasks and messages sent by users in these tasks.

API

settings_tab_04

This tab describes the available API and provides its description, method, and the URL.

  • Description. How the API is used.
  • Method. Type of HTTP request that lets the server know what kind of action you want to perform.
  • URL. Address of the request.
  • JSON package. The text of the request.
  • Test. On this tab, you can check the request to make sure it is error-free.

Using an API, you can integrate BRIX with your information systems. For example, after a customer places an order on your website, the order handling process can start automatically.

Version history

When you modify a process, you need to publish it so that the new version is executed when it is started. All published versions of a process are displayed on the Version history tab. Here you can find information about the author, the publishing time, and the comment the author wrote. Click the map-icon icon to view the process version map. You can also restore the process to an earlier version. To do that, select the version you need, click the floppy-disc-save-icon icon, and confirm that you want the restore the process to this version.

settings_tab_05

The configuration of the selected version will be applied to the process draft on the Flow chart tab. All saved but unpublished changes will be lost.

You can edit a restored process diagram, change the order of its activities and task forms. To apply the new version, click Save and Publish on the process designer top toolbar one more time.

Note that all process instances started before the new version is published will be run and completed without the recent changes. Read more in the Publish a business process article.

Debugging settings

By default, the process debugging start window only displays the Start Debugging and Cancel buttons. You can customize this window to enter process context variables. This way you will not need to manually fill out the fields in the start event and subsequent process tasks during debugging.

settings_tab_06

For example, into a context variable of the Files type, you can add an existing file.  

To do this:  

  1. Disable the Use the start form for debugging option. Settings for selecting context variables will appear.  
  2. Drag the desired field from the Context column to the Name on Form column.  
  3. If you want to display all process context fields on the form, enable the Show all fields option.

Process interruption

On the Interrupt Process tab, you can set rules for interrupting process instances during process modeling. To do this, enable one or both options:  

  • Abort current process when interrupting a subprocess. Stops the execution of the parent process instance if the child process instance is interrupted.
  • Abort subprocesses when interrupting the current process. Stops the child process instance when the parent process instance is interrupted.  

The configured rules apply to the parent process and all its child processes.  

If the options are disabled, instances must be interrupted manually on their pages.  

Key features of rule application:

    1. If you have multiple levels of subprocesses, you can interrupt their instances one by one in cascade, one after one. To do this, enable the options in the settings of each process.  
    2. You can configure the interruption of a specific subprocess in the Start Process block settings. In this case, the rules do not apply to the parent process and only affect this subprocess and its child processes.  
    3. If you enabled the options for a process on the Settings tab, you cannot activate them in the block settings for launching a subprocess.  
    4. If you first enabled the options in the block settings and then in the main process settings, the subprocess will prioritize the rules from the block.  

Use cases of process interruption rules

 
Let’s see different combinations of settings for automatically interrupting parent and child process instances.  

For the example, we’ll use:  

    1. Recruitment process. The main parent process, which launches a subprocess to prepare a workspace for a new employee after approving a candidate.  
    2. Prepare Workspace subprocess. A second-level parent process, which includes the launch of another subprocess.  
    3. Obtain Equipment from Warehouse subprocess. A child process launched during workspace preparation.  

Further, we’ll refer to them by number.  

  1. Sequential interruption of parent process instances.
     
    Enable the Abort current process when interrupting a subprocess option in the settings of each process. The interruption will occur as follows:  
  • Interrupt the instance of Process 2. Only the instance of Process 1 will be interrupted. The Instance of Child Process 3 will continue.  
  • Interrupt the instance of Process 3. Instances of Processes 1 and 2 will be interrupted sequentially.  
  1. Sequential interruption of subprocess instances.
     
    Enable the Abort subprocesses when interrupting the current process option in the settings of each process. The interruption will occur as follows:  
  • Interrupt the instance of Process 1. Instances of both child processes will be interrupted sequentially.  
  • Interrupt the instance of Process 2. Only the instance of Process 3 will be interrupted. The instance of main Process 1 will continue.  
  • Interrupt instance of Process 3. Instances of both parent processes will continue.  
  1. Interrupting subprocess instances without interrupting the main process instance.
     
    Enable one or both options in the Start Process block settings for launching Process 2.
     
    Interrupt instances of either Subprocess 2 or 3. The instance of Main Process 1 will continue, as the block rules do not apply to it.  
  2. Dynamic interruption of process instances.
     
    Configure rules to interrupt only specific subprocesses. To do this:  
    1. Add another block to the Main Process 1 diagram to launch the Prepare Onboarding Documents for New Employee subprocess. Assign it number 4.  
    2. In the block for launching Subprocess 2, enable the Abort current process when interrupting a subprocess option.  
    3. In the parent Process 1 settings, enable the Abort subprocesses when interrupting the current process option.  

The interruption will occur as follows:

  • Interrupt the instance of Process 1. Only the instance of Subprocess 4 will be interrupted. Instances of Processes 2 and 3 will continue, as the block settings for launching Subprocess 2 take priority.  
  • Interrupt the instance of Process 2. Instances of other processes will not be interrupted, as they are not covered by any rules.  
  • Interrupt the instance of Process 3. Only the instance of its Parent Process 2 will be interrupted. Instances of Processes 1 and 4 will continue, as the block rules do not apply to them.
  • Interrupt the instance of Process 4. Its Parent Process 1 instance will not be interrupted, as no rule is configured for this.

 

360028476691.html 360015835331.html