Skip to end of metadata
Go to start of metadata

 

 ← Return to the list of available actions

If you have a problem understanding how the action works, check: ActionConditional ExecutionComponents parameters.

Basic information

Action location: Table, Table button

Available from version: 1.0.3

Previous names: Document generation (up to version 1.0.33) 

Category: Documents

Description

Generates a document from the given template based on the current process data. Preparation of the document template is described on the page: DOCX template for generating PDF. The document can be attached to the process in which the automatic task was called. You can set your own name for the document and choose one of two types - PDF or DOCX. The component allows you to set variable values in the template using the mapping. If the variables in the template already have the corresponding variables on the form, then using this component we can overwrite these mappings.

Action call-up

Leaving an empty conditional field is equal to setting it to "true".

Action location

Conditional execution parameter action

Action call-up condition

Form/acceptance button

Activates/deactivates the action call after pressing the button

Pressing the button (works only until the first comment is added using the window displayed)

Configuration parameters
Parameter name From version 

Description

Paremeter type 

Default value

Field type

Comments and restrictions

Attach*1.0.3Attach the generated document to the process.LogicalNoNon-editable dropdown list 

Format

1.0.3

The file format in which the document will be generated.

Text

PDF

Non-editable dropdown list

Values to choose from: PDF, DOCX

Preview

1.0.3

It allows the user to preview a document after it has been generated

Logical

 

Editable field

 

Message

1.0.3

Message displayed when generating the document. If the show parameter is set to true this parameter is not used.

Text

 

Editable field

 

Document class

1.0.3

The name of the document class to which the generated document will be added. Note - the parameter must contain the original name of the document class as the translations are not supported.

Text

 

Editable dropdown list

Values to choose from: <names of document classes available in the system>

You can enter your own name, but if the component does not find a class in the system it will show an error message.

Template source*1.0.82
Specifies where the template for generating the document will be downloaded from.
TextTemplate from processNon-editable dropdown list

Values to choose from:

Display valueForwarded value
Template from processPROCESS_TEMPLATE 
Template from document attached to processPROCESS_ATTACHED_DOCUMENT_TEMPLATE
Document template class name1.0.82
The parameter appears if you selected "Template from a document connected to the process" in the "Template source" parameter. 
Specifies the class from which the document will be downloaded - the template. If there are several documents, the application will throw an error.
Text Editable field 

Template*

1.0.3

The name of the template of the generated document. The template should be attached to the process in which we use the automatic task. The method of adding the template has been described here(1.1.3)

Text

 

Editable field

If it does not find a template in the system, the component will show error message.

New version*

1.0.3

Saves the document attached to the process as a new version. It works only when exactly one document from the same class is attached to the process with the same indexes.

Logical

No

Non-editable dropdown list

 

Document name

1.0.24

Allows you to enter your own name of the generated document. If this parameter is not completed the system will generate the name itself.

Text

 

Editable field

If "/" or "\" is found in the name, the component will show error message.

Mapping keys

1.0.3

The keys from the template that we want to map to the appropriate values given in "Mapping Values". E.g. for the values in the template: "@ name @" enter the key "name"

Table of text values

 

Editable field

 

Mapping values

1.0.3

Values that we save or with which we overwrite the variables declared in the template

Table of text values

 

Editable field

 

Document placement

1.0.50

Specifies where to place the document - in the archive in the process or nowhere (then only displays the document for preview)

Text

Archive

Editable dropdown list

 

Parameter*- mandatory field

Configuration example

 Example 1
Example

Let our need be to generate an invoice using values taken from the Plusworkflow system.

Document template preparation

To do this you need to prepare a template that will be placed in our invoice process. A detailed description of building a template can be found on DOCX Template page for generating PDFvand in this example we will use the following document:

 

We have to deal with a simple invoice where we have to complete the invoice identifier, name of the customer to whom we issue the invoice, net amount, gross amount, name and surname of the person issuing the invoice.

The template is saved to the disk.

Automatic task addition and configuration

Then, on the process map we add an automatic task that will generate the document at the right time. We choose the tab "Documents" and then "Generating a document from a template".

Empty configuration of the component is as follows:

 

We will now step by step walkthrough all of the configuration parameters of the component.

  • Format - our choice is limited to PDF and DOCX and in our example we assume that we want to get a PDF document. We leave the initial value.
  • Document class - we must select the class of documents responsible for invoices in our system. In this example, this is the "Invoices" class.
  • Template - the name of the template on the basis of which the document will be created. So far, we have not added it yet to the process so we have a free hand in choosing the name. In the example template was named "invoice_suncode".
  • Attach - The template determines whether we want our document to be included in the process. Set to "Yes"
  • New version - If a new version of the document with the same name appears, we want to overwrite the old version of the document instead of adding a new one. Set to "Yes".
  • Document name - In this example, we want to influence how the invoice document will be named. We want the new invoices to be called "invoice_suncode_1", "invoice_suncode_2", "invoice_suncode_3", etc., where 1, 2 and 3 are invoice IDs. To do this, we will use the concat function - which links the given character strings with each other. The first part of the string will be the phrase "invoice_suncode_", and the next value from the variable "Invoice Id". Finally, the concat function should look like this:

  • The next step is to properly set the mappings that we have prepared in the document template.
    - Invoice ID and customer name are saved on the form in the appropriate variables. Mapping works without any problems:
     
    - The net and the gross amount appears on the form as floating point values. If you want to enter them into the parameter you must replace them with a string. We can solve this problem using the toString () function which will convert numbers into text.  

    - The last value to be set is the Issuer. In the template, we can see an unusual construction for this mapping: 

    This is due to the fact that in this particular case we want to download the user's login form, and the template generator is tasked to replace it with the name and surname of the person. This result is obtained using "@ fullname # <user login> @", where in the place <user login> enter the mapping from the component configuration. In our case mapping is named invoice_issuer_login, so the configuration will be as follows: 

In result our configuration should look like this:

We save this configuration, connect the automatic task with other fields on the process map and then we export the process.

Adding a template to the process

Now that the process has been exported to the system we can start adding the template. Go to the Administration -> Document flow -> Processes tab.

In the list of available processes we search for a process in which we placed our automated task. We click on the "Edit" button next to the process name.

In the new view go to the "Document templates" tab.

We click on the "New template" button. We fill in the values in a new window giving the name from the configuration and the path under which we saved the template file.

We press "Add template". Done.

Automatic task call-up

All steps necessary to use the automatic task have been completed. Time to start the process and save the values in the appropriate fields.

 

After filling the fields we go to the automatic task that will generate the document. In this case we will receive a document called invoice_suncode_001.pdf which will be attached to the process. The body of the document should look like this:

Change log

1.0.3

  • Adding a component

1.0.11

  • Adding the parameters "Mapping keys" and "Mapping values"

1.0.23

  • Changing the section from "General" to "Documents"

1.0.24

  • Adding the "Document name" parameter 

1.0.33

  • Changing the name from "Generating a document" to "Generating a document from a template"

1.0.43

  • Update of the dynamic form
  • Removal of the option of placing actions under the acceptance button

1.0.50 (applicable documentation)

  • Adding the "Document placement" parameter

1.0.82 (applicable documentation)

  • Adding "Template source" parameter

  • No labels
Write a comment…