runReport Step

Use this feature to generate a report in a selected format from a FlowWright Report Definition, optionally supplying report parameters and storing the generated file path in a Variable or Global variable.

Last published at: September 7th, 2026

Description:

The Run Report workflow step generates a report based on the selected FlowWright Report Definition. The step allows the workflow to select the report definition, choose the report output format, optionally configure report parameters, and store the resulting file path in a Variable or Global variable.

The step supports:

  • Selecting a Report Definition to execute.
  • Selecting the Run Report output format.
  • Configuring report parameters when required.
  • Storing the generated report file path in a Variable or Global variable.
  • Using the generated report in subsequent workflow activities.
  • Generating reports as part of workflow automation.
  • Returning a True or False result for subsequent workflow processing.

 

Inputs

  • reportDefinitionID – Selects the Report Definition used to generate the report.
  • runReportType – Selects the format in which the report is generated.
  • reportParameters – Provides parameters for the selected report. This property is optional.
  • varGlobalFilePath - Specifies the Variable or Global variable in which the generated report file path is stored.
 

 

Returns

  • True – The True return path can be connected to the next workflow activity after the report generation operation succeeds.
  • False – The False return path can be used for error handling or an alternative workflow path if the report generation operation fails.
 

 

Usage:

The Run Report step is typically placed after the workflow has collected or determined the information needed to generate a report.

A typical workflow pattern is:

Collect Data → Run Report → Use Generated Report

The report generated by the step can then be used by later workflow activities to:

  • Store or archive the report.
  • Send the report to users.
  • Attach the report to an email.
  • Deliver the report to another system.
  • Process the generated report further.
  • Provide the report as workflow output.
  • Continue a document or reporting workflow.

When report parameters are required, workflow values can be supplied through the Configure Report Parameters property before the report is generated.

The generated report file path is stored in the specified Variable or Global variable, making it available to subsequent workflow activities. This behavior is represented directly by the Variable/Global to hold file path property in the step definition.

A typical workflow pattern is:

 

Typical Workflow Suggestions:

Generate a Scheduled Report

Use the step in a scheduled workflow to automatically generate a report.

Example:

Scheduled Start → Run Report → Store/Send Report
The workflow can execute a predefined Report Definition and make the generated report available for subsequent processing.
 

Generate a Parameterized Report

Use Configure Report Parameters when the report needs values determined by the workflow.

Example:

Collect Parameters → Run Report → Send Report
The workflow can determine the required values and supply them to the selected Report Definition.
 

Generate Customer-Specific Reports

Use workflow information to generate a report for a particular customer, account, request, or other business context.

Example:

Get Customer Information
          ↓
      Run Report
          ↓
    Send Customer Report
The Report Definition can be selected in the step, and the required report parameters can be configured using the workflow's available values.
 

Generate Period-Based Reports

Use the step to generate reports for a specific reporting period when the selected Report Definition supports corresponding parameters.

Example:

Determine Reporting Period
          ↓
      Run Report
          ↓
    Archive Report
The workflow can determine the reporting period and supply the appropriate report parameters.
 

Send a Generated Report by Email

Generate the report and use the resulting file path in a subsequent email activity.

Example:

Run Report → Send Email
The report file path stored in the specified Variable or Global can be used by the downstream workflow activity.
 

Archive Generated Reports

Use the step to create a report and then store or archive the resulting file.

Example:

Run Report → Archive/Store Report
This pattern is useful for workflows that need to retain generated reports for later reference.
 

Generate Reports in Different Formats

Use the Select Run Report Format property when the same Report Definition needs to be generated in an available output format appropriate for the workflow.

Example:

Select Report Definition
          ↓
Select Run Report Format
          ↓
      Run Report
The XML confirms that the format is selected through the selectRunReportType property, although it does not enumerate the available format values.
 

Prepare Reports for Downstream Processing

Use Run Report as an intermediate step before another document or file-processing activity.

Example:

Prepare Data → Run Report → File Processing
The generated report path can be passed to the subsequent activity through the configured Variable or Global.
 

Generate Reports from Workflow Requests

Use the step when a workflow begins from a user request and needs to produce a report based on information collected during the process.

Example:

User Request
     ↓
Collect Report Criteria
     ↓
Run Report
     ↓
Deliver Report
 

Generate Reports as Workflow Output

Use the step near the end of a workflow when the report represents the final output of the process.

Example:

Process Request → Run Report → Provide Report
The generated file path can be retained in a Variable or Global for use by subsequent activities.
 

Generate Multiple Reports

A workflow can use multiple Run Report steps when several Report Definitions need to be executed as part of the same business process.

Example:

Prepare Data
    |
    +--> Run Report A
    |
    +--> Run Report B
    |
    +--> Run Report C
Each step can select its own Report Definition and output format.

 

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. 
  • Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, additional values are available for configuration. 
  • 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 store the path. Click the Save button to confirm. 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 appears for configuration. Click the Add Row (+) button to insert an empty row. Enter the parameter name and value. Click the Save button. You can insert multiple rows to specify a range of parameter values. 

 

  • The “Logging” configuration is necessary for documentation and also measures workflow progress and 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 execute it. When the workflow reaches the Run Report step, FlowWright uses the selected Report Definition and configured Run Report format. If report parameters have been configured, those values are supplied during report execution. The generated report file path is stored in the configured Variable or Global variable. The workflow can then continue through the True path or use the False path for an alternative or error-handling flow.

 

Tips:

  • Select the appropriate Report Definition before configuring report parameters.
  • Verify that the selected Report Definition contains the data required by the workflow.
  • Configure Report Parameters only when they are required by the selected report.
  • Use meaningful Variable or Global names for storing the generated report file path.
  • Verify that the selected output format is appropriate for the intended downstream activity.
  • Test parameter values with representative workflow data.
  • Verify that all required report parameters receive valid values before the step executes.
  • Use the generated file path in downstream activities rather than assuming a fixed file location.
  • Connect the False return path to appropriate error-handling logic.
  • Test the workflow with different parameter values when the report is parameterized.
  • Verify the generated report before sending or distributing it.
  • When using multiple Run Report steps, give each step and its output Variable or Global a meaningful name.
  • Keep Report Definitions reusable when several workflows require the same reporting logic.
  • Test the workflow after changing the underlying Report Definition or its parameters.
  • Do not assume the available report formats without checking the Select Run Report Format list in the FlowWright environment.
  • Do not assume parameter names, types, or behavior from the XML alone; these depend on the selected Report Definition.
  • Protect generated reports when they contain sensitive or restricted information.
  • Verify that downstream activities have access to the generated report file.

 

Notes:

  • The Run Report step is defined in the Engine category with the internal name runreport, label “Generates the report in various formats for the selected Report Definition”, and display name “Run Report.”
  • The step is implemented by FlowWright.Workflow.RunReport in FlowWright.Workflow.dll and is defined as a Process step with 2 incoming connections and 2 outgoing connections.
  • The step defines four properties:
    • reportDefinitionID – Report Definition to use.
    • runReportType – Select Run Report Format.
    • reportParameters – Configure Report Parameters.
    • varGlobalFilePath – Variable/Global to hold file path. 
  • The first two properties are required and use the selectReportDefinitionList and selectRunReportType data types, respectively.
  • The Configure Report Parameters property is optional and uses the enterReportParameters data type.
  • The Variable/Global to hold file path property is required and uses the string data type.
  • The step provides two return values:
    • False
    • True

 

Definition Sample:

You may download the sample definition(s) from the link provided and later import them into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

Note: Verify and complete any missing configuration after importing the sample, including:

  • Report Definition to use.
  • Run Report Format.
  • Report Parameters, where applicable.
  • Variable or Global used to hold the generated file path.
  • Workflow Variable references.
  • Environment-specific settings.
  • Downstream True and False workflow paths.

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.