An output is defined as a set of files or tables, formats, and locations where results are written after a job run on the recipe has completed. To run a job from a flow, you must create an output object that defines where results are delivered after a job is successfully executed. |
Every flow requires an output in order to publish results. An output object is composed of one or more publishing actions. A publishing action defines the output type, format, location, and other settings where results from a recipe are delivered.
You can create publishing actions in multiple formats and publish those to different databases and file storage formats. The following are the output types:
You can use either of the following methods to create an output object and its related publishing action.
From Flow View:
In Flow View, an output object extends from a recipe, indicating the results of the recipe are delivered to the output object.
Tip: For scheduled runs of your flow, you must specify Scheduled Settings to automatically generate the output when the flow is executed by a schedule. For more information on scheduling, see Overview of Automator. |
From Run Job page:
For an existing output, you can create new destinations from the Run Job page.
You can create a file-based output by performing the following steps.
For more information on creating an output from Flow View and Run Job page, see above sections.
Steps:
In the Publishing action page, select the connection where you wish to write file from the left panel. In the following example, the HDFS
connection has been selected:
Publishing action page for file output |
To create output parameters, click the Parameterize destination link. See "Create an Output with Parameters" below.
From the Data Storage Format drop-down list, select the output format for the file.
The publishing actions vary based on the options selected. Select the required publishing actions below the drop-down list. For more information, see File Settings.
Update the Delimiter field, if required.
Tip: You can define SQL scripts that are executed before or after generation of your output objects. For more information, see Create Output SQL Scripts. |
You can create output objects for publishing to tables by performing the following steps:
For more information on creating an output from Flow View and Run Job page, see above sections.
Steps:
In the Publishing action page, select the connection to the database where you wish to store the table from the left panel. In the following example, the postgres
connection is selected:
Publishing action for a table output |
Search the table. You can select an existing table from the list or click Create a new table in the right panel.
To create output parameters, click the Parameterize destination link. See "Create an Output with Parameters" below.
Select the required publishing actions below the drop-down list. For more information, see Relational Table Settings.
Tip: You can define SQL scripts that are executed before or after generation of your output objects. For more information, see Create Output SQL Scripts. |
For any outputs, you can parameterize elements of the output path. You can parameterize your path with the following options.
Tip: You can define multiple parameters per output. |
Variables: Inserts a value for the variable.
This variable has a default value that you assign.
Whenever you execute a job through the Run Job page, you can pass in the default value or an override value for the variable.
For more information on parameters, see Overview of Parameterization.
For file- or table-based publishing actions, you can replace the bucket name (if applicable) or elements of the output path with variable values. When you define the output, you replace an element of the output path with the variable name. At runtime, the variable name is replaced by the appropriate value.
Tip: You can use environment parameters to parameterize bucket names across your environment. For more information, see Environment Parameters Page. |
On the listed output path, highlight the part that you wish to parameterize. You can select part of the path or bucket name.
Then, select Add Variable.
Define parameterized destination |
Name: Enter a display name for the variable.
Tip: Type |
NOTE: If multiple variables within a flow (or its dependent flows) have the same name then they are treated as the same variable. |
The created parameter is displayed in the right context menu of the publishing action page.
Tip: If you created a variable parameter, you can apply override values to the variable when you are running a job. For example, you can modify a variable called |
Timestamp parameters can be helpful when you want to create outputs based on date and time format, time zone, or exact and relative start time. For file- or table-based publishing actions, you can create outputs based on the specific region or time zone for which the data is generated. When you define the output, you can replace an element of the output path with the timestamp parameters.
Steps:
On the listed output path, highlight the part that you wish to parameterize. Then, select Add Timestamp Parameter.
In the Timestamp Parameter dialog, enter the following details:
YYYY-MM-DD_hh_mm
.America/Los Angeles
or Asia/Calcutta
.For more information on the available time zones, see Supported Time Zone Values.
Click Save.
The created parameter is displayed in the right context menu of the publishing action page.
From Flow View page:
From Run Job page:
In the Run Job page, hover over the publishing action to modify. Click Edit.
You can delete the output object from the Flow View and from Run Job page:
Flow View page:
Run Job page:
In the Run Job page, you can delete publishing actions. From the context menu for a publishing action, select Delete.