Report Output Handler Flow

Last Updated: 12/05/2018 Introduced in Version: 3.2

This tutorial demonstrates how to create and use a Report Post Processing Flow. This Flow type is used as a Report Output Handler. With this Flow configured, users will get a new option of saving a Report onto an excel file. This Flow takes in Report Data and organizes this Report Data onto an Excel File. The Flow then outputs this custom Excel File. This kind of Flow may be used in a similar manner as a Report Output Template. In this example, create a simple Report. Then create a Report Post Processing Flow that will arrange Report data into an Excel File. Finally, use this Flow to save the Report as an Excel file.

Use the Set Values In Column Step to order Report data onto the Excel Template using Excel steps in the Flow.

 

Create a Report Output Handler Flow

A Report Handler Flow is a flow behavior that can be set in the settings under Behavior Type or a Report Handler Flow can be set up by navigating from the designer Folders to System > Designers > Report Output > Handlers Folder and select Add Report Output Flow on the blue Folder Actions Pane (Figure 1).

Figure 1

 

Flow Example

Running Post Processing Flow On Report Output

The example below is a flow built using a Report Output Handler for the purpose of processing a report onto an Excel File. 

 

Steps: Location

Create Data: Data> Create Data Step

Set Values In Column 1: Integration/ Excel and CSV>SetValuesInColumn

Set Values In Column 2: Integration/ Excel and CSV>SetValuesInColumn

Update File With Data: Integration/ Excel and CSV>UpdateFileWithData

 

Create Data Step

In the Create Data Step select show editor to open the Data Definitions editor.

 

 Add a Data Definition and name it  “File”. Define its Type File Data. Under Inputs next to File select Constant and upload the file using either the Drag file here or Choose file option.

 

Set Value In Column (1)

Column: Defines the column that will populate the Excel file from the report. 

fields Start With Equals Are Formulae: Tells excel whether it should treat strings that start with = as a formula or just a regular string

file type: selects the type of file that the report data will upload onto.

input: Can choose what data you will input. In this case, select the string that was created in the Create Data Step.

Row: Defines the row that will populate the excel file from the report. 

Try to Parse Numbers: Declares whether or not a set of numbers should be interpreted as a string or a number.

Values: This is where you define the values coming from the report. Select the Report and choose the data on the Report needed.

Worksheet number: Defines the page number that the data needed starts on.

 

Next, select the Set Values In Column Step (1) in the Flow designer and edit the Input settings. Under Inputs and next to column select Constant and define the column with a number for the data to populate on the Excel File (1). Set fields Start With Equals Are Formulae to Constant. Set file Type to Constant and select the Type from the drop-down list. Next to, input choose Select Form Flow and choose the Data Definition created from the Create Data Step, (File).

 

Set Row to Constant and enter the row number that should be populated on the Excel File (1). Next to, try To Parse Numbers set to Constant and check the box. Set Values to Select From Flow and Pick the Report Data and the Field that will populate the Excel File.

 

Set Value To Constant (2)

 Next, add a second Set Values In Column Step in the Flow designer and edit the Input settings. Under Inputs and next to column select Constant and define the column with a number for the data to populate on the Excel File (2). Set fields Start With Equals Are Formulae to Constant. Set file Type to Constant and select the Type from the drop-down list. Next to, input choose Select Form Flow and choose the Data Definition created from the Create Data Step, (File).

 

Set Row to Constant and enter the row number that should be populated on the Excel File (1). Next to, try To Parse Numbers set to Constant and check the box. Set Values to Select From Flow and Pick the Report Data and the Field that will populate the Excel File.

 

Update File With Data

Select the Update File with Data Step and edit the settings. Under Inputs and next to file type choose Constant and select the file type from the drop-down list. The file type selected for this example is Excel_xlsx.

 

End Step

Next, connect Update File With Data step to the End Step in the Flow. Select End Step and map the Output (FileData) to the Output.

 

The Excel file will serve as a Template for the Report data.

excelFile

This completes the Flow example, save and close Flow Designer.

 

 

Run a Report onto an Excel File using the Report Output Handler Flow.

note: Before a report can be run on an Excel File the Flow must be  Output Handler Flow must first be created. If The Report and the Output Handler Flow have been created simply select the Output Handler Flow in the example as follows.

 

Select Run Report from the orange action panel located on the top of the Report dashboard. 

 

Select the Settings wheel on right and choose the printer icon. 

 

Under Settings and under Output Type choose Account Report Handler and select Proceed.

 

Download the Exported Report and open in the Excel Template.

 

Open up Excel and navigate to File>Import and then Upload the file to the Excel Template to see it populated with the Email Address and Account Id. 

 

This completes the Report set up. Save and Exit to the designer Folder.

 

Links:

Creating Your First Report 

Additional Resources