All Collections
Steps
Destination Steps
Run File Destination Step
Run File Destination Step

The Run File Destination step is used to deliver an output file once a Run is executed.

Praise Magidi avatar
Written by Praise Magidi
Updated over a week ago

Illustrated below is an example of a flow where the Run File Destination step is used. The Record Generator is used to generate records. A CSV Writer step is used to write a CSV document. The Combine step is used to combine records into a single output. A Run File Destination step is used to deliver an output file that can be downloaded.

The Record Generator source step is shown in the image below.

Adding a Run File Destination Step

To add a Run File Destination step in a flow, follow the below instructions:

1. Click on the highlighted icon as shown in the below image. The Run File destination step is accessible after a reader step or mapper step is used.

2. The below page will appear. Select or search for a Destination step. Click on the Destination tab and select Run File as shown in the image below.

Configuring the Run File Destination step

Illustrated in the below image is the configuration that is available in the Run File Destination step.

Input

The object input to return which can either be the Record, Output, Result or Original Record. The Output option is selected by default when the Run File Destination step is added.

  • Record - Return the current processed record.

  • Output - Return the flow’s output file.

  • Result - Return the output of the file.

  • Original Record - Return the original record.

Step Reference

  • Source, Reader and Mapper steps put their output data on the Record object.

  • Writer steps put their output data on the Output object.

  • Destination steps put their output data on the Result object

Expiry

Number of minutes before the file is no longer available. This is set at 1440 by default when the Run File Destination step is added.

File Type

File type to return. Click on the outlined arrow in the image above to select the file type from the dropdown list.

Using a Run File Destination Step

1. Click the Execute Flow button shown in the image below:

2. Click the Create Run button as highlighted in the below image.

3. Click the download button in the Run File Destination step to download the output file as highlighted in yellow in the below image.

4. Save the file on your local machine as illustrated in the image below.

The image below shows the CSV output file.

Did this answer your question?