Output Variables
Output variables capture useful information at the end of a step's execution. The captured values are then available to all subsequent steps in the procedure.
Configuring Output Variables
- Open a Migrate Records step (e.g., the Incidents step)
- Navigate to the Output tab
- Click to add a new output variable
Example: Capturing an ID Map
A common use case is capturing a dictionary that maps source record IDs to their corresponding target record IDs:
- Add a new output variable named
incident_id_map - Configure it to store a dictionary linking source record IDs to target record IDs
This variable can then be referenced in subsequent steps — for example, to filter child records or to look up the target ID for a parent record.
How Output Variables Work
- Output variables are populated after the step completes execution
- The variable is added to (or updated in) the procedure's variable scope
- All subsequent steps can reference the output variable by name
- Output variables can store various data types: strings, numbers, lists, dictionaries, etc.
Common Patterns
The available output types differ between step types:
Migrate Records
| Pattern | Output Type | Description |
|---|---|---|
| ID Map | Dictionary of source-target record IDs | Source primary keys mapped to target primary keys, for use in child record migrations |
| Captured Target IDs | List of target record IDs | The primary-key values created or updated by the step |
| Captured Source IDs | List of source record IDs | Source primary-key values of every successfully migrated record |
| Captured Field Values | List of values from mapped target field | All values written to a single target field |
Extract Records
| Pattern | Output Type | Description |
|---|---|---|
| Record List | List of full records | Every extracted record, for iteration or formula access |
| ID List | List of record IDs | Just the primary-key values |
| Record Count | Count of records | Integer count for conditional logic in later steps |
| Existence Flag | Whether any records exist | Boolean gate on downstream steps |
| Single-Record Lookup | First record / First value from a field | Scalar lookup patterns where the query is expected to return one record |
| In-Memory Lookup | Dictionary of key field → value field | Reference table built from two fields of the extracted records |
For the full per-step catalogue, see the Outputs help block in-product or the step type articles. Each output row in the UI carries a Type selector that drives the shape of the captured value.
Next Steps
- Executing a Procedure — run your procedure and review results
- Table Correlations — track ID relationships across migration steps
- Output and Correlations — detailed guide to output configuration on Migrate Records
- Step Type: Extract Records — output catalogue for the Extract Records step
Comments
0 comments
Please sign in to leave a comment.