Fill a document template from a workflow and download it

1. How do I pass a Script node’s output into the Template Filling node?
2. Why does the Template Filling node show no mapping options?
3. How do I build the download URL for the generated document?

​

How do I pass a Script node’s output into the Template Filling node?

1

Write the values from the Script node

Assign each value the template needs to a key on output:

// Script node placed before the Template Filling node
output.customer = {
  fullName: input.applicant.firstName + " " + input.applicant.lastName,
  contractNumber: input.contractNumber
};

Later nodes reference these values as ${customer.fullName} and ${customer.contractNumber}. For the expression rules, see Referencing workflow data in node configurations.

2

Declare the keys in the workflow data model

The data mapper in the Template Filling node lists the attributes of the workflow’s Data Model as its source, and a key the Script node writes isn’t offered until it’s declared there. Add the keys to the workflow data model with the same names and nesting (in this example, a customer object with fullName and contractNumber). See Workflow data models.

You can also declare a key from inside the mapper. In a template field, type the path, for example ${customer.fullName}, click Add new attribute, and save the Attribute Settings. The attribute is added to the workflow data model when you save the mapping.

3

Define the template's input parameters

The mapper fills only the template attributes selected as input parameters. Open the document template and:

1. On the Data Model tab, add an attribute for each value, for example fullName and contractNumber of type string.
2. On the Input Parameters tab, click Define parameters, select the attributes, and click Done.

In the template markup, insert each value with a Thymeleaf th:text attribute:

<p>Contract number: <strong th:text="${contractNumber}"></strong></p>
<p>Customer: <strong th:text="${fullName}"></strong></p>

A bare ${fullName} outside a th: attribute is printed as is in the generated document.

4

Add and configure the Template Filling node

Add Template Filling from the node palette after the Script node and set:

• Template: the document template to fill, from this project or one of its library dependencies
• Language: the template language
• Document Tag: the tag stored with the generated file, for example ContractTemplate
• Document format: PDF (default) or DOCX
• Response Key: the key that holds the generated file’s details, for example generatedContract

Template, Language, Document Tag, and Response Key are required.

5

Map the workflow attributes onto the template

Under Input Mapping, click the wrench icon (Configure mapping) on the Template Input card. In the Input Mapping window:

1. In the workflow panel on the left, click Define parameters, select the workflow attributes to map (for example customer), and click Done.
2. In the field next to each template attribute, type ${customer. and pick the suggested path, for example ${customer.fullName}.
3. Optionally, click Test to see the mapped output under Preview results.
4. Click Save.

The Template Input card then shows how many attributes are mapped, for example 2 mapped.

​

Template Filling nodes created before data mapping

• On: the node uses the data mapper (Configure mapping on the Template Input card). Values typed by hand are ignored.
• Off: under Template Variables, click Configure Variables and enter a value for each template variable, either fixed text or an expression such as ${customer.fullName}.

​

Why does the Template Filling node show no mapping options?

​

How do I build the download URL for the generated document?

https://{your-flowx-api-host}/document/ + downloadPath

​

What does the Template Filling node return?

{
  "generatedContract": {
    "customId": null,
    "fileId": "{fileId}",
    "documentType": "ContractTemplate",
    "documentLabel": "GENERATED_PDF",
    "filePath": "{storage-object-path}",
    "downloadPath": "internal/files/{fileId}/download",
    "originalFileName": "ContractTemplate.pdf",
    "noOfPages": 1,
    "error": null
  }
}

​

Build the URL in the workflow

var downloadPath = input.generatedContract.downloadPath;

if (downloadPath != null) {
  output.contractUrl = "https://{your-flowx-api-host}/document/" + downloadPath;
}

​

Build the URL in a process

• 5.9.x: see Generating documents for the request and reply, and Preview an uploaded file for the business rule.
• 5.1.x: see Generating documents and Creating and uploading a new document for the same business rule.

​

Related resources