After-Install Configuration
Configure ClosePlan Permission Sets
In order to configure Permission Sets, you need to have 'Manage Profiles and Permission Sets' permission granted.
Go to ClosePlan Admin tab > User Manager.
If no configuration exists, a prompt will appear automatically > click Yes.
If the prompt does not appear, click ‘Configure’ in the Permission Set Configuration section.
Click ‘Configure' next to the desired License type or click ‘Configure All Available’ to configure all License Types available to your organisation and Confirm.
After Permission sets are configured, refresh the page. Configured Permission Sets under 'Permission Set Configuration' section should have the green checkmark. If not, please wait several minutes and refresh again.
NOTE: Permission sets are usually saved in a few seconds, but some organisations may have delays of up to several minutes.
Step 1 | Step 2 | Step 3 | Step 4 |
|---|---|---|---|
|
|
|
Once the configuration is saved, you can proceed with user provisioning. For more information on User Management see the User Management section.
Salesforce APIs Access Configuration
If API access is enabled, ClosePlan app will be able to modify certain Salesforce Admin configurations for owned Objects such as pick-list values. It will also receive access to additional metadata like Sales Processes or page layout configuration.
API access is required to enable certain ClosePlan features such as Opportunity Staging Playbooks, or modifying pick-list values.
1. Create External Client App
Previously, configuration was managed through Connected Apps, which have since been succeeded by the External Client App (ECA). Existing Connected App configurations will continue to function but can be migrated to ECA if necessary.
Go to the gear icon and click Setup
In the Quick Find box enter App Manager > External Client App Manager > click on New External Client App
In the Basic Information Section, fill in the sections indicated
External Client App Name: ClosePlan Connected App
API Name: ClosePlanConnectedApp (NOTE: use this value exactly)
Contact Email: enter your email
In the API (Enable OAuth Settings) Section:
Tick Enable OAuth
Under App Settings:
Callback URL:
https://<<YOUR DOMAIN>>.my.salesforce.com/services/authcallback/ClosePlanMetadataAuthProvider
To find your domain, navigate to: Setup > Company Settings > My Domain
Or Look to the URL of the Salesforce Org:
Paste the domain name of the Org into the Callback URL instead of <<YOUR DOMAIN>>
E.g. https://DD-showcase-dev-ed.my.salesforce.com/services/authcallback/ClosePlanMetadataAuthProvider
Under OAuth Scopes:
Select the following 2 items from Available OAuth Scopes and move to Selected OAuth Scopes
1. Full Access (full)
2. Perform Request on your behalf at any time – or it may appear: Perform requests at any time(refresh_token, offline_access)
Click Create at the bottom of the page to finish the process
You will be returned to the ClosePlan Connected App page
Click the Settings tab
Scroll to the OAuth Settings section
Click on Consumer Key and Secret button
A new tab will open where you will verify your identity to gain access to the Consumer Key and Consumer Secret
Consumer Key and Consumer Secret will open in a new tab and will be needed for the next Step: 2. Create Auth Provider
Keep the External Client App Name ClosePlan Connected App tab open, information needed for Step 9 is accessed here!
If you closed the tab, you can find it again: Go to Setup > Search: External Client App Manager > click ClosePlan Connected App > click Edit > Settings > OAuth Settings > Consumer Key and Secret
2. Create Auth. Provider
Go to the gear icon and click Setup (this will open a new tab, which is what we want)
In the Quick Find box enter Auth. Providers and open it > click New button
Provider Type: Salesforce
Name: ClosePlan Metadata Auth Provider
URL Suffix: ClosePlanMetadataAuthProvider (NOTE: use this value exactly)
Return to the previous tab and click the Manage Consumer Details button to get the Consumer Key and Consumer Secret.
Verify your identity.
A new tab will open with the information.
Consumer Key: Copy the Consumer Key and paste
Consumer Secret: Copy Consumer Secret and paste
Default Scopes: full refresh_token offline_access
Click Save and leave the tab open
You can find the Callback parameter in the bottom section. The Callback parameter must match Callback URL entered in step 1
3. Create Named Credentials
Go to the gear icon and click Setup (this will open a new tab, which is what we want)
In the Quick Find box enter Named Credentials > click the arrow next to the New button and select New Legacy.
The Named Credentials page will open, fill in the indicated fields
Label: ClosePlan Metadata Service
Name: ClosePlanMetadataService (NOTE: use this value exactly)
URL: https://<<YOUR DOMAIN>>.my.salesforce.com
Enter the same domain name as you entered in the section Create New Connected App - Step 1
Identity Type: Named Principal
Authentication Protocol: OAuth 2.0
Authentication Provider: ClosePlan Metadata Auth Provider
Scope: full refresh_token offline_access
Enable Start Authentication Flow on Save (this will initiate authorization on save)
Enable Generate Authorization Header
Enable Allow Merge Fields in HTTP Body
Click Save, you will be redirected to the Salesforce Authorization dialog to Log in.
If there is an error (blank page), it usually means that changes from previous steps have not yet been propagated. If this is the case, edit the record again and save until you get to auth. dialog properly.
If auth. dialog does not appear within 30 minutes, it is possible that the callback url may be invalid/improperly entered.
Login through your credentials
4. Verifying Configuration
After configuring Connected App you can validate if its working by following steps:
Go to ClosePlan Admin > Environment > Relationships > Picklist Values
If you see the pick-list value configuration, everything is configured properly
Configure Remote Sites
Some features require access to resources in the People.ai infrastructure, such as Release Notes and Updates, Document Export or AI features. In order to access these resources, the following configurations must be added:
Remote Site
Trusted URL
Remote Site Settings
Go to the gear icon and click Setup
In the Quick Find box enter Remote Site Settings and open it > click New Remote Site button
Fill in the required information in the modal
Remote Site Name: PeopleAI_API
Remote Site URL: https://api.people.ai
Active: Enabled
Save
Trusted URLs
Go to the gear icon and click Setup
In the Quick Find box enter Trusted URLs and open it > click New Trusted URL button
Fill in the required information in the modal
API Name: PeopleAI_API
URL: https://*.people.ai
Active: Enabled
CSP Contex: All
CSP Directives: Check all boxes
Save
Package and SFDC Setup APIs
Connected application exists only to provide internal connection between the package and Salesforce Setup settings.
In Salesforce Classic, the App would work without the Connected App, but since the introduction of Lightning, the connection to Salesforce Metadata API and UI API must have an authorized callout.
Through the mentioned APIs (Salesforce Metadata API and UI API), the ClosePlan App is doing following:
Controlling ClosePlan Picklist values (for a few ClosePlan objects)
Note that any setup changes still need to be executed by a System Admin User, no matter who authorizes the Connected App Named Credentials.
Retrieving information about Sales Processes (e.g. Opportunity Stage setup)
Retrieving some additional User settings (e.g. Comfy/Compact page layouts)
For more information see this article: ClosePlan Named Credentials and Permissions
If after reviewing the article, you still have questions, please reach out to us at Support@People.ai
Troubleshooting
Troubleshooting possible issues
Metadata API not configured
If Picklist Values are NOT displayed, then Metadata API is not properly configured.
Picklist Values can be found in ClosePlan Admin > Relationships > Picklist Values
To resolve this issue, consider the following Options:
Option 1: Missing Configuration Information
There is a missing configuration => Recheck all information in configuration steps 1 , 2 and 3.
Option 2: Configuration is broken
Named Credentials may have been authorized by a User who is no longer active => reauthorize by a new Admin User.
If you have created a full-copy Sandbox from your Production Org, the Named Credentials must be reauthorized by an Admin in the new Sandbox environment.
Go to Setup > in the quick find box, search Named Credentials and open it.
Click Edit by ClosePlan Metadata Service
Scroll down to uncheck, then recheck the box for Start Authentication Flow on Save
Click Save and log into your Organization.
Option 3: Domain Name was changed
Update the domain name details in steps 1, 2, and 3 accordingly.