Output Data Tool
Use the Output Data tool 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
Save to File-Based Connections
To write the results of your workflow to a file-based connection:
From the tool configuration window, select Select Output Location to open the Output Data window.
Select a cloud data connection from Connections or select from your Existing Datasets.
Enter a File Name. Optionally, select the {x} (Add parameter) icon to add parameters to your File Name. For details, refer to Parameters section.
Select the file 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 data. You can use the default File Path or select the Customize Location checkbox to choose a different location. If you select a custom location, you can add parameters to the file path with the {x} (Add parameter) icon. For details, refer to Parameters section.
Select Next to customize your Output Options.
Use the Output Actions on Every Run dropdown to select an action to perform if a file with the same name exists at the moment of the job run.
For CSV files:
Create New
Overwrite
For Excel files:
Create New Workbook
Overwrite Workbook
Create New Sheet
Overwrite Existing Sheet
Append to Sheet
You can now write to different sheets in an Excel workbook concurrently. This means you can use 2 or more output tools to write to the same workbook on separate sheets. You don’t need the Block Until Done tool to run this. Concurrency is only supported when Overwrite Existing 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. If selected, use the Partition Using Column dropdown to select the column to use to partition sheets based on the column values.
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 output data details. You can then review your selection in the Output Data tool configuration panel and use the pencil icon to make changes if needed.
Select Run Job to your workflow and save your file to the chosen connection.
Save to SQL-Based Connections
To write the results of your workflow to a SQL-based connection:
From the tool configuration window, select Select Output Location to open the Output Data window.
Select a cloud data connection from Connections or select from your Existing Datasets.
Enter a Table Name. Optionally, select the {x} (Add parameter) icon to add parameters to your Table Name. For details, refer to Parameters section.
Next, select a schema where you want to save your table and then select Next.
Use the Output Actions on Every Run dropdown to select an action to perform if a table with the same name exists at the moment of the job run.
Create New Table: Creates a new table.
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 to save your output data details. You can then review your selection in the Output Data tool configuration panel and use the pencil icon to make changes if needed.
Select Run Job to your workflow and save your file to the chosen connection.
Download File
To download the output data to your computer, first save it in Alteryx One. 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, go to the Output tool on the canvas and select Download in the Job section of the right-side panel.
Parameters
Use Parameters to apply dynamic String or Timestamp values to your output data. You can apply parameters to the File Name, File Path, or Table Name, depending on the type of cloud connection.
String parameters 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 at the time of job execution.
To use a parameter in the File Name or Table Name...
In the File Name or Table Name field, select the {x} (Add parameter) icon to open the Parameters window.
If you previously created a parameter, select it 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, select the parameter and then select Remove.
If you need to create a new parameter, select + New. You can also select the Manage Parameters link to launch the Parameters page, where you can create new parameters and edit existing ones.
To use a parameter in the File Path...
Select the Customize Location checkbox.
Select the edit (pencil) icon next to the File Path.
Select the {x} (Add parameter) icon to open the Parameters window.
If you previously created a parameter, select it 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, select the parameter and then select Remove.
If you need to create a new parameter, select + New. 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
Use a String parameter to dynamically label your output data.
To create a string parameter, select + New from the Parameters window and then 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 isn't dynamically updated.
Select Create to create the parameter and add it to the name or path. To remove a parameter, select the parameter and select Remove.
Create Timestamp Parameter
Use a Timestamp parameter to automatically populate a formatted timestamp at the time job execution.
Note
Unlike String parameters, Timestamp parameters aren't stored on the Parameters page.
To create a Timestamp parameter, select + New from the Parameters window and then select Timestamp from the Type dropdown.
Customize the Timestamp Format as needed. The default format is yyyy-MM-dd. Select 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 1 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
Years
Next, select a Timezone for your timestamp parameter.
Last, select Create to create the parameter and insert it at the your cursor position.
Override Parameters
When you run your workflow with String parameters, the workflow uses the default value specified when you created the parameter. However, you have the option to override this value.
To override the default value for String 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.