Table of Contents
GenerateReportActionHandler
Description
This handler creates a process instance report and attaches it to the process instance. This allows it to be sent, for example, with the ATTACH-command in a mail node. Alternatively, the handler can save the report in the file system.
The path for saving the report and the file name can be given as process variables instead of as parameters: report_path and report_file_name From Version 3.7 on, the new instance report is issued. Prior to this, only the file name, the path, and the decision as to if the report should be attached to the instance are evaluated. The other variables do not have any effect.
Action Class
com.dooris.bpm.actionhandler.GenerateReportActionHandler
Event Type
any
Action Name
any
Mandatory Fields
none
Parameter
There are no mandatory fields. If no parameter is stipulated, the report will be distributed as a pdf with all parts in German.
reportType
This gives the format for the distributed report. The default is a pdf. If an Excel-file should be generated, xls should be entered here.
reportLanguage
The possible languages are: de,en,fr,nl and es. (for German, English, French, Dutch, and Spanish, respectively)
showActivitiesTable
The default value is true. If the activity listing should not be included in the report, then false must be entered here.
showActivitiesNotes
The default value is true. If the activity notes should not be incorporated into the report, then false must be entered here.
showInstanceNotes
The default value is true. If the instance notes should not be incorporated into the report, then false must be entered here.
showSmartForm
The default value is true. If the process variables should not be incorporated into the report, then false must be entered here.
showProcessGraphic
The default value is true. If the process graphics should not be incorporated into the report, then false must be entered here.
addToInstance
addToInstance is set to false by default. If set as true (or if no file path is provided), the report will be attached to the instance.
userNameDisplayMode
The default value is true. It is used to display first and last name in the report. If it is set to false, the username is displayed.
reportFileName
Name of the report file. This also applies to the document attached to the instance.
File names may be named after variables with ${VariableName}.
reportPath
Path to the location of the report. This should end with “/”.
The path may be given using a variable ${VariableName} .
Example
Example 1:
reportFileName=report.pdf;
reportPath=C:\Report;\ ⇒ The report will be saved under C:\Report with the name report.pdf and will not be attached to the instance.
Example 2:
reportFileName=report.pdf;
reportPath=C:\Report;\ addToInstance=true;
⇒ The report is saved under C:/Report with the name report.pdf and attached to the instance.
Example 2:
No parameter
⇒ The report is attached to the instance with the standard name, i.e. tim_report_16_12_2015_08-07_pireport.pdf.
Example 4:
No parameter, but a variable named “report_file_name” and “report_path” are given.
⇒ The report will only be saved in the location given in the variable “report_path”; it will be named according to the file name provided in the variable “report_file_name”.
