Report

Article • 02.08.2022 • 4 minute(s) to read

Report

The Report Activity executes a Data Query and converts the results into a file. What file will be created is specified by the Template. The Template is configured either in the Data Query itself or in the settings of the Report Activity. Be aware, that the configuration here in the Report Activity overrules the configuration in the Data Query.
This Activity can have an arbitrary amount of Outcomes, but all Outcomes must have the same name. The script of each Outcome is evaluated once the Activity has completed. Each Outcome with a script evaluating to true is followed. If more than one Outcome script evaluates to true, the Instance is paralleled. If no Outcome script evaluates to true, the Instance is ended by entering the closed-state.

Activity config

General
  • Name - Name of the Activity.
  • Version - Version of this Activity used in the Process. If a new version of this Activity is available and you want to use it, you have to manually update the version here. When a new Activity is added to the Process, automatically the latest version is placed.
  • Timeout in second - Once this time is elapsed, the Activity is closed and the Instance changes into the faulted-state. The default Timeout is two minutes. The timeout can be shortened and extended by entering a custom duration. If the Activity is left after a timeout, the first Outcome is followed. If multiple Outcomes have the same name as the first Outcome, all of them are followed. However, a continuation after a timeout does not effect the Outcome Scripts, meaning only Outcomes with Outcome Scripts evaluating to true are followed.
  • Hide in process graph - Controls if the Activity is hidden (Yes) or shown (No) in the Process Graph on the Execution Screen.
  • Continue on error - If this is set to Yes, the execution of the Instance continues even if the Activity failed. If set to No, the Instance fails when the Activity fails by entering the faulted-state. In the case of a continuation after an error, the first Outcome is followed. If multiple Outcomes have the same name as the first Outcome, all of them are followed. However, a continuation after an error does not effect the Outcome Scripts, meaning only Outcomes with Outcome Scripts evaluating to true are followed.
Report

Report Activity specific configurations

GENERAL

General interaction configuration, shared with most other Activities

  • Disable activity - Disables (Yes) or enables (No) the Activity. When disabled, the Activity is not executed and passed like a Connection by following the first Outcome. If multiple Outcomes have the same name as the first Outcome, all of them are followed. Disabling the Activity does not effect the Outcome Scripts, i.e., still only Outcomes with Outcome Scripts evaluating to true are followed.
  • Retry on error - If set to Yes, an automatic retry is executed up to ten times. If set to No, no retries are done. Retries are issued when the Activity failed so that the Instance would enter the faulted-state if the retry is disabled.
  • Additional text for task list - Description of this Activity shown to the Users in their task list. You can enter this text directly or use Process Context Expressions to compile it.
SETTINGS

Report configuration

  • Query - Selects the Data Query executed to generate the Report. I.e., the results of the selected Data Query are filled into the Template to create the Report.
  • Query parameters - Sets the parameters that the Data Query expects. If any expected parameters are not set, the Data Query will not work. A new parameter can be configured by clicking Add:
    • Key - Name of the parameter as specified by the Data Query, but without the leading @-sign
    • Value - Value of the parameter, entered directly or determined by a Process Context Expression.
    • - Deletes a configured parameter
  • Alternative template file Id - If this field is left empty, the Template configured at the Data Query is used to generated the Report. If this field is not empty, the Template configured here is used instead. The Template is specified by its file ID and can be entered directly or determined by a Process Context Expression. Microsoft Word and Excel Templates are supported.
  • Alternative file name - If this field is left empty, the Report will have the same file name as the Template. If this field is not empty, the file will get the name specified here. The name can be entered directly or determined by a Process Context Expression.
  • Variable - The generated report is stored as a file on the Novunex Platform in your Subscription. The link to access the file is stored in an Attribute of type File of an exiting Variable or in a new Context Variable. Hence, here the Variable with its File Attribute or the new Context Variable has to be configured here. An Example for a Variable with a File Attribute is MyEntityVariable.FileAttribute.