Versions Compared

Key

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

...

This actionhandler allows you to create and use Word document templates with values from process variables that usually come from a form. The parameter "overwriteExisting" specifies whether existing templates may be overwritten (true) or whether a new template should be created. Variables from VariablesHelper can also be used with this actionhandler.

...

Info

The WordTemplateHandler can also be installed in the HTML Forms as a button to generate a template if required. More information is here.

...

Parameter

Default value

Description

Valid examples

template

Status
titlemandatory

This parameter is used to set the path to the template, so the ActionHandler can search for it in the resources folder.

It can be specified absolute or relative to the external file path in the loom.properties. In order to rename the generated PDF, the name of the template itself may contain process variables. 

Special case: Resolving process variables in the template name

Given the template, parameter has the following value: template=${SYS.PROCESSINSTANCE_NAME}_report.docx. In the target folder, the file will be searched accordingly.

  1. The WordTemplateHandler literally searches for the template ${SYS.PROCESSINSTANCE_NAME}_report.docx.

  2. If it is unable to find the respective document, the process variables SYS.PROCESSINSTANCE_NAME will be resolved in the document name.

  3. Only now, the WordTemplateHandler is looking for the template 8D-ProblemSolving_report.docx (8D-ProblemSolving is the resolved value of ${SYS.PROCESSINSTANCE_NAME}).

Info

In order to access ‘Resources’ section under the 'Administration' please see: Roles

${processInstanceId}_8D-report.docx

overwriteExisting

false

This parameter is used to decide if the documents should be overwritten if the process run by a loop. If the original template is needed, it should be false.

true

documentPrefix

The documentPrefix can be used so that created documents always have the specified value before the template name.

mydocumentprefix

pdf

false

If this parameter is set to false or is not given, the system replaces the variables in the template and creates a Word document, which is attached to the process. In order to create a PDF document instead of a Word document, this should be true.

true

removeEmptyTableRows

false

When the value is set to true, all table rows in the docx-template are cleared, if the variable in the first column is missing or empty. This can avoid unsightly blank rows in dynamic content (DOMRepeater).

true

interpretNummbersAsBoolean

false

It can be either true or false. If this value is set to true, process variables (which need to start with "bool") are changed like below: 

  • baa1 → true (In the document: true)

  • boolbaa1 → true (In the document: yes)

  • boolbaa1 → 1 (In the document: yes)

  • bobbb1 → false (In the document: false)

  • boolbbb1 → false (In the document: no)

  • boolbbb1 → 0 (In the document: no)

with value 1 are changed to ‘ja’/'yes' and with value 0 are changed to ‘nein’/‘no’ .

Parameter locale needs to be changed to en for yes/no.

true

interpretBooleanAsHuman

falseThis parameter is used to decide if the boolean variables (true and false) should be replaced with ‘yes and no'. Setting this variable to true will change boolean variables as 'yes and no'

It can be either true or false. If this value is set to true, process variables (which need to start with "bool") with value true are changed to ‘ja’/'yes' and with value false are changed to ‘nein’/‘no’ .

Parameter locale needs to be changed to en for yes/no.

true

target

This parameter is used to determine the document name in the destination folder. This procedure is useful if the name of the created Word document should be different from the template name. The target parameter can contain process variables.

Suppose the user wanted to generate two reports in English and German. The Word template in the resource folder has the following name ${SYS.PROCESSINSTANCE_NAME}_report_${language}. With the target parameter, the name of the Word document can now be changed to e.g. target=XY-Report_DE. Therefore the user can create Word files with different names from the same Word template.

Note

File extension is not needed within the target parameter.

target=${processInstanceId}_${processInstanceName}_report

locale

"de"

With this parameter all system supported languages can be given in short form(e.g. en, de). This leads to, that all system-generated words (e.g. boolean Yes/No) are translated.

...