next

Edit

View all Business Processes

To access the list of Business Processes (BP), log in to Control Tower and go to Business Processes > View All.

The list provides the following capabilities:

  • Gives a quick overview of statuses, details, progress, and possible issues for all BP instances.
  • Allows you to access and manage BP instances: change their state (start, pause, resume, or stop), create more instances, and delete them.
  • Enables you to create or import BPs and perform other actions with them.

The Business Processes page comprises three major areas shown and described below:

  1. Business Processes list: all instances pertaining to specific Business Processes are grouped under respective BP definitions. This allows a compact hierarchical view and quick status identification.
  2. Actions: include major operations with a BP, such as Create New and Import. For detailed instructions, refer to the Create Business Process topic.
  3. Filters: you can filter BPs using predefined and custom criteria.

Business Process list

The BP list displays all processes available in Control Tower at a given moment. A BP definition is represented as a box indicating the following:

  1. BP name and date. The BP date is when the latest BP instance was created.

  2. Status of all BP instances designated with the icons below:

    • Draft
    • Processing
    • Completed
    • With errors
    • Paused
    • With messages

    If there are no instances with a specific status, respective icons are hidden.

  3. The Open process definition in new tab button opens a specific BP definition in a new tab. The function is helpful when you are working with one BP and want to view only its instances.

If a BP contains a Manual Task you can automate with a Cognitive Bot Task ML model, its name is indicated with the C icon:

Business Process instance

Once you expand a BP definition, you can see the entire list of BP instances pertaining to it.

Instances allow the following actions, as indicated by the digits in the figure above:

  1. Select a tab to view instances with the respective status:

    • All
    • Running
    • Completed
    • Paused
    • Drafts
    • Errors
    • Messages

  2. See the Definition UUID where the BP is executed. This information is essential when working with WorkFusion REST API.

    important

    You can also get the Definition UUID by clicking the Open process definition in new tab button as described in the Business Process list section.

  3. Select the checkbox to perform the following bulk actions with all or multiple instances:

    • Start
    • Stop
    • Pause
    • Delete
    • Repair

    Available actions depend on the instance status. You can remove the selection from an instance or instances to exclude them from the bulk action.

  4. To view all steps of the BP instance, click the arrow on the left side of the box.

  5. See the instance name, as well as who and when started its execution. To start editing the selected instance (change process steps, scheme, input data, options, and so on), click its name.

    If the instance name contains Scheduler, click the Schedule icon to go to the schedule setup.

  6. View and add tags to distinguish the instance among the BP instances with identical names. To enter the editing mode and add a tag, click the Edit button > Add tag. To remove an existing tag, click the cross button while in the editing mode.

  7. Click to arrange Started or Completed instances in the ascending or descending order.

  8. To view the general information on a BP instance, click the arrow button next to its name. To hide the information, click the same arrow again.

    Instance details can contain the following information:

    • Started: date of the first execution.
    • Completed: date when the execution was completed.
    • Input records: number of input records.
    • Workers: number of workers who submitted answers to a particular Manual Task.

  9. To view the events logged during the execution, click the View event log button. If some errors occur, the button has a red background.

    To download a log file, click Export to Excel.

    warning

    When a user logs into a Control Tower instance using a time zone different from the Greenwich Mean Time (GMT), the Business Process event log and any exported event log sheets are in GMT, irrespective of the user time zone.

  10. The progress bar displays the completion status of the instance execution.

  11. To open the drop-down menu listing the actions you can perform, click the Actions button.

    Available actions depend on the BP instance status (Draft, Processing, Completed, With errors):

    • Copy: create a copy of a BP as an instance linked to the source BP. If the source BP structure is modified, all referenced BPs inherit the changes respectively. You can run each copy separately without affecting the others.

      note

      You can copy a BP if you need to rerun a completed BP.

      The Copy function has the following options:

      • Include the input data: the input data from the source BP is included in the new one. Alternatively, you can provide new input data for the copied BP.
      • Create an independent process definition: a new BP is created without a link to the source BP.

    • Start

    • Pause: pause the BP execution with the possibility of resuming it later (for running BPs only).

      • In the local mode, the Pause operation works in the same way as Stop: when a BP is paused, the subsequent steps are not executed. Then, you can resume it.
      • In the cluster mode, the Pause action continues to execute stateless steps until a non-stateful step.

    • Resume: resume the execution, if the BP is paused (for paused BPs only).

    • Stop: complete the execution of the BP at the current stage (for running BPs only).

    • Edit

    • Run

    • View data: view the input data provided in the BP.

    • Repair: to fix the instance issues unrelated to the BP configuration. For details, refer to View Business Process logs.

    • Download original data: download the input data as a CSV file.

    • Delete: remove the BP.

  12. To download the BP instance execution results, click the Generate snapshot button. The Snapshot download will start soon message appears, and a CSV or XLSX file containing the execution results is downloaded.

