Edit flow in Workflow Studio

Release version: Yokohama

Updated January 30, 2025

4 minutes to read

Summarize

Summarized using AI

Summary of Edit flow in Workflow Studio

This guide explains how to configure and edit batch import flows in Workflow Studio within ServiceNow Automation Center. It focuses on verifying correct pagination implementation to ensure accurate data import. ServiceNow customers can choose among four batch import methods—None, Offset-based, Time-based, and Token-based—based on their data import needs.

Show full answer Show less

Batch Import Methods and Configuration

None Batch Import: Use this method if you do not require pagination. No additional configuration is needed.
Offset-based Batch Import: Enables importing data in batches using an offset (start point), total items count, and batch size (limit).
- Configure these parameters in the SourceHub get offset based pagination chunks action.
- The output field chunkschild0 provides offset values for mapping in subsequent actions.
- For actions without native limit/offset support, either insert a preparatory action to generate a query with these parameters or copy and modify the primary action to handle offset and limit inputs.
Time-based Batch Import: Imports data within a specified date range.
- Configure start and end dates in the SourceHub get date based pagination chunks action.
- Map the resulting range output to your selected action.
- Date format follows YYYY:MM:DD:HH:MM:SS and is auto-applied if supported.
- If date ranges are unsupported by the action, similar approaches as offset-based handling apply: add a preparatory action or copy and modify the primary action to handle date inputs.
Token-based Batch Import: Uses a continuation token returned by the action (e.g., nexturl, nexttoken) to paginate.
- Specify the exact token name on the Configure batch import page to enable automatic mapping in the do-while loop condition.
- If automatic mapping does not occur, manually map the token output to the condition field.
- Add a string-type Flow Variable to store the updated token value.
- Include a Set Flow Variable step after the action to update this token value accordingly.

Practical Application

By correctly configuring these batch import methods, ServiceNow customers can efficiently manage data imports from various sources with precise control over pagination. This ensures data integrity and performance optimization during bulk data processing in Workflow Studio flows.

When an action does not natively support the required pagination parameters, customers can implement additional preparatory steps or duplicate and customize actions to handle these inputs, maintaining smooth and accurate data import processes.

Edit the flow to confirm that the pagination is implemented correctly. This confirms that the data is imported correctly.

There are four batch import methods:

None
Offset
Time based
Token based

None batch import

Select the none batch import method if you do not want to use the pagination method provided in Automation Center. There is no step required here.

Offset-based batch import

Select the offset-based batch import method (pagination method) if you want to import data using a specific start point (offset) and a batch size (limit).

Offset: The starting point for importing data.
Total items: The total number of records that you want to import.
Limit: The number of records to import in each batch.

For example: If you set the offset to 20, total items to 200, and limit to 10, then the system will import data in batches of 10 records starting from record 20 and continuing until all 200 records are imported.

Steps to configure

In the SourceHub get offset based pagination chunks action, specify values for the offset, total items, and limit fields, and then select Done.
After the values are defined, the chunks_child0 field will be available in the right-hand panel (under For Each).
For the action you selected during the Select Action step, map the limit from SourceHub get offset based pagination chunks action and offset values using the chunks_child0 field output generated by the SourceHub get offset based pagination chunks action.
Handling actions that don’t support limit and offset
Map the limit and offset values in your action using the output returned by the SourceHub get offset based pagination chunks action.
If your selected action doesn’t have predefined parameters for offset-based pagination but includes a filter that can accommodate these parameters, you can do one of the following:
- Option 1: Add an action just before your selected action to handle the limit and offset. This action should generate a query that the primary action can use to fetch data.
- Option 2: Copy your primary action, modify it to include inputs for limit and offset, and process these inputs to create a query. Pass this query to the filter of your original action.
Note:
If you choose Option 2, ensure that you create a copy of the original action first. After copying, reselect the copied action in the Select Action step and regenerate the flow. For information about selecting an action, see Select an action.
Select Done and Test.
Follow steps 3 onwards in Configure batch import for data.

Time-based batch import

Select the time-based batch import method if you want to import data for a specific date range.

Steps to configure

In the SourceHub get date based pagination chunks action, specify the start date and end date, then click Done.
After you values are defined, the range field in your right panel is available.
For the action you selected during the Select Action step, map the start date and end date values using the range field output generated by the SourceHub get date based pagination chunks action.
Date format
The Connection Manager uses and returns dates in the format: YYYY:MM:DD:HH:MM:SS. If your Action supports date ranges, the format is automatically applied.
Handling actions that don’t support date ranges
If your action doesn’t automatically support date ranges but includes a filter for custom parameters, you can follow one of these approaches.
- Option 1: Add an action before your selected action to handle the start date and end date. This action should generate a query that your primary action can use to fetch data.
- Option 2: Copy your primary action and modify it to include inputs for start date and end date. Process these inputs within the action to create a query and pass it to the filter of your original action.
  Note:
  If you choose Option 2, ensure that you create a copy of the original action first. After copying, reselect the copied action in the Select Action step and regenerate the flow. For information about selecting an action, see Select an action.
Select Done and Test.
Follow steps 3 onwards in Configure batch import for data.

Token-based batch import

Select the token-based batch import method if you want to import data using a continuation token.

When you select the token-based batch import method on the Configure batch import page, you must provide a name for the token. This token represents the continuation value returned by your action (such as, next_url, next_token, or next). Ensure that the token name matches exactly as it is returned from the action, including spelling and capitalization.

Steps to configure

If the provided token name is correct, the do-while condition will automatically map it. If it remains blank, manually drag the continuation token from your action’s output into the condition field of the do-while logic.
Add a Flow Variable of type string to store the updated value of the token.
Save your changes, and click Done.
Insert a Set Flow Variable logic step after your selected action. In this step, set the value of the newly created flow variable to the continuation token returned by your action. Ensure this token matches the one mapped to the do-while condition.
Select Done and Test.
Follow steps 3 onwards in Configure batch import for data.