¶ Configuration
¶ Setup Assistant
Now that licenses and permissions are managed on Salesforce, we can discuss settings in the Maven Documents application.
In the App Launcher on Salesforce, find and open Maven Documents. There, you'll find the Setup Assistant tab, which contains all the settings you need to work with the application.
The tab is visible only for users with the Maven Documents Administrator permission set assigned.
To try out Maven Documents, you must have a valid Microsoft or Google user account and a connected email address.
Follow the link to check an offer in the Microsoft Store.
Or send your Microsoft or Google account email to contact@mavenmule.com, and we will provide you with a temporary subscription ID. You need to enter it in the Maven Headless Settings during the setup process.
The tab is divided into 3 sections:
Sections are collapsed by default, but once you click them, the content becomes visible.
¶ Maven Headless Configuration
This set of settings is the first step and the foundation for configuring Maven Headless. Here, you provide the Doctavian Product Subscription, define the API version, set up the Maven Headless Connected App, and add some extra System Permissions.
-
Enter the Doctavian Subscription Id. You provide this value to prove the Doctavian product subscription. The subscription is vital for Maven Documents to function if you work with Microsoft or Google templates.
You get the Doctavian Subscription Id from Maven Mule. Contact your administrators to determine the required value.
a. Click the Open Application Settings button. The Application Settings page from the respective Custom Metadata Types section is opened in a new browser tab.
b. Click Edit. The fields’ content becomes editable.
c. In the Doctavian Subscription Id field, enter the needed value.
-
Enter the API version. This value identifies the API version of the environment you are calling and allows you to access it.
For each Maven Documents package version, check compatible Doctavian API version in release notes
In the API Version field, type the required version. At the moment, this is always v1.
After the step is finished, you can go to Salesforce Setup and check the list of Maven Documents' permission sets. The Maven Documents Extended permission set is created and assigned to the Admin user who conducted this setup through Setup Assistant.
This permission set grants access to the security and communication API prerequisites required for document generation. Due to Salesforce constraints, these permissions cannot be included in the default permission sets you get with the package.
Once the Admin user gets the Extended permissions, they need to assign those to the users who will work with Maven Documents. -
Grant Access. With this procedure, you are allowing the Maven Headless application to interact with your Salesforce org.
a. Click the Grant Access button.
b. Click Allow.
-
Install the Headless Connected App.
After you've granted access in the previous step, you can install and set up the Maven Headless application.
a. Click the Open Salesforce Setup button. The Connected Apps settings page opens in a browser tab.
b. Click Install and confirm the choice by clicking Install one more time on the dialog screen.
c. In the opened Connected App Detail settings, click Edit Policies and change the value in the Permitted Users field to Admin-approved users are pre-authorized.
d. In the Session Policies section, mark the Set app-specific token timeout checkbox and define the value of at least 2 hours.
e. Save changes and close the browser tab.
The timeout value specified here also affects the duration of your Add-in / Add-on session. After the specified timeout, you will need to log in to Salesforce again when using the Maven Add-in and the Maven Add-on.
-
Add System Permissions to the Maven Documents Extended Permission Set. This setting ensures users with Extended Permissions won't experience app issues, regardless of their Salesforce Profile.
a. Click the Open Extended Permission Set button. The Maven Documents Extended System Settings page opens in a new browser tab.
b. Click Edit. The list of System Permissions becomes editable.
c. Mark the API Enabled and Apex REST Services checkboxes.
d. Save changes and close the browser tab.
¶ Maven Headless Browser Login Flow
Also known as the Authorization Code Grant flow. It lets the Maven Headless app securely access the Document Generation service on behalf of a user without seeing their password.
-
Create Named Credentials. With this step, you are creating Named Credentials that allow Maven Documents to do callouts to the Maven Headless app.
a. Click the Create Named Credentials button.
b. Wait for the app to create credentials in the background. -
Enable Callouts. This step enables Maven Documents to do callouts to the Maven Headless app.
a. Click the Open Named Credentials button. The Named Credentials settings page opens in a new browser tab.
b. Click Edit and switch on the Enable for Callouts toggle.
c. Add the mmdoc namespace in the Allowed Namespaces for Callouts field.
d. Save changes and close the browser tab.
If you are installing Maven Documents into the Org that already has an application with Maven Headless configured, then in Named Credentials, you need to add the Maven Documents application namespace alongside the existing one and separate it with a comma.
¶ Authentication
Once you enable Named Credentials for callouts, you'll need to authenticate your Microsoft or Google account.
There are two ways of authentication possible on Salesforce:
Named Principal.Per User Principal.
Named Principal authentication enables the admin to authenticate with the "named account" credentials. In that way, it enables all users to use the same account when generating documents.
-
In Salesforce Setup, go to Named Credentials and select the External Credentials tab.
-
Open the Maven Headless credentials.
-
In the Principals section, click the dropdown arrow in the Action column next to Maven Service Principal and select Authenticate.
Per User Principal authentication enables each user to use their credentials when generating documents. Per User Principal authentication is administered on the User Settings page.
-
Click on your profile avatar and select Settings.
-
In the External Credentials section, click Allow Access in the Maven Headless card.
-
Enter your Microsoft or Google Credentials and then confirm external access.
After the steps are completed, access is configured.
Named Principal authentication allows individual users to authenticate with their own credentials.
Salesforce checks Principals in ascending Sequence Number order and uses the first that is authenticated. In this way, users utilize their credentials.
You can use the common account for all users or use a combination of the two.
With all the steps accomplished, Maven Headless is set and ready for work.
When testing Maven Documents in the Sandbox Org after Sandbox is refreshed, this entire setup is taken from Production environment and it will not work on Sandbox. Check out the following article to reconfigure your headless configuration.
¶ Application Settings
This section provides the configuration of certain parts of the application. Some settings here are set to default values, so icons next to them are marked in green. You can find values by clicking the respective buttons.
¶ Batch Settings
Maven Documents allows generation of the large number of documents using Apex Batch. Apex Batch in Salesforce is used to run large jobs that would exceed normal processing limits. Using Apex Batch, we can process records asynchronously to stay within platform limits.
Click the Edit Batch Settings button to see what batch parameters are available:
- Batch Frequency (minutes). Number of minutes after which the batch is executed.
- Batch Size. The number of documents that are generated in one batch execution.
- Batch Error Retry Limit. The number that shows how many times a batch tries to process the same Document Request in the case of an error.
At the bottom of the card, you can see the following buttons:
- Run Batch. Starts the execution of the document generation batch.
- Stop Batch. Stops the execution of the document generation batch. The button is active only if batch execution has begun.
- Cancel. Closes the window with Batch Settings.
Here's how to change default parameters:
-
Click on the message at the bottom of Batch Settings. The Application Settings page from the respective Custom Metadata Types section is opened in a new browser tab.
-
Click Edit. The fields on the page become editable.
-
In the Batch Settings section, set the needed values in the respective fields.
-
Save changes and close the tab.
Now, when you go back to Setup Assistant and refresh the page, Batch Settings will have new values.
¶ Edit Notification User
This setting allows you to select a user who receives a notification email from Salesforce if limits on Document Requests are reached. This setting doesn't have any default value, so it's on you to provide one.
-
Click the Edit Notification User button. The Application Settings page from the respective "Custom Metadata Types" section is open in the new browser tab.
-
Click Edit. The fields on the page become editable.
-
In the General Settings section, populate the Notification User Id field with the ID of the needed user.
-
Save changes and close the tab.
The defined user has to be active. You can't select more than one user in that field.
¶ Schedule Request Deletion
Every document generated with Maven Documents creates a new Document Request and Action Request record. These records store information required to generate the document and complete the post-generation action.
As you will be generating documents, there could be lots of records in the Document and Action Request objects. You can easily delete old requests, either manually or by setting up the automatic deletion process.
The Deletion of old Document/Action Requests settings are right there to help you. Here are the options you have:
- Delete Now. Immediately delete all Document and Action Request records older than the provided number of days.
- Schedule Deletion. Schedules a job that deletes all Document and Action Requests older than the provided number of days. The job is executed daily.
To change the default number of days, follow the steps:
-
Click on the message at the bottom of Deletion Settings. The Application Settings page from the respective Custom Metadata Types section is opened in a new browser tab.
-
Click Edit. The fields on the page become editable.
-
In the Document Request Deletion Settings section, define the number of days in the respective field.
-
Save changes and close the tab.
Now, when you go back to Setup Assistant and refresh the page, the Deletion of old Document/Action Requests setting will have a new value.
Keep in mind that you can't delete Document Requests created in the current GMT month. So when you click Delete Now with the selected number of days, only Document Requests from the past months are removed.