...
| 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 |
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
Create Quick Action 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, automatically a new trial subscription for this Salesforce instance gets created 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.
...
Create an Example Template
Copy & Paste the Id of an example Salesforce Account record into the example template record id field and click “try me”
...