Output Data Tool
Use Output Data to write results of a workflow to supported file types or data sources.
Select the Output Data tool in the palette, and drag it onto the workflow canvas.
Tool Components
 |
Figure: Output Data tool with anchor.
The Output Data tool has 1 anchor.
Input anchor: Connect the input anchor to your workflow to write your workflow results to a data source or a supported file type.
Configure the Tool
Download File
To download the output file to your computer, first save it in Cloud. The quickest option is to save the file to a default location in Base Storage. You can also customize the location within the Base Storage or choose another connector.
Then, after you run the workflow, navigate to the Output tool on the canvas and select Download in the Job section of the right-side panel.
To configure your file for download...
Choose Select Output Location or choose a location in the Connections section.
Enter a name for your output file in File Name. Optionally, select the {x} (Add parameter) icon to add parameters to your file name. For details, refer to Parameters below.
Select your Format:
CSV: Comma-Separated Values (.csv)
XLS: Microsoft Excel 1997–2003 (.xls)
XLSX: Microsoft Excel (.xlsx)
Next, choose where you want to save your output file. You can use the default File Path or select Customize Location to choose a different location.
Select the Next button to customize your Output Options.
Use the Output Actions on Every Run to select an action to perform if a file with the same name exists at the moment of the job run. If a file with the same name doesn't exist, a new file is created. Choose from:
Create New
Overwrite
For Excel:
Create New Workbook
Overwrite New Workbook
Create New Sheet
Overwrite New Sheet
Append to Sheet
You can now write to different sheets in an Excel workbook concurrently. This means you can use two or more output tools to write to the same workbook on separate sheets. You don’t need the Block until tool to run this. Concurrency is only supported when Overwrite New Sheet is selected.
If you selected a CSV file format, select a Column Delimiter. Your options are Comma, Tab, Pipe, and Semicolon.
Choose additional options for your output:
Include Quotes (CSV file format only)
Sheet Name (XLS and XLSX formats only)
Partition Output (XLS and XLSX formats only): Choose if you want to publish your file as a single file or a file with multiple sheets.
Keep Partition Column in Output (XLS and XLSX formats only): Uncheck to exclude the column used for partitioning from the final output. For example, if dividing by quarter, you can exclude the "Quarter" column from the output.
Include Column Names as First Row
Select Confirm to save your download details. You can then review your selection in the Output Data tool configuration panel and use the pencil icon to make changes if needed.
Save and run your workflow. The output file appears in the Jobs section of the tool configuration window. If you use Parameters and need to override default values, refer to Override Parameters below.
Select the output file, then select Download Output File.
Parameters
You can use Parameters to apply dynamic values to certain parts of your file name.
Some parameter types (for example, String) have a default value that can be overwritten for each job execution, in a schedule or Plan.
Timestamp parameters are automatically populated with a formatted timestamp of the job execution.
To use a parameter in your File Name...
In the File Name field, select the {x} (Add parameter) icon to open the Parameters window.
If you previously created parameters that you want to use in your File Name, select them from the Workspace Parameters section. Note that the parameters are inserted at your cursor location in the File Name field. To remove a parameter from your file name, click the parameter and select Remove.
If you need to create a new parameter to use in this file, select the + New button. You can also select the Manage Parameters link to launch the Parameters page, where you can create new parameters and edit existing ones.
Create String Parameter
To create a string parameter, select String from the Type dropdown.
Enter a parameter Name. This is what shows in the file name field if you use the parameter.
Enter a Description. This should be something clear that will help you and other users in the future.
Enter a Default value for the parameter. This value is used if the parameter is not dynamically updated.
Select Create to create the parameter and add it to the file name. To remove a parameter from your file name, click the parameter and select Remove.
Create Timestamp Parameter
You can create a Timestamp parameter to automatically populate the File Name with a formatted timestamp of the job execution.
Important
Unlike other parameters you create, Timestamp parameters are not stored in your Workspace.
To create a Timestamp parameter, select Timestamp from the Type dropdown.
Customize the Timestamp Format as needed. The default format is yyyy-MM-dd. Use the + button to view your customization options. The Format Preview displays today's date using your selected format.
Next, set the Timestamp Value. Choose from...
Exact at Job Start: Outputs the exact timestamp value when the job starts.
Relative to Job Start: Output the timestamp relative to the Job Start time. For example, you might want a timestamp one hour after the Job Start time.
Occurrence: Choose to output a timestamp that is either After or Before the Job Start time.
Value: Choose a numerical value for your relative timestamp.
Unit: Choose a unit for your relative timestamp. Your options include Minutes, Hours, Days, Weeks, Months, Quarters, and Years.
Next, select a Timezone for your timestamp parameter.
Last, select Create to create the parameter and insert it into your file name at the cursor.
Override Parameters
When you run your workflow with parameters, the workflow uses the default value specified when the parameter was created. However, you have the option to override this value.
To override the default value for parameters...
Select the dropdown icon that's part of the Run Job button.
Select Parameters to open the Override Parameters window.
Enter override values into the Value Override column for all parameters where you don't want to use the default.
Select Save and Run Job to run your workflow with the updated parameter values.
Save to Connections
To write the results of your workflow to a data source:
Select a connection from Connections or choose Select Output Location and select your connection from the Output Data window.
If you intend to create a new table, enter a Table Name.
If you intend to override an existing table with the one from your workflow, choose a schema to save your table to.
Your Table Path shows where your table will be written.
Select Next to configure your Output Options.
Use Output Actions on Every Run to select an action to perform if a table with the same name exists at the moment of the job run. If a table with the same name doesn't exist, a new table is created.
Append to a Table: Data is appended at the end of the existing table.
Truncate Existing Table: The existing table data is deleted and replaced with new data.
Drop Existing Table: The existing table is dropped and replaced by the new table.
Merge with Existing Table: Output data is merged with the existing table.
Select Confirm.
Save and run your workflow. The output file appears in the Jobs section of the tool configuration window.
Your table is saved to your chosen connection.