GENERATE - GENERATE - The GENERATE action creates a new document from a template, stores the generated document in the repository, and makes it available as a process variable for use in subsequent workflow activities. - Content Innovation Cloud - Hyland Automate Modeler - Current/Hyland-Automate-Modeler/mnl1677147434526 - Current - Current

Hyland Automate Modeler

Platform
Content Innovation Cloud
Product
Hyland Automate Modeler
Release
Current
License
ft:lastPublication
2026-11-02T23:02:36.222215
ft:locale
en-US

The GENERATE action creates a new document from a template, stores the generated document in the repository, and makes it available as a process variable for use in subsequent workflow activities.

Use this action to generate documents such as contracts, invoices, reports, letters, and forms populated with process data.

The input parameters of the action are:

Parameter Type Required Description
formId String Optional ID of the form used to generate the document. If multiple submissions exist, the most recent submission is used.
template Content Required Template used to generate the document. The template must be stored as a file variable. For more information see Generate Document Task Template.
metadata JSON Optional Metadata supplied to the template for generating content using process variables.
outputFileName String Optional Name of the generated file. Example: onboarding-form.
outputFormat String Optional Output file format. Supported values are DOCX and PDF. The default value is PDF.
targetFileMetadata Content-Metadata Optional Metadata stored with the generated document. Uses JSON key-value pairs.
underscoreMetadata Boolean Optional Allows metadata namespace prefixes to use _ instead of :. For example, cm_title instead of cm:title.
targetFileType Content-Type Optional Content type assigned to the generated file. Example: fin:invoice.
targetFile Content Requires one Existing file variable that will be updated with the generated document.
targetFolder Content Requires one Folder variable where the generated document will be stored.
targetFolderId String Requires one Node ID of the destination folder.
targetFolderPath String Requires one Repository path of the destination folder.
Note: At least one destination option (targetFile, targetFolder, targetFolderId, or targetFolderPath) must be specified.The 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:

Parameter Type Required Description
file Content Optional Generated document that can be mapped to a process variable.