Activate flow reporting

Choose whether to generate execution details for all flows and actions run, just for individual flows and actions, or just when you test a flow or action. Specify the level of detail the execution details contain.

Activate reporting for an individual flow, subflow, or action

Generate execution details for an individual flow, subflow, or action every time it runs, not just during testing.

Vorbereitungen

Role required: flow_operator or admin

Warum und wann dieser Vorgang ausgeführt wird

Wichtig:
To avoid performance issues on your production instance, activate and configure reporting on the non-production instance that you use for testing.
You can activate reporting for an individual flow, subflow, or action by creating a record on the Settings [sys_flow_execution_setting] table. Each Settings record specifies the flow, subflow, or action to generate execution details for and the level of detail to use. You can create as many Settings records as you like. The system generates execution details each time the flow, subflow, or action is directly run. Actions or subflows that run from a parent flow use the Settings record of the parent flow.
Hinweis:
You can call actions and subflows directly using the action API or script API.

Prozedur

  1. Navigate to All > Process Automation > Flow Administration > Settings.
    The system displays the list of individual items for which flow reporting is activated.
  2. In the Flow/SubFlow/Action field, select the lookup icon (Lookup icon) to select the type item for which you want to activate reporting.
    The system displays a dialog box to select the type and specific instance.
  3. In the Table name field, select the matching table for the item.
    OptionDescription
    Flow Table for flows and subflows
    Action Type Table used for actions
  4. In the Document field, select the lookup icon (Lookup icon).
    The system displays a list of items of the matching type.
  5. Select the individual flow, subflow, or action for which you want to activate reporting.
  6. Select OK to close the dialog box.
  7. In the Reporting field, select the level runtime data to generate and display in flow execution details.
    Off
    The system doesn't generate flow execution details. The system only generates execution details when you run a test.
    Hinweis:
    Testing an action or flow generates execution details at the Trace level.
    Basic: Runtime states and durations only
    The system generates runtime execution details for each flow, subflow, and action run. You can see the runtime state and duration for these basic items. You can also see configuration and runtime values for flow triggers, subflow inputs, and subflow outputs.
    Full: Action configuration and runtime values (for debugging only)
    The system generates configuration and runtime execution details for each flow, subflow, and action run. You can see the runtime state, duration, input values, and output values for all items. For custom actions, you can also see the runtime state, duration, input values, and output values of its steps. You can also see the configuration values for flow triggers, subflows, actions, and steps that are part of a custom action.
    Wichtig:
    Only users with the fd_read_operations_all role can see configuration and runtime information such as record values in the flow execution details. Users without this role will only see basic details about the state and duration.
    Trace: All values (for testing and Support only)
    The system generates configuration and runtime execution details for each flow, subflow, action, and step run. You can see the runtime state, duration, input values, and output values for all items. You can also see the configuration values for flow triggers, subflows, actions, and steps.
    Wichtig:
    Only users with the fd_read_operations_all role can see configuration and runtime information such as record values in the flow execution details. Users without this role will only see basic details about the state and duration. Testing an action or flow generates execution details at the Trace level.
  8. Select Submit.

Ergebnisse

Workflow Studio always generates execution details for the individual flow, subflow, or action.

Activate reporting for all items

Generate execution details for all items that Workflow Studio runs rather than just generating execution details during testing.

Vorbereitungen

Role required: flow_designer, action_designer, admin

Warum und wann dieser Vorgang ausgeführt wird

Wichtig:
To avoid performance issues on your production instance, activate and configure reporting on the non-production instance that you use for testing.

By default, the system only generates execution details when you run a test. You can activate reporting for all items that Workflow Studio runs by setting the com.snc.process_flow.reporting.level system property.

Prozedur

  1. Navigate to All > Process Automation > Flow Administration > Properties.
  2. Set the property Level of reporting data generated by the flow engine.
    Off
    The system doesn't generate flow execution details. The system only generates execution details when you run a test.
    Hinweis:
    Testing an action or flow generates execution details at the Trace level.
    Basic: Runtime states and durations only
    The system generates runtime execution details for each flow, subflow, and action run. You can see the runtime state and duration for these basic items. You can also see configuration and runtime values for flow triggers, subflow inputs, and subflow outputs.
    Full: Action configuration and runtime values (for debugging only)
    The system generates configuration and runtime execution details for each flow, subflow, and action run. You can see the runtime state, duration, input values, and output values for all items. For custom actions, you can also see the runtime state, duration, input values, and output values of its steps. You can also see the configuration values for flow triggers, subflows, actions, and steps that are part of a custom action.
    Wichtig:
    Only users with the fd_read_operations_all role can see configuration and runtime information such as record values in the flow execution details. Users without this role will only see basic details about the state and duration.
    Trace: All values (for testing and Support only)
    The system generates configuration and runtime execution details for each flow, subflow, action, and step run. You can see the runtime state, duration, input values, and output values for all items. You can also see the configuration values for flow triggers, subflows, actions, and steps.
    Wichtig:
    Only users with the fd_read_operations_all role can see configuration and runtime information such as record values in the flow execution details. Users without this role will only see basic details about the state and duration. Testing an action or flow generates execution details at the Trace level.
    Warnung:
    Avoid enabling the Full reporting option on a production instance. Full reporting generates execution details for every flow and action run on the instance. Creating and storing these execution details consumes system memory and can lower system performance. Instead, only enable reporting for specific flows and actions or test them on a non-production instance.
  3. Select Save.

Ergebnisse

Workflow Studio generates execution details for all items you specified in the system property.