| Info |
|---|
Pre-requisite. You need a system administrator profile to perform those steps. |
Package Installation Launch
...
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Installation
Install the IdealDoc Salesforce Package package into your Salesforce instance, click the link below and log into with your usual username and password.Current Version : 1.6.3-1
...
Environment |
|---|
Version
Link
Prod
IdealDoc Salesforce Version 2.3.0-1 | |
|---|---|
Production / Developer | https://login.salesforce.com/packaging/installPackage.apexp?p0= |
Sandbox |
1.6.3-1
https://test.salesforce.com/packaging/installPackage.apexp?p0= |
Package Installation
Once prompted, select "Install for Admins only" and "click Install".
...
On the next screen, tick the box and click continue.
...
Permission Sets Assignments
Assign Permission Sets to relevant users - Ideal Doc Admin Permissions (for System Administrator users)
Ideal Doc User Permissions (for regular users)
Custom Metadata Type record Creation
Now let's create a Custom Metadata Type Record for IdealDoc. This is mainly to enter your IdealDoc token, but also to make it possible to define certain general settings.
Go to the Setup menu
Search "Custom Metadata Type"
Find the record named "Ideal Doc Setting" and click on the "Manage" blue link
Now, we need to create an entry for Production and one for the Sandbox.
Production Record :
...
Field
...
Value
...
Comments
...
Label
...
IdealDoc Production
...
Ideal Doc Setting Name
...
prod
...
IdealDoc Config
...
{ }
...
You can enter here default settings applying to all your documents. More infos HERE.
...
Ideal Doc Customer Token
...
Your token is communicated by IdealTeam.Group
...
Ideal Doc Url
...
Sandbox Record :
...
Field
...
Value
...
Comments
...
Label
...
IdealDoc DEV (or name of your sandbox)
...
Ideal Doc Setting Name
...
dev (or short name of your sandbox)
...
IdealDoc Config
...
{ }
...
You can enter here default settings applying to all your documents. More infos HERE.
...
Ideal Doc Customer Token
...
Your token is communicated by IdealTeam.Group
...
Ideal Doc Url
...
...
Note here the use of "test" instead of "api" like for the production record.
| Info |
|---|
Internal Question : can a customer have multiple sandbox record? |
💡 Developers : This step can be automated by calling the Apex function from the Salesforce Developer Console:
| Code Block | ||
|---|---|---|
| ||
new IdealDocPostInstallClass().onInstall(null); |
Flows Activation
Verify that the following flows are active :
Simulate Ideal Doc Query Screen Flow
Create Ideal Doc Action Screen Flow
Create Ideal Doc Button Screen Flow
Other steps
...
Create IdealDocQueryc and IdealDocTemplatec records
...
Create IdealDoc docx template and upload to template record
...
If required: create custom IdealDocQueryParamsc and IdealDocTargetRecordIdc fields on target object
Select “Install for Admins Only”:
...
Grant access to the required IdealDoc API endpoints:
...
Configuration
Launch die IdealDoc Administration App from the Salesforce App Launcher:
...
On the IdealDoc Settings tab, follow the following setup steps, by clicking the corresponding button on the Settings page:
1 | Request Trial Subscription | Get a trial subscription for your current Salesforce Org. Only one trial per Org is possible. |
2 | Assign Permission Sets | Assigns the permission sets IdealDoc_User_Permissions and IdealDoc_Admin_Permissions to your admin User |
3 | Create Example Template | Creates an example IdealDoc Account Overview Template with an example query and an example DOCX document |
4 | Add Lightning Action | The example Account action: CreateIdealDocExample_noattach_docx_single_account_trial needs to be added to the Account Page or Layout |
5 | Get going | Create your own templates and queries and request a production token when ready |
...
Request Trial Subscription
When clicking on the “1. Request Trial Subscription” button, a new trial subscription for this Salesforce instance gets created automatically which allows for the creation of 100 documents and is valid for 3 months.
...
After creating the trial subscription, a new entry appears in the IdealDoc Settings table. By clicking on the “edit” symbol the default configuration for this subscription can be edited.
...
The “Setting Name” needs to be unique within all the settings and can only contain lowercase alphanumeric letters. The setting name will be used as setting identifier (key) when creating documents.
A setting is connected to an IdealDoc subscription through the defined end point url (test or prod) and the subscription token (not visible anymore after creation of the setting).
If a corresponding subscription is found for the (hidden) settings token and url, the subscription start and end date, the max and used quota gets displayed as well as the information whether the subscription renews automatically (canceled = false) or not (canceled = true).
All the attributes entered on this setting screen will be used as default value for each document created using this setting. Those values can be overriden by on the template record (See ….).
The attribute “Only Server Side Callouts” exists only this settings entry. If checked, IdealDoc will route all request for document creation and document status queries through the Salesforce server. This might be needed for environments where client side calls to the IdealDoc endpoint are not permitted by security restrictions.
Once you are ready to use IdealDoc in production, please contact us through our website: https://www.idealteam.group/en/products/idealdoc
We will send you a production ready token which you can enter as a new setting:
...
Create an Example Template
When pushing the “Create an Example Template” button, a new IdealDoc Template records named “Example Account Overview Template” gets created together with a new IdealDoc Query record “Example Account Overview Query”. An example Word template file “account_overview_example_idealdoc_template.docx” is attached to the template record. The details of an IdealDoc template will be discussed in a later section. To get started its enough to understand that those records have been created.
...
To create your first document you can copy (ctrl-C) the Id of an example Salesforce Account record and paster it into the example template record id field and click the “try me”button:
...
In the generic IdealDoc generation dialog select the newly created “Example Account Overview Template” and press “Next”.
...
If everything was setup correctly your first IdealDoc document should have been created and downloaded. Congrats!
The following section explains how to allow the creation of the example account overview document for all the users directly from the Account.
Add the Lightning Action to the Record Page
As part of the IdealDoc package, there is an example Account action called “CreateIdealDocExample_noattach_docx_single_account_trial” which calls the “IdealDoc Generic Action Screen Flow”.
...
To the test the creation of an IdealDoc document from an Account record this action can be added to the Account lightning record page. If dynamic actions are not enable the example action needs to be added to the “legacy” account layout.
...
Once the action is added to the record page, the “Create IdealDoc (Example)” action button becomes visible on the Account record page:
...
When clicking the “Next” button, the Account overview document will be generated depending on your selection either as Word or as PDF and either download or attached to the Account record as Salesforce file.
That was a quick intro to get you started. To learn more how to create your own IdealDoc templates have a look at the further documentation.