Process flow formatter

The process flow formatter provides a graphical summary of the stages in a process. The formatter is typically shown at the top of forms that are part of a process.

Each record on the Flow Formatter [sys_process_flow] table represents a process stage and can have a different condition applied to it. When specified conditions are fulfilled, the formatter highlights the current stage and places a check mark next to all previous stages.

These examples show a workflow in the UI15 and UI16 interfaces.

Figure 1. UI15 process flow for an incident
UI15 process flow for an incident
Figure 2. UI16 process flow for a change request
UI16 process flow for a change request

When any formatter stages are defined for a table, they appear on the form associated with that table in the order specified, assuming the formatter has been added to the form.

Activate the process flow formatter

You can activate the Process Flow Formatter plugin.

Before you begin

Role required: admin

Procedure

  1. Navigate to System Definition > Plugins.
  2. Find and click the plugin name.
  3. On the System Plugin form, review the plugin details and then click the Activate/Upgrade related link.

    If the plugin depends on other plugins, these plugins are listed along with their activation status.

    If the plugin has optional features that depend on other plugins, those plugins are listed under Some files will not be loaded because these plugins are inactive. The optional features are not installed until the listed plugins are installed (before or after the installation of the current plugin).

  4. (Optional) If available, select the Load demo data check box.

    Some plugins include demo data—Sample records that are designed to illustrate plugin features for common use cases. Loading demo data is a good practice when you first activate the plugin on a development or test instance.

    You can also load demo data after the plugin is activated by clicking the Load Demo Data Only related link on the System Plugin form.

  5. Click Activate.

Create a process flow formatter

You can create a process flow formatter stage.

Before you begin

Role required: admin

Procedure

  1. Navigate to System UI > Process Flow.
  2. Click New.
  3. Complete the form, as appropriate.
    Field Description
    Table Select a table for this process flow formatter.
    Name Enter a name to identify the formatter.
    Label Enter the name to be displayed in the form configuration slushbucket.
    Active Select the check box to ensure that the formatter stage is active. When the check box is cleared, the formatter stage does not appear in the flow display.
    Order Enter a number to indicate where in the process flow the formatter will be displayed. Formatters are arranged with the lowest number on the left and the highest number on the right.
    Condition Use the condition builder to set the conditions under which the formatter is highlighted as current. Any field available in the condition builder, such as SLA or Impact, can be used to trigger a process flow stage.
    Description Describe the process flow formatter. This description does not appear on the actual formatter.
  4. Repeat as necessary for each stage.