A run is a single execution of your data flow which can be initiated manually, or automatically by using a schedule. A run state contains the run properties, node run information and data which is created when a data flow is executed.
There are three different types of runs:
- Ad-hoc runs: When you open a data flow and manually run the nodes.
- Scheduled runs: Produced by scheduled data flows.
- Execute Data Flow runs: Produced by the Execute Data Flow node.
You can save runs in the directory. You can compare different runs of the same data flow, for example using different sets of run properties or different runs for different data. You can share runs with other users to work collaboratively by saving run states and temporary execution data in a shared folder in the directory.
View run states
When a run state is selected in the Directory, the details panel lists the corresponding data flow, run properties and the location of temporary execution files (Data Location). The Data Location can be customized per run state, or if no location is specified then the default system setting is used.
You can open saved run states from the Directory, where they are opened as read only. Alternatively, you can access run states from within an opened data flow, where the list of run states depends on what you have access to. To see the run state information from within a data flow, click the Run tab on the Properties panel:
- Run State: Lists the default run state and saved run states. The Default run state is listed on top, it is unique and available for each user for each data flow. Saved run states are the states that you have saved. You can switch between these states, if needed.
- Run Date: The start date and time of the most recent manual run of a node or set of nodes.
- Status: The status of the run state changes when you run the data flow. There are four different states:
- Spinner: The run is actively executing.
- Green tick: A successfully completed run.
- Red cross: An error with the run.
- Circle: The run state has not yet been run.
- View in New Tab: The run state is opened in read-only mode in a new browser tab, allowing you to easily compare different runs of your data flow.
- Show Details: Gives information about the run details and its properties.
- Copy and Clear: Allows you to save the default run state permanently in a chosen location. The Default run state then gets re-created as a new clean run state. This option is only available for the Default run state. You can also specify a Data Location for the temporary execution data. Choosing a data location that is in a shared folder allows you to collaborate with other users working on the same data flow so that they can also see the run data without needing to re-run the nodes. If you do not specify a Data Location, the default system setting is used. The default system setting is configured from the Settings collection in the Directory.
- Create: Allows you to create a new run state using the same run property values as the current run state, saving it with a new name and in a location of your choice. You can also specify a Data Location for the temporary execution data. Choosing a data location that is in a shared folder allows you to collaborate with other users working on the same data flow so that they can also see the run data without needing to re-run the nodes. If you do not specify a Data Location, the default system setting is used. The default system setting is configured from the Settings collection in the Directory.
- Edit: Allows you to edit the run state.
- Rename: You will be prompted to enter a new name for the folder. This name must be unique within the containing folder. Type a new name for the folder and click Rename.
- Delete - Allows you to delete the selected run state.
- Delete Run Data: Clears all visible run data from the selected data flows, including node statuses and output pin data, and also removes any temporary files associated with the run.
- Edit Permissions - An administrator can control the permission level of folders and documents in the Directory, granting access to specific users, groups of users or users who are assigned to a specific user role, while restricting access to others. For more information see, Managing permissions.
Save run states
You can copy and save the run properties of a data flow as a new run state to share with other users.
- Open the data flow for which you want to copy and save the run properties, then click the Run tab on the Properties panel.
- Click the context menu to the right of the run state that you want to use and click Create. Note that this option will not be available if you are working in a data flow that has not yet been saved.
The Create Run State dialog appears. Choose a name, location and temporary data location for this copy of the current set of run properties of the data flow. Choosing a data location that is in a shared folder allows you to collaborate with other users working on the same data flow so that they can also see the run data without needing to re-run the nodes.
- Click Create.
The new run state is added to the Run States table along with any other run states for the data flow.