Dynamic outputs
Summarize
Summary of Dynamic Outputs
Dynamic outputs enable ServiceNow users to access action and subflow outputs as dynamically generated data pills during flow design. This feature is part of the Flow Designer and requires the Integration Hub plugin to utilize. Dynamic outputs facilitate the retrieval of complex object schema values, which can be utilized in workflows by creating data gathering actions.
Show less
Key Features
- Data Gathering Actions: These actions collect data from third-party systems, primarily using REST calls. They must include a script step that produces a JSON output variable.
- Dynamic Outputs: Created by linking a parent action to a child data gathering action, dynamic outputs display retrieved data as data pills within the Flow Designer.
- Timeout Management: Dynamic outputs can gather data for up to 300 seconds, which can be adjusted through system properties if necessary.
- Error Handling: Users should be aware of potential scripting errors in data gathering actions, which could prevent the proper output of JSON variables.
Key Outcomes
By effectively using dynamic outputs, ServiceNow customers can streamline integrations with external systems, introspect data during flow design, and dynamically build complex objects without hard-coding them. This enhances the flexibility and efficiency of workflows, allowing for better data handling and user experience in interactive flows.
Access action and subflow outputs as dynamically generated data pills during flow design. You can also build data gathering actions to generate complex objects from ServiceNow AI Platform and Integration Hub outputs.
During the flow design, a dynamic output retrieves the complex object's schema values and displays them as data pills in the data panel.
- An action designer creates a data gathering action.
- An action designer creates a parent action with a dynamic output that points to the child data gathering action.
- A flow designer adds the parent action to a flow.
Data gathering actions
- The action has a script step that contains an output variable of type JSON.
- The action has an output named output of type JSON whose value is derived from the script step's JSON output variable.Note:The action can have multiple outputs but can only have one of type JSON.
- The script step formats the JSON output to have a property named
data. - The JSON output should not return more than 5000 choice options, field template values, or array element items when the data is intended for a dynamic choice or a dynamic template input.Note:Dynamic choice and dynamic template inputs can only display up to 5000 choice options or 5000 template values from the JSON output.
- The action waits for up to 300 seconds (5 minutes) to gather data before it times out. Note:To change the timeout period for all actions, modify the value of the sn_flow_designer.sync_action_execution_timeout_in_seconds system property.
Dynamic object
A dynamic object is either a complex object or an array of complex objects. Action designers build the object structure dynamically with a data gathering action rather than hard-coding it. For more information on building a dynamic object, see Create a data gathering action for a dynamic object.
General guidelines
- Use dynamic outputs for third-party integrations
- Use dynamic outputs to introspect and fetch data from external systems during the flow design. For example, you can specify service endpoints or call actions that interact with specific endpoint APIs. For more information on setting up third-party integrations with Workflow Studio, see IntegrationHub.
- Note the time that is required to retrieve large amounts of data
- By default, dynamic outputs have up to 300 seconds to gather data before the system stops them. If your data gathering action needs more time to gather data, set the sn_flow_designer.sync_action_execution_timeout_in_seconds system property to a greater value. Avoid long timeout values for interactive flows where an end user is expecting to enter or select a value.
- Be aware of scripting errors
- Because all data gathering actions use a script step, potential errors could occur from scripting. Review any scripts that are used to output JSON variables because script errors may prevent the outputs from receiving the
JSON values that they need. When a dynamic output scripting error occurs, the following warning message may appear.
Figure 1. Message that is displayed for scripting error