Business Process instance steps

To expand an instance and view its steps, click the arrow button to the left of the instance name:

  1. Steps: a hierarchical list of BP steps (tasks) and sub-processes. The list contains only the steps with at least one active record, meaning the BP execution reached the steps.

  2. Step details. To view the details of a step, click the arrow button for the respective step.

    Step details can contain the following information:

    • Started: date of the first execution of the current step.
    • Completed: date when the current step was completed.
    • Input records: number of records that reached the current step.
    • Workers: number of workers who submitted answers to the particular Manual Task.
    • Bot Configuration: link to the Bot configuration.

  3. Logs: to view the events logged during the step execution, click the View event log button. To download a log file, click Export to Excel.

  4. Status: the progress bar displays the completion status of the step execution.

  5. Snapshots: to download the step execution results, click the Generate snapshot button. The Snapshot download will start soon message appears, and a CSV or XLSX file is downloaded.

  6. Actions: to open the drop-down menu listing the actions available for a step, click the Actions button. Available actions depend on the step status (Completed, Errors).

    • View data: view the input data provided in the step.
    • Repair: to fix the step issues unrelated to the BP configuration. For details, refer to View Business Process logs.

Filters

Using the filters on the top panel of the BP list page, you can select BPs to be displayed in the list. The number of BPs is displayed according to filtering criteria.

The filters are aimed to facilitate your work with BPs as you have a rich set of criteria to define what instances are included or excluded from the list.

Filter types

There are two filter types:

  • Predefined filters, where you can use a built-in set of criteria to select the BPs to be displayed. In the Filter drop-down menu, select the filtering criterion:

  • Advanced filters, where you can set custom filtering criteria, such as state or time span, picking them from a list of available options, and so on. Select the Advanced checkbox:

    Click Add Parameter to include and define an option for the filter. You can choose as many options as needed to create the required filter. When the setup is over, click Apply filter.

    You can set up the following filters:

    • Text filter for Tags, Author, Title, and UUID. In the text filter, you can define a match, such as contains, does not contain, equals to, or not equals to.
    • Date filter to sort by dates when the instance is created, started, ended, or due. In the filter, you can define a match, such as equals to, not equals to, greater than, less than, greater than or equals to, less than or equals to, and period.
    • Status, where you can select the following states of BP instances: Completed, Active, Running, Answered, Paused, Errors, Draft, Has New Messages. The filter criterion is true.
    • Filter for environment to set the list to display the production or development environment instances.

With the Match all parameters option, you can define if the filtering results should match all or specific criteria.

Save filter

You can save the filter for future use. Click the button next to Apply filter and, in the drop-down list, select Save Filter.

Type in the name of your filter and choose if the filter should be private or available for other users.

Clear or refine filter

If a filter is applied, the following box is displayed in the filter area:

To remove or edit the filter, click Clear filter or Refine filter, respectively.

← Basic concepts for Business Process implementationCreate Business Process →