Batch document generation

Use a published Document Builder template to create PDF documents for a group of Salesforce records. Each document uses data from its source record.

A Batch Definition stores the template, record selection, and output settings. A Batch Run records one execution of that definition. This procedure attaches the generated documents to the Batch Run.

Before you start

• Confirm that iDialogue is installed and connected. See Install and configure iDialogue.
• Confirm that you can create Batch Definitions and read the source records.
• Identify the Salesforce object for the documents, such as Account or Opportunity.

1. Open iDialogue Content

1. In Salesforce, open the App Launcher.
2. Select iDialogue Content.

2. Create and publish the template

1. Open the Document Builder tab.
2. Create a new template for the source object. Configure its content and record data.
3. Select Publish Template.

Use a Data Merge Template for documents that contain Salesforce record data. Keep the template active. The published template must use the same source object as the batch.

The required action is Publish Template. Template export is not necessary for this procedure.

3. Create the Batch Definition

1. In iDialogue Content, open the Batch Definitions tab.
2. Select New.
3. Enter a descriptive name, such as Account Batch Letter Creation.
4. Complete the required fields.
5. Select Save.
6. Open the AI Assistant tab on the new record.
7. If the Create Default AI Agent button appears, select it.
8. Ask the Batch Definition Agent to configure the batch.

Use the prompt below. Replace the text in brackets with your values.

Help me configure this Batch Definition for document generation.
Use the published template [template name].
Use records from [object API name] that meet these conditions: [record selection criteria].
Set Query Limit to 5 for the first test.
Set Batch Size to 1.
Attach the PDF documents to the Batch Run results.
Show me the settings for approval before you save them.

9. Review the proposed settings.
10. Give the assistant any missing information.
11. When the settings are correct, select Approve configuration in the assistant.

The screenshot shows an example with a Query Limit of 20.

4. Check the settings and select the template

1. Open the Details tab.
2. Select Edit if changes are necessary.
3. Check the settings in this table.

Query Limit sets the maximum number of source records for the run. Batch Size sets the number of records in each processing group.

Use Query Limit to control the test quantity. Do not add a LIMIT clause to Query.

4. If you changed the settings, select Save.
5. In Batch Definition Template Selection, select Experience Templates.
6. Select the template that you published in Document Builder.
7. Select Next to save the template selection.
8. Review the confirmation.
9. Select Finish.

This selection sets the document output to PDF.

The screenshot shows a Query Limit of 20. Use 3 to 10 for the first test.

5. Preview the batch

1. Select Preview Batch Run.
2. On Preview Batch Process, check the Errors row.
3. If an error appears, correct the Batch Definition or template.
4. Open Preview Batch Run again after each correction.
5. Confirm that Errors shows (None).
6. Check the source object, query, Query Limit, and document template title.

The preview checks the batch settings. Document generation errors can still occur during the run.

The preview must show your test Query Limit. The example above shows 20.

6. Start the batch and review the documents

1. Select Looks good. Start the batch once.
2. Wait for the batch start message.
3. Open the Batch Run link in that message.
4. Refresh the Batch Run page at intervals as documents appear.
5. Open the attached PDF documents.
6. Check their content, record data, and layout.

The batch runs in the background. Document generation can take several minutes. The Batch Run page contains the document attachments.

After the test documents are correct, increase Query Limit to the required quantity. Preview the settings again before you start the larger batch.

Correct common problems

If the problem continues, submit a support request. Include the Batch Run ID and the error message.