¶ Document Request, Action Request, and Consumption
When you click Generate Document, you expect a new file on Salesforce to show the data you fetched. Besides the file, the generation process creates new records:
¶ Document Requests
This record is crucial for document creation and is the main part of the entire application. It's always created when document generation starts.
¶ Creating Document Requests
Document Requests are created by inserting them into the database. Just like every object in the Salesforce system, there are different ways of inserting Document Requests:
- Create the Document Request record manually in the respective tab in Maven Documents.
- Use Flows.
- Use Apex Code.
- Use buttons.
The status of a Document Request record reflects the status of the generation process. You can check the status of document generation by checking the Status__c field on requests:
New. The processing has not yet started.Processing. The request is being generated.Completed. The document has been generated and is available in whatever format and location you specify.Error. Document Generation ended up in an error.
The error message is available in the Error_Message__c field elaborating on what went wrong.Cancelled. The processing was cancelled.
The newly created Document Request can only have the New status.
¶ Fields
The fields displayed in the created Document Request may vary depending on the Document Template used.
Here is the list of all fields that the Document Request record contains:
| Field API Name | Values / Type | Description |
|---|---|---|
Name |
Auto Number |
The Document Request number. Automatically assigned by the app. |
OwnerId |
Lookup(User,Group) |
Lookup to the owner of the record. |
Record_Id__c |
Text |
ID of the record that document generation started from. |
Status__c |
New, Processing, Completed, Error, Cancelled |
Current status of the record. |
Document |
Lookup |
Lookup to the Document Template record that this Document Request is using. |
Document |
Lookup |
Lookup to the Document Solution record that this Document Request is using. |
Document |
Text |
The title of the generated document. |
Document |
PDF, DOCX, GDOC, GSHEET, XLSX, CSV, PPTX |
The format of the generated document. |
Save |
Salesforce File, Salesforce Attachment, GoogleDrive, OneDrive |
How the generated document should be saved. |
Processing |
Queue, Batch, Synchronously |
How the record is processed. |
Error |
Long Text Area |
Descriptive text containing an error message if such an error occurred. |
Reuse_File |
Checkbox |
If checked, the Content Version is linked to the existing Content Document. Otherwise, a new Content Document is created. |
Network |
Text |
Salesforce Community/Network ID that is applied to the Salesforce File. |
Share_ |
Long Text Area |
Comma-separated values of users' emails, that have the Edit permissions to the generated document. |
Create_ |
Checkbox |
If checked, the link to the generated file on a Drive with Edit permissions is created. |
Create_ |
Checkbox |
If checked, the link to the generated file on a Drive with View permissions is created. |
Share_ |
Long Text Area |
Comma-separated values of users' emails, that have the View permissions to the generated document. |
Create_ |
Checkbox |
If checked, the link to the generated file with Edit permissions, available only to the Organization members, is created on a Drive. |
Create_ |
Checkbox |
If checked, the link to the generated file with View permissions, available only to the Organization members, is created on a Drive. |
PDF_Conformance_Level__c |
PdfA1a, PdfA1b, PdfA2a, PdfA2b, PdfA2u, PdfA3a, PdfA3b, PdfA3u |
Levels of conformance for PDF documents. |
PDF_Version__c |
PDF_1_0, PDF_1_1, PDF_1_2, PDF_1_3, PDF_1_4, PDF_1_5, PDF_1_6, PDF_1_7, PDF_1_8, PDF_2_0 |
The version of the PDF specification to which the PDF document conforms. |
Embedded_Data__c |
Long Text Area |
JSON that should be embedded in the document. |
Language__c |
Text |
Defines the language of the Template Label. |
Locale__c |
Text Area |
Defines the Locale in which data is shown in the generated document. |
Folder_Path__c |
Long Text Area |
Defines the destination point of the generated document on Drive. |
External |
Text |
The ID of the generated document in the external system (e.g. Google Drive). |
External |
Text |
Name of the generated document in the external system (e.g. Google Drive). |
File |
Text |
Salesforce File or Attachment ID. |
External_ |
Long Text Area |
The URL of the generated document in the external system (e.g. Google Drive). |
External_ |
Long Text Area |
The URL of the generated document with the Edit access to the defined users on a Drive. |
External_ |
Long Text Area |
The URL of the generated document with the Edit access on a Drive. |
Failed_ |
Long Text Area |
Comma-separated list of email addresses of users for whom document sharing failed. |
External_ |
Long Text Area |
The URL of the generated document with the View access on OneDrive. |
External_ |
Long Text Area |
The URL of the generated document with the View access to the defined users on OneDrive. |
External_ |
Long Text Area |
The URL of the generated document with the Edit access on a Drive, available only to the organization members. |
Failed_ |
Long Text Area |
Comma-separated list of email addresses of users for whom document sharing failed. |
External_ |
Long Text Area |
The URL of the generated document with the View access on a Drive, available only to the organization members. |
LastModifiedById |
Lookup |
Lookup to the user who last edited the record. Includes the date and time of the last edit. |
CreatedById |
Lookup |
Lookup to the user who created the record. Includes the creation date and time. |
The Batch Processing Type is an exception. It needs to be run separately to start generation.
So what do all these fields allow us to achieve? They offer more options when generating documents and allow users to customize the generated document to achieve the needed result. For example, the Document Format field allows the user to choose between options for saving the resulting document. The Save As field allows users to decide where the created document resides: in Salesforce as a File or Attachment, or just on the Google Drive of the organization.
When creating a Document Request manually, you are not limited by the options in Button Configuration. For example, you can have the Format option set to PDF in Button Configuration. However, in Document Request, you can choose from all possible options in Maven Documents.
¶ Fields Extra Capabilities
¶ Name the generated file according to your needs
In the Document Title field, you can write the name that the generated file would have. It may vary from the name of the template.
If the field is left empty, the generated file will have the same name as the template document used.
¶ Set the level of access to the generated file
Using these fields, you can tailor access to the generated file according to your preferences and security policies.
| Field | Shared with | Azure templates preview | Google templates preview |
|---|---|---|---|
| Create Shareable Edit Link | Anyone with the link can edit | In the Salesforce pop-up window | In the Salesforce pop-up window |
| Create Shareable View Link | Anyone with the link can view | In the Salesforce pop-up window | In the Salesforce pop-up window |
| Create Organization Edit Link | People within your Organization domain can edit | On OneDrive | In the Salesforce pop-up window |
| Create Organization View Link | People within your Organization domain can view | On OneDrive | In the Salesforce pop-up window |
| Share User Edit List | Only specified users can edit; other users don't have document access | On OneDrive | In the Salesforce pop-up window |
| Share User View List | Only specified users can view; other users don't have document access | On OneDrive | In the Salesforce pop-up window |
¶ Embed additional data
If you would like to store extra JSON metadata inside the generated file, you can use the Embedded Data field. Place the JSON snippet inside the text frame of the field and save the Document Request.
The structure of the embedded JSON is vital. For each top-level attribute in the JSON snippet, we create one PDF custom field with the same name. The value of the field is the content of the respective JSON attribute.
Once the request is processed, the document is generated. Now, you can download this file to your device and open it with a specified app. Check document properties to have the embedded metadata in place.
For example, you would like to add issuer details, information about the document's validity, and the unique document ID. Compose JSON with that information and paste its content into the Embedded Data field.
{
"issuer":{
"id": "issuerId",
"type": "issuerType",
"location": {
"address": {
"countryCode": "Code of the country",
"fullAddress": {"City": "issuer city",
"street": "issuer street",
"building": "issuer building"}
}
}
},
"validFrom": "01.02.2025.",
"validUntil": "01.03.2025",
"DocumentId": "The ID value of the document"
}
After the document is generated and opened, here is how the metadata looks in the document properties:
This feature is available for PDF and DOCX file formats.
¶ Set characteristics of the generated PDF file
-
In the PDF Conformance level field, enter the value that represents the needed level.
These levels establish clear rules and standards for PDF files. They ensure that files are self-contained, compatible across all devices, and suitable for long-term preservation. The standards address elements such as fonts, color spaces, metadata, transparency, and other aspects of PDF creation and archiving. The goal is to guarantee consistent appearance and functionality, regardless of the system or software used to view the files.If you leave the field untouched, the PDFA3a level is applied by default.
-
The PDF Version field defines the version of the PDF specification to which the PDF document conforms. In this field, put the value that represents the needed version.
If you leave the field untouched, the PDF_1_7 version will be applied by default.
¶ Translate the defined document elements
Maven Documents offers the ability to translate specific elements of the template. You can achieve it with the Template Labels feature. More information on how to use it can be found on the corresponding page.
In the Language field on the Document Request, you can determine the needed language value from the "emplate Label record. Once the request is completed, the generated file contains the translated labels in the selected language.
¶ Specify which country’s format is used to display the data in the generated document
The Locale field enables the formatting of data—such as currency, numbers, dates, and times—in the generated document according to the standards of the specified country's locale. If no locale is specified, the system defaults to using the current user's locale settings. Here you can find more information on how to use the field. In most cases, the user's locale should be used to generate the document, so this field can be left empty.
¶ Define the destination folder
If you would like to place the generated document in a specific folder on Drive, you can define the path in the Folder Path field. You can check the Document Templates page to get more information on how to fulfill the field according to different template types.
In this field, you can use the ID of the needed folder on Drive or manually write the path to the destination folder with string values. You can also use merge fields to name the folders. In that case, after the generation process is over, the folder on OneDrive will have the name of the value from the used merge field.
ID of the folder can only be used for Google Templates and only at the beginning of the path. If you place it in the second position or later, the value is interpreted as a string, and the folder will be named after the ID value.
If the field is left empty, the generated file appears in the same folder as the template document.
Google imposes a limit: the maximum number of Document Requests processed in parallel within the last 15 minutes is 2 for Sandbox Orgs and 10 for Production Orgs.
These values count towards the limit:
- Status: New or Processing.
- Processing Type: Queue or Synchronously.
For example, if you currently have 9 Document Request records with the Processing status, and 1 with the New status, you would have to wait until some of your documents have finished generating or for 15 minutes. You can create a new request only after one of these conditions is met.
¶ Mass Document Generation
There is a way to create more document requests than the limit. To do that, you can use the Batch feature from the Setup Assistant tab.
- When creating a Document Request, specify its Processing Type as Batch.
- Fill in the other fields and save the request.
- Go to Setup Assistant and set Batch settings. You can change the number of documents to be generated, the number of batches to run, and the frequency of generation.
- Save the settings and click Run Batch.
After running the batch, stop it by clicking the Stop Batch button, which is only available while the generation process is running. The generation process may take a while. After that, the generated documents are available in the attachments section of every record where the document was generated.
¶ Action Requests
There's also the Action Requests related list on the corresponding Document Request. The list holds the records of the executed Actions, showing their status.
The order in which Action Request appears in the list is determined by the Order Of Execution field on the Action Object.
The Generate Document Action is executed first, despite the set order. The only exception is when inserting Action Requests using the code, where you can arrange the order differently.
If you have the Before or After Merge preview configured, the Copy Document Action is executed by default and listed among Action Requests.
After clicking on each Action Request, the associated record opens, displaying the corresponding data.
The content of the Action Request record depends on the action type.
Fields between the Details and System Information sections differ, depending on the selected Action. In the Input section, you can see the values that you've put in when creating the action. The Output section shows you the result values of the needed action.
In our example, you can see the Generate Document Action, which is always created by default when the document generation process takes place:
- The Input section displays the data that was selected during the template selection process.
- The Output section shows you the result of the generation process: ID, Name, and URL of the created external file, and ID of the file on Salesforce.
¶ Fields
Depending on the type of action, the set of fields on the Action Request may vary. Most of those fields are taken from the connected Document Request.
However, some fields are specific to the Action Request record:
| Field API Name | Values / Type | Description |
|---|---|---|
Name |
Auto Number |
The Action Request number. Automatically assigned by the app. |
Document_Request__c |
Lookup |
Lookup to the connected Document Request record. |
Mandatory_Action__c |
Checkbox |
Signifies if the action is mandatory or not. |
Record_Type__c |
Record Type |
The type of the action the record stands for. |
Action__c |
Lookup |
Lookup to the corresponding action. |
Operation |
Text |
The ID of the respective operation in the Headless app. |
Other fields on a record duplicate fields and content from the connected Action record.
¶ Creating Action Requests
There are two ways of creating an Action Request:
- It is created automatically when you start the template generation process or trigger a Document Request that includes a Document Solution with associated Actions.
- You can insert an Action Request by using code via the Developer Console.
Since using code is too technical and too advanced, let's focus on the first option.
First, note that the number of Action Requests associated with a Document Request corresponds to the number of Actions defined in its linked Document Solution. For example, if that Solution includes Delete Google File and Email Autosend actions, two separate Action Requests are created.
It means there should be three Action Requests related to the created Document Request:
- The Generate Document Action Request.
- The Delete Google File Action Request.
- The Email Autosend Action Request.
¶ Mandatory Actions
In the Actions section, we mentioned the Mandatory Action checkbox. This checkbox affects the overall status of the Document Request. If you have multiple actions on Document Solution and one of them, marked as Mandatory, fails during document generation, the entire Document Request is marked as an Error. Actions scheduled to follow the failed one are marked as Cancelled, while those executed beforehand are marked as Completed.
If the Mandatory Action checkbox is not marked, a failure in that specific action doesn't impact the Document Request status or the statuses of the subsequent Action Requests.
¶ Consumption
Each Document Request also includes a consumption-related list. It contains records with statistical data about the generated documents.
The data you see in the Consumption records depends on whether the After Merge preview is set or not.
Depending on the type of template document, different dimensions are evaluated for:
¶ DOCX and Google Docs documents
When the DOCX or Google Docs file is generated successfully without the After Merge preview, the documents-generated Consumption record is created:
The documents-generated value depends on the number of pages in the output document.
For example, the definition of 1 document is set to 25 generated pages. In this case:
- From 1 to 25 pages = 1 document
- From 26-50 pages = 2 documents
- From 51 to 75 pages = 3 documents
- etc.
The definition of the generated document in the Consumption record can be unique for each customer. Contact your administrator for more information.
If you have the After Merge preview enabled, the documents-managed Consumption record is also created when the generation is complete:
In this situation, the documents-generated value is based on the number of pages in the document that initially appear in the After Merge preview before any changes are made.
If you click Cancel in the After Merge preview, the generation process is stopped. However, the documents-generated record is still created because the generation was run to show the file in the preview.
The documents-managed value comes from the number of pages in the document processed in the After Merge preview.
For example, the definition of 1 document is set to 25 managed pages. In this case:
- From 1 to 25 pages = 1 document
- From 26-50 pages = 2 documents
- From 51 to 75 pages = 3 documents
- etc.
Let’s say you start the generation process and get the document of 25 pages in the After Merge preview. If you finish the generation without any changes to the document, the Consumption records will show you that you have 1 document generated and 1 document managed.
When the number of pages in the document from the After Merge preview changes, it can influence the value in the documents-managed record.
For example, you make changes to the document in the After Merge, and increase the number of pages to 65. In this case, when you finish the generation, the documents-managed record will have the value of 3 documents because the number of managed pages is greater than 50 but less than 75.
If the number of pages in the After Merge preview changes, it impacts only the documents-managed values. The generated record remains as it reflects the state of the initial document.
The definition of the managed document in the Consumption record can be unique for each customer. Contact your administrator for more information.
¶ XLSX and Google Sheets documents
When the XLSX or Google Sheets file is generated successfully without the After Merge preview, the spreadsheets-generated Consumption record is created:
The spreadsheets-generated value depends on the number of cells involved in the generation process and the definition of the "spreadsheet".
The number of sheets in the spreadsheet doesn't influence the spreadsheets-generated value.
For example, the definition of 1 spreadsheet is 10 cells involved in the generation process. In this case:
- From 1 to 10 cells = 1 spreadsheet
- From 11-20 cells = 2 spreadsheets
- From 21 to 30 cells = 3 spreadsheets
- etc.
The number of cells involved is calculated by taking the range from the A1 cell to the last cell with data.
In the example below, the range is A1:B3, so the number of generated cells is 2 × 3 = 6.
In this case, once the generation is finished, the spreadsheets-generated value is 1 spreadsheet.
The amount of generated spreadsheets in the Consumption record can be unique for each customer. Contact your administrator for more information.
The spreadsheets-managed value depends on the number of cells processed in the After Merge preview and the definition of the "spreadsheet".
The number of sheets in the spreadsheet doesn't influence the spreadsheets-generated value.
For example, the definition of 1 spreadsheet is 10 cells involved in the process. In this case:
- From 1 to 10 cells = 1 spreadsheet
- From 11-20 cells = 2 spreadsheets
- From 21 to 30 cells = 3 spreadsheets
- etc.
The number of cells involved is calculated by taking the range from the A1 cell to the last cell with data.
In the example below, the range is A1:B3, so the number of processed cells is 2 × 3 = 6.
If you finish the generation of such a spreadsheet without any changes to it, the Counsumption records will show you that you have 1 spreadsheet generated and 1 spreadsheet managed. In this situation, the spreadsheets-generated value is based on the number of processed cells in the spreadsheet that initially appear in the After Merge preview before any changes are made.
When the number of processed cells in the spreadsheet from the After Merge preview changes, it can influence the value in the spreadsheets-managed record.
For example, you do changes to the spreadsheet in the After Merge, and increase the amount of processed cells to 25. In this case, when you finish the generation, the spreadsheets-managed record will have the value of 3 spreadsheets because the number of managed cells is greater than 20 but less than 30.
If the number of processed cells in the After Merge preview changes, it impacts only the spreadsheets-managed value. The spreadsheets-generated record remains unchanged, as it reflects the state of the original document.
The amount of managed spreadsheets in the Consumption record can be unique for each customer. Contact your administrator for more information.
¶ PPTX documents
When the PPTX file is generated successfully without the After Merge preview, the presentations-generated Consumption record is created:
The presentations-generated number depends on the number of slides in the output document.
For example, the definition of 1 presentation is set to 5 generated slides. In this case:
- From 1 to 5 slides = 1 presentation
- From 6-10 slides = 2 presentations
- From 11 to 15 slides = 3 presentations
- etc.
The definition of the generated presentation in the Consumption record can be unique for each customer. Contact your administrator for more information.
If you have the After Merge preview enabled, the presentations-managed Consumption record is also created when the generation is complete:
In this situation, the presentations-generated value is built from the number of slides in the presentation that initially appears in the After Merge preview before any changes are made.
If you click Cancel in the After Merge preview, the generation process is stopped. However, the presentations-generated record is still created because the generation was run to show the file in the preview.
The presentations-managed number is based on the number of slides in the presentation processed in the After Merge preview.
For example, the definition of 1 presentation is set to 5 generated slides. In this case:
- From 1 to 5 slides = 1 presentation
- From 6-10 slides = 2 presentations
- From 11 to 15 slides = 3 presentations
- etc.
Let's say you start the generation process and get the presentation of 5 slides in the After Merge preview. If you finish the generation without any changes to the document, the Counsumption records will show you that you have 1 presentation generated and 1 presentation managed.
When the number of slides in the presentation from the After Merge preview changes, it can influence the value in the presentation-managed record.
For example, you do changes to the presentation in the After Merge, and add 2 more slides. In this case, when you finish the generation, the presentations-managed record will have the value of 2 presentations because the number of managed slides is greater than 5 but less than 10.
If the number of slides in the After Merge preview changes, it impacts only the presentations-managed values. The generated record remains as it reflects the state of the initial document.
The definition of the managed presentation in the Consumption record can be unique for each customer. Contact your administrator for more information.