Generate Document (Batch)

Updated 2026-09-30·3 min read

Signature

global static void execute(
  List<GenerateDocumentBatch.FlowInput> inputs
)

Parameters

Parameter		Description
`inputs` List<GenerateDocumentBatch.FlowInput>	required	One entry per document group. Each FlowInput carries the documents to generate and the optional signing and packet settings for that group. See the field breakdown below.

FlowInput

Parameter		Description
`inputs` List<GenerateDocumentFlowInput>	required	The documents to generate in this group. Each entry describes one document.
`signingSettings` GenerateDocumentSigningSettings	optional	Combined-envelope signing options for this group. Leave empty for the default behavior (one envelope per document).
`packetSettings` GenerateDocumentPacketSettings	optional	Groups the documents in this group into a Document Packet. Leave empty for the default behavior (no packet is created).

GenerateDocumentFlowInput

Parameter		Description
`templateId` String	required	Id of the CloudFiles template to render.
`documentType` String	required	Output document type, for example 'docx' or 'pdf'.
`recordId` String	optional	Record Id the document is generated for.
`cloudFilesVariables` List<CloudFilesVariable>	optional	Merge variables for the template, each a key and value.
`destination` Resource	optional	Where the generated document is stored.
`params` DocGenParams	optional	Additional generation parameters such as PDF security and retention settings.

GenerateDocumentSigningSettings

Parameter		Description
`combineDocuments` Boolean	optional	When true, all documents in this group are sent for signature together as one DocuSign envelope. Signers receive a single email and the signed documents are delivered together.
`emailSubject` String	optional	Subject of the DocuSign envelope email. Defaults to the first document's template signing settings.
`emailMessage` String	optional	Message body of the DocuSign envelope email. Defaults to the first document's template signing settings.

GenerateDocumentPacketSettings

Parameter		Description
`enabled` Boolean	optional	When true, CloudFiles groups the documents in this group into a Document Packet, and a CloudFiles Document Packet record appears in the org. Leave empty or false for no packet.
`approvalRequired` Boolean	optional	Defaults to true, including when left empty. The packet stops at Requires Approval once every document is generated, and nothing is created on DocuSign until someone approves it from the record page. Set to false to send the packet as soon as generation finishes.

Return Type

void

Example

// Build one or more document inputs
cldfs.GenerateDocumentFlowInput docInput = new cldfs.GenerateDocumentFlowInput();
docInput.templateId = '681b4169c697ffdc2aab2731';
docInput.documentType = 'pdf';
docInput.recordId = '003dL00000YsapJQAR';
docInput.destination = new cldfs.Resource(
  '68887db5ef0b3ca7534dbbd5',
  'folder',
  null,
  'cloudfiles',
  'workspace'
);
docInput.params = new cldfs.DocGenParams();

// Optional: send the whole group as one DocuSign envelope
cldfs.GenerateDocumentSigningSettings signingSettings = new cldfs.GenerateDocumentSigningSettings();
signingSettings.combineDocuments = true;
signingSettings.emailSubject = 'Please sign your documents';

// Optional: group these documents into a Document Packet
cldfs.GenerateDocumentPacketSettings packetSettings = new cldfs.GenerateDocumentPacketSettings();
packetSettings.enabled = true;
packetSettings.approvalRequired = true;

cldfs.GenerateDocumentBatch.FlowInput input = new cldfs.GenerateDocumentBatch.FlowInput();
input.inputs = new List<cldfs.GenerateDocumentFlowInput>{ docInput };
input.signingSettings = signingSettings;
input.packetSettings = packetSettings;

cldfs.GenerateDocumentBatch.execute(
  new List<cldfs.GenerateDocumentBatch.FlowInput>{ input }
);

Combined-envelope signing & Batch Apex support

Each processed input publishes a Document Generated event; if generation or signing fails, an Error Event is published for that input.

Set combineDocuments = true on the signing settings to send every document in the group as a single DocuSign envelope, so signers get one email and sign everything in one session and the signed documents are delivered together. Leave the signing settings empty to keep the default behavior of one envelope per document.

The action runs asynchronously and can be invoked from Batch Apex or other asynchronous (future / queueable) contexts.

Generate Document

Generate Document (Sync)