Versions Compared

Old Version 3

changes.mady.by.user Sead Mejzini

Saved on

compared with

New Version Current

changes.mady.by.user Arlinda Dobruna

Saved on

Key

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

Description

This actionhandler is available from v7.14 and allows you to create and use Excel document templates with values from process variables that usually come from a smartform. The parameter "overwriteExisting" specifies whether existing templates may be overwritten (true) or whether a new template should be created. form.

Variables from VariablesHelper can also be used with this actionhandler.

...

Info

The ExcelTemplateHandler can also be installed in the Smartform 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 PDFfile, 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.xlsx. In the target folder, the file will be searched accordingly.

  1. The ExcelTemplateHandler literally searches for the template ${SYS.PROCESSINSTANCE_NAME}_report.xlsx.

  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 ExcelTemplateHandler is looking for the template 8D-ProblemSolving_report.xlsx (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.xlsx


The handler supports .xlsx and .xlsm file extensions

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

removeEmptyTableRows

false

When the value is set to true, all table rows in the xlsx-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

interpretNummbersAsBooleaninterpretNumbersAsBoolean

false

It can be either true or false. If this value is set to true, process variables (which 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)

true

interpretBooleanAsHuman

false

This 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'.

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 Excel files with different names from the same Word Excel template.

Note

File extension is not needed within the target parameter.

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

locale

"de"en

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.

de

Setup

In order to setup the action hander the below steps are required:

  1. Setup the process

    1. Have or upload a simple workflow

      View file
      nameSimpleModel-version-2.zip

    2. Import form

      View file
      name20240130_SimpleModel_v1.json

  2. Upoad Upload the template in tenant admin resources

    View file
    nametemp.xlsx

...

Note

The variables must be the same as in the Excel template.

...

Calling the execution of ExcelTemplateHandler from a REST api call endpoint

The ExcelTemplateHandler can be called from rest api using the below endpoint

Code Block
POST: [your server url here]/tim/api/templates

{
    // Mandatory params
    "processInstanceId": [YOUR PI ID HERE],
    "template": [YOUR TEMPLATE PATH HERE],

    //Optional params
    "target": "",
    "documentPrefix": "",
    "locale": "",
    "overwriteExisting": false,
    "interpretNumbersAsBoolean": false,
    "interpretBooleanAsHuman": false,
    "removeEmptyTableRows": false,
    "open": false
}

...

Integrating the ExcelTemplateHandler into a HTML-

...

Form

The ExcelTemplateHandler can be integrated into a HTML-Smartform Form as a link, a button, or an image so that the participants can create a template at any time. For this, the following code must be integrated into the smartformform:

Code Block
<button type="button" onbuttonclick="generateFileFromTemplate([{handler:'ExcelTemplateHandler',template:'temp.xlsx',attach:false,open:true,documentPrefix:'Prefix'}])">Generate Excel template</button>

...

The "onbuttonclick" attribute defines which functions/parameters the handler should execute. See Parameters sections above.

...

Important when using HTML-

...

Forms

Normally written text will be inherited, whereas variables will be overwritten if marked as ${Variable-ID}. To overwrite variables with content from the HTML form, you must use the variable's ID, such as ${Variable-ID}, within the text form fields. An exception to this rule applies to radio buttons, where you should use the variable name, like ${Variable-Name}, instead of the variable ID.

...