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 should appear.

    • If there is no prompt, 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.

Step 1

Step 2

Step 3

Step 4

Step 1

Step 2

Step 3

Step 4

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.

Once configuration is saved, you may 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 New Connected App

  • Navigate to: Setup > Apps > App Manager > New Connected App

  • Connected App Name: ClosePlan Connected App

  • API Name: ClosePlanConnectedApp (NOTE: use this value exactly)

  • Contact Email: enter your email

  • Tick Enable OAuth Settings

  • Callback URL: 

                               



  • Paste 'Your domain name' into the Callback URL instead of <<YOUR DOMAIN>>

    • E.g. https://am-showcase-dev-ed.my.salesforce.com/services/authcallback/ClosePlanMetadataAuthProvider

  • Selected OAuth Scopes: 

    1. Full Access

    2. Perform Request on your behalf at any time

  • Click Save > then Continue

Keep this tab open, information here will be needed for the next steps!

If you have closed the tab, you can still get the information needed: Go to Setup > Apps > App Manager > ClosePlan Connected App. Click the down arrow  

and click View

 

2. Create Auth. Provider

  • Open a new window or tab

  • Go to Setup > 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)

  • Consumer Key: Copy Consumer Key from Connected App detail from step 1 and paste

  • Consumer Secret: Copy Consumer Secret from Connected App detail from step 1. (Click "Click to reveal" to see the value) and paste

  • Default Scopes:  full refresh_token offline_access

  • Click Save and remain on the detail.

    • 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

  • Open a new tab or window

  • Go to Setup > in the Quick Find box enter Named Credentials > click the New Named Credential button

  • Label: ClosePlan Metadata Service

  • Name: ClosePlanMetadataService (NOTE: use this value exactly)

  • URL: https://YOUR DOMAIN.my.salesforce.com

    • the same domain name as you entered in the section Created New Connected App - step 1

  • Identity Type: Named Principal

  • Authentication Protocol: OAuth 2.0

  • Authentication Provider: Select ClosePlan Metadata Auth Provider from list 

  • Scope: full refresh_token offline_access

  • Tick Start Authentication Flow on Save  (this will initiate authorization on save)

  • Tick Allow Merge Fields in HTTP Body

  • Click Save, you will be redirected to the Salesforce Authorization dialog to Log in. 

    1. 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.

    2. 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

          



Connected application exists only to provide internal connection between the package and Salesforce Setup settings.

In classic it would work without connected app, but since Lightning, connection to Salesforce Metadata API and UI API needs to have authorized callout.

App is doing following through mentioned APIs:

  • Controlling our Picklist values (for few ClosePlan objects)

    • Note that any setup changes still need to be executed by admin user, no matter who authorized Connected App Named Credentials.

  • Getting information about Sales Processes (Opportunity Stage setup)

  • Retrieving some additional user settings, such as if they use Comfy/Compact page layouts.

In terms of security, there is not need to be worried.



Troubleshooting

Metadata API not configured

Option 1: There is a missing configuration => configure the app steps 1. , 2. and 3.

Option 2: Configuration is broken 

  • Named credentials was authorized by a user who is not active anymore => authorize by a new admin user. 

  1. Go to Setup > into quick find box write named credentials and open it.

  2. Click Edit by ClosePlan Metadata Service

  3. Scroll down and disable and again enable check box by  Start Authentication Flow on Save

  4. Click Save and log in into your organization.

  • Domain name was changed => edit step 1. , 2. and 3.