Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 7 Next »

Pre-requisite. You need a system administrator profile to perform those steps.

Installation

Install the IdealDoc Salesforce package into your Salesforce instance:

Select “Install for Admins Only”:

image-20250106-120520.png

Grant access to the required IdealDoc API endpoints:

image-20250106-122210.png

Configuration

Launch die IdealDoc Administration App from the Salesforce App Launcher:

image-20240906-124922.png

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

image-20241118-094507.png

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.

image-20250106-144904.png

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.

image-20250106-144945.png

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 entered token and url, the subscription start and end date, the max quota and used quota gets displayed as well as the information whether the subscription renews automatically (canceled = false) or not (canceled = true).

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”

image-20241118-094939.png
  • No labels