Generate document

The generate document connector is used to create DOCX and PDF files using a template. The generated document is then saved to the Content Services repository and can be reused throughout the process.

A generate document task is displayed as a stack of documents on the process diagram.

Create a generate document task

The generate document connector is stored in the palette separate from other connectors. To create a generate document task:

1. Sign into the Modeling Application and open a project and process.

2. Click the stack of documents in the tool palette.

3. The option to use an existing instance of the connector or create a new one will display.

   • Create a new instance if it is the first time using the generate document connector within the project and give it a name.

   • Select an existing instance if the generate document connector has already been used within the project.

4. Drag the task onto the diagram canvas and fill in the properties.

Note: The generate document connector does not have any configuration parameters as it connects directly to the Content Services repository. This means that only a single instance of the connector is required per project.

Properties

The generate document connector is implemented as a service task. All the properties available to a service task are those required by the generate document connector. The three most important ones to understand for the generate document connector are:

Generate

The GENERATE action is used to create a new document using a template, store it in the repository and create it as a variable for reuse within the process.

The input parameters to generate a document are:

Note: underscoreMetadata can be set to true and the targetFileMetadata input can still use : with the connector successfully executing the action. If underscoreMetadata is set to false and targetFileMetadata uses _ then the connector will fail to execute the action.

An example of the targetFileMetadata that can be stored with the document is:

{
"ahr:contract-type": "Full Time",
"ahr:full-name": "John Doe",
"ahr:role": "Developer"
}

The output parameters from generating a document are:

Template

A template is used to generate a document. Optional metadata can also be used with the template to insert values from process variables into the document template.

An example of the metadata that can be used by the template is:

{
"iceCream": {
    "flavor":"Mint"
    },
"timeOfYear": {
    "season":"Summer"
    }
}

An example of how the template can import values from the metadata is:

Current season: <<[timeOfYear.get("season")]>>
Flavor of the month: <<[iceCream.get("flavor")]>>

In the generated document this would display as:

Current season: Summer
Flavor of the month: Mint

Errors

The possible errors that can be handled by the generate document connector are: