runReport Step
Description:
This step generates the report in various formats for the selected Report Definition.
Inputs
- reportDefinitionID – Select the Report Definition
- runReportType – Choose the Report format
- reportParameters – Enter the Parameters for the report
- varGlobalFilePath - Specifies the File Path for the output
Returns
- True – step executed successfully
- False – step failed to execute
Usage:
Example:
Let’s build and execute the “runReportDef” example.
- Create a new definition called “runReportDef” and open the definition in designer mode.
- Drag a “runReport” step to the canvas.
- Connect the dots between the “Start” and “runReport” steps, as shown above.
- Click the “runReport” step to configure its “Required” properties. Provide a name for the step. Select the report definition from the drop-down list. Select the report format from the drop-down list (PDF, Excel, Word, HTML, CSV). Provide a variable or a global reference to hold the path. Click the Save button to confirm. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description.
- Click the “runReport” step to configure its “Optional” properties. Click the button to configure the report parameters. A pop-up window is displayed for configuration. Click the Add Row (+) button to insert an empty row. Provide the parameter name and value. Click the Save button. You can insert multiple rows to provide a range of parameter values.
- The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.
- Save the process definition, create a new instance, and then execute it. The process step should run the report.
Definition Sample:
You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after import. Then, save the definition to confirm the changes.
Click here to download the sample file.