Versions Compared

Old Version 1

changes.mady.by.user Betül Kara

Saved on

compared with

New Version 2

changes.mady.by.user Betül Kara

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

This handler creates the 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 linkcomingsoon. 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: reportPath and reportPath and reportFileName. 

...

Class

Code Block
com.dooris.bpm.actionhandler.GenerateReportActionHandler

Parameter

Info

If no parameters are set, the report will be distributed as a pdf PDF with all parts in germanGerman.

Parameter 

Default value

Description

Valid examples

reportType

This gives the format for the distributed report. The default value is PDF. If an Excel-file should be generated, xls should be entered here.

reportLanguage

Possible languages are de, en, fr, nl, and es. (for German, English, French, Dutch, and Spanish, respectively)

showActivitiesTable

true

If the activity listing should not be included in the report, then false must be entered here.

showActivitiesNotes

true

If the notes of the instance should not be included in the report, then false must be entered here.

showSmartForm

true

If the process variables should not be included in the report, then false must be entered here.

showProcessGraphic

true

If the process graphics should not be included in the report, then false must be entered here.

addToInstance

false

If set to true (or if no file path is provided), the report will be attached to the instance.

true

userNameDisplayMode

true

It is used to display the 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}.

report.pdf

reportPath

Path to the location of the report. This should end with “/”.
The path may be given using a variable ${VariableName}.

Note

If no path and filename is specified, the report will always be attached to the process. The name is then the default name: system_report_instanceName_date_time_pireport.pdf

C:\User\..\Report\

Examples:

  1. reportFileName=report.pdf;
    reportPath=C:\Report;\ 
    ⇒ the report is saved under: C:\Report with the name report.pdf and is not attached to the instance

  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

  3. no parameters
    ⇒ the report is named with the default name, e.g. tim_report_16_12_2015_08-07_pireport.pdf and it is attached to the instance

  4. no parameters, but the variables reportFileName and reportFileName and reportPath are present.
    ⇒ the report is only saved at the location specified in the reportPath variable with the filename specified in the reportFileName variable reportFileName variable