Report Output Handler Flow
  • 29 Mar 2021
  • 4 Minutes to read
  • Dark
    Light

Report Output Handler Flow

  • Dark
    Light

Overview

This tutorial demonstrates how to create and use a Report Post Processing Flow. This Flow Behavior 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 data into an Excel File. The Flow then outputs this custom Excel File. This kind of Flow may be used similarly as a Report Output Template. 

In this example, create a 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 set in the settings under Behavior Type, or a Report Handler Flow can be set up by navigating to System > Designers > Report Output > Handlers Folder and select Add Report Output Flow on the blue Folder Actions Panel.


Example

  1. Navigate to a Designer Folder and select the Create Flow button. Name the Flow and select CREATE to open the Flow in the Flow Designer.
  2. Add a Create Data step from the Favorite Steps category in the Toolbox. With the Create Data step selected, under Data To Create, select Show Editor to open the Data Definitions editor. Name the Data Definition: "File". Define its Type as File Data. 
  3. Under Inputs next to File, select Constant and upload a file using either the Drag file here or Choose file option.


  4. On the Done outcome path, add a Set Values in Column step from the Integrations > Excel and CSV category in the Toolbox. 
    Inputs available on the Set Values in Column step
    ColumnDefines the column that will populate the Excel file from the report.
    Fields Start With Equals Are FormulaTells excel whether it should treat strings that start with = as a formula or just a regular string.
    File Typeselects the type of file that the report data will upload onto.
    InputCan choose what data you will input. In this case, select the string that was created in the Create Data Step.
    RowDefines the row that will populate the excel file from the report.
    Try to Parse NumbersDeclares whether or not a set of numbers should be interpreted as a string or a number.
    ValuesThis is where you define the values coming from the report. Select the Report and choose the data on the Report needed.
    Worksheet numberDefines the page number that the data needed starts on.


  5. Select the Set Values In Column Step in the Flow Designer and edit the Input settings. 
  6. Under Inputs and next to Column, select Constant and define the column with a number for the data to populate on the Excel File. 
  7. Set Fields Start With Equals Are Formula to Constant
  8. Set File Type to Constant and select the Type from the drop-down list. 
  9. Next to, Input choose Select Form Flow and choose the Data Definition created from the Create Data step.
  10. Set Row to Constant and enter the row number that should be populated on the Excel File. 
  11. Next, Try To Parse Numbers set to Constant and check the box. 
  12. Set Values to Select From Flow and Pick the Report Data and the Field that will populate the Excel File.

  13. Next, add a second Set Values In Column step in the Flow Designer and edit the Input settings. 
  14. Under Inputs and next to Column, select Constant and define the column with a number for the data to populate on the Excel File. 
  15. Set fields Start With Equals Are Formula to Constant
  16. Set file Type to Constant and select the Type from the drop-down list. 
  17. Next to, input choose Select Form Flow and choose the Data Definition created from the Create Data step.
  18. Set Row to Constant and enter the row number that should be populated on the Excel File. 
  19. Next to, try To Parse Numbers set to Constant and check the box. 
  20. Set Values to Select From Flow and Pick the Report Data and the Field that will populate the Excel File.

  21. Add a third Set Values In Column step in the Flow Designer. 
  22. Under Inputs and next to Column, select Constant and define the column with a number for the data to populate on the Excel File. 
  23. Set Fields Start With Equals Are Formula to Constant
  24. Set File Type to Constant and select the Type from the drop-down list. 
  25. Under Input, choose Select Form Flow and select the Data Definition created from the Create Data step. 
  26. Set Row to Constant and enter the row number that should be populated on the Excel File. 
  27. Next, Try To Parse Numbers set to Constant and check the box. 
  28. Set Values to Select From Flow and Pick the Report Data and the Field that will populate the Excel File.


  29. On the Done outcome path, add an Update File with Data step from the Integrations > Excel and CSV category in the Toolbox. 
  30. Select the Update File with Data step and edit the settings. 
  31. Under Inputs and next to File Type, choose Constant and select the File Type from the drop-down list.

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

Run a Report onto an Excel File

Before a report can be run on an Excel File, the Output Handler Flow must first be created. If the Report and the Output Handler Flow have been created, select the Output Handler Flow in the example.
  1. On an already existing Accounts Report, in the Properties panel, expand Settings
  2. Under Output Handlers, select Add New, then choose the Report Handler Flow created in this example. Select Run Report from the action panel located on the top of the Report dashboard. Learn more about Creating your First Report.

  3. Select the gear icon to open Report actions on the right and choose the printer icon. 
  4. Under Settings and Output Type, choose Account Report Handler and select Proceed. Download the Exported Report and open it in the Excel Template.


  5. Open up Excel and navigate to File > Import and then Upload the file to see it populated with the chosen fields.

Was this article helpful?