User Tools

Site Tools


Plugin installed incorrectly. Rename plugin directory 'swiftmail.backup' to 'swiftmail'.
en:software:tim:actionhandler:wordtemplatehandler

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:software:tim:actionhandler:wordtemplatehandler [2020/05/15 09:10]
Stefan Barth [Parameter]
en:software:tim:actionhandler:wordtemplatehandler [2021/07/01 09:52] (current)
Line 17: Line 17:
 ---- ----
  
-==== Action Class ==== +==== Action Class ====<​code>​
- +
-<​code>​+
 com.dooris.bpm.actionhandler.WordTemplateHandler com.dooris.bpm.actionhandler.WordTemplateHandler
 </​code>​ </​code>​
Line 57: Line 55:
 === overwriteExisting (optional) === === overwriteExisting (optional) ===
  
-This may be either **true** ​ or **false**. If the name is set to **true**, TIM overwrites the existing PDFs if the process runs again through a loop. If the PDF is still needed, the value must be set to **false**. > This value is set to **false** ​ by default ​\\+This may be either **true** ​ or **false**. If the name is set to **true**, TIM overwrites the existing PDFs if the process runs again through a loop. If the PDF is still needed, the value must be set to **false**. > This value is set to **false** ​ by default
  
 === documentPrefix === === documentPrefix ===
Line 66: Line 64:
  
 This value must first be set to **true** ​ in order to TIM to generate a PDF. If the value is set to **false** ​ or nothing is entered, TIM replaces the variables in the template and generates a Word file, which is then attached to the process. This value must first be set to **true** ​ in order to TIM to generate a PDF. If the value is set to **false** ​ or nothing is entered, TIM replaces the variables in the template and generates a Word file, which is then attached to the process.
 +
 +=== removeEmptyTableRows (optional) ===
 +
 +If this value is **true**, all table rows in the docx-template will be cleared, if the variable in the first column is not available or empty. This prevents using space of empty (DOMRepeater) rows. The parameter is available beginning with version [[:​software:​tim:​changelog:​tim582|5.8.2]]. > The default is **false**
  
 === interpretNummbersAsBoolean === === interpretNummbersAsBoolean ===
Line 87: Line 89:
 === target === === target ===
  
-With the **target** ​ parameter you can determine the document name. This approach is useful, if the document name should be different from the template name. The target parameter can contain process variables. > Consider you want to create a report in english and german. The word template in the resource folder has the following name **${SYS.PROCESSINSTANCE_NAME}_report_${language}**. With the target parameter you can change the name of the word file to e.g. **target=XY-Report_DE**. Therefore you can create word files with different names from the same word template. ​\\  \\ **Important:​** ​ no file extension is needed within the target parameter +With the **target** ​ parameter you can determine the document name. This approach is useful, if the document name should be different from the template name. The target parameter can contain process variables. > Consider you want to create a report in english and german. The word template in the resource folder has the following name **${SYS.PROCESSINSTANCE_NAME}_report_${language}**. With the target parameter you can change the name of the word file to e.g. **target=XY-Report_DE**. Therefore you can create word files with different names from the same word template. ​   **Important:​** ​ no file extension is needed within the target parameter<​code>​
- +
-<​code>​+
 target=${processInstanceId}_${processInstanceName}_report target=${processInstanceId}_${processInstanceName}_report
 </​code>​ </​code>​
  
- ​\\ ​{{  :​software:​tim:​actionhandler:​wordtemplatehandler2.png?​700 ​ }}In this instance, the word document is saved as **1467_8D-ProblemSolving_report.docx**+  ​{{  :​software:​tim:​actionhandler:​wordtemplatehandler2.png?​700 ​ }}In this instance, the word document is saved as **1467_8D-ProblemSolving_report.docx**
  
 === locale === === locale ===
Line 103: Line 103:
 ==== Example ==== ==== Example ====
  
-{{  :​software:​tim:​actionhandler:​wordtemplatehandler.png?​700 ​ }} \\ In this example, a PDF is attached after the activation of the wordTemplateHandler. It is composed as follows:+{{  :​software:​tim:​actionhandler:​wordtemplatehandler.png?​700 ​ }}  In this example, a PDF is attached after the activation of the wordTemplateHandler. It is composed as follows:
  
 <​code>​ <​code>​
en/software/tim/actionhandler/wordtemplatehandler.txt · Last modified: 2021/07/01 09:52 (external edit)