Overview
This document provides guidelines to setup integration of Salesforce with Pramata.
Prerequisites
- Ensure you have the "Salesforce Configuration Settings" document along with the Pramata Certificate from your Pramata Customer Success Manager.
Ensure you have the list of profiles for which Pramata Solution has to be enabled.
Ensure that “My Domain” and “Identity Provider” for Salesforce is enabled.
Package Installation
Step 1: Package Installation
-
Package URL & Password
Field Value URL Refer Salesforce Configuration Settings document Password Refer Salesforce Configuration Settings document - Select any of the following options
- Install for Admins Only
- Install for All Users
- Install for Specific Profiles (recommended)
- Click Install to begin installation. You will receive an email confirmation after the package is installed.
Step 2: Apply Pramata Admin Settings
- On the top left corner of the screen, click the App Launcher icon.
- In the Search apps and items... box, type Pramata Admin Settings.
- Click Pramata Admin Settings.
-
In the Edit Pramata Admin Settings page, add the following values and click Save.
Field Value Pramata URL Refer Salesforce Configuration Settings document Solution 1 Settings Name of Solution 1: Expiration Management Portfolio View App ID (Lightning): 20000 Solution Settings (Lightning) Lightning Tab 1 ID: 10000
Note: Upon adding the values, if your screen displays a message as shown in the image below, refresh your browser window.
Step 3: Create Pramata External Client App
- On the top right corner of the screen, click Setup.
- In the left navigation pane, use the Quick Find box to type Apps.
- In the left panel, navigate to Apps > External Client Apps > External Client App Manager.
- To start creating the External Client App, click the New External Client App button.
-
Add the following values in the respective sections and click Create.
Basic Information Field Value External Client App Name: Pramata API Name: Pramata Contact Email: support@pramata.com API (Enable OAuth Settings) Enable Oauth Settings Leave it unchecked Web App Settings Start URL Leave it blank Enable SAML Select the check-box Entity ID Refer Salesforce Configuration Settings document ACS URL Refer Salesforce Configuration Settings document Issuer Pramata Name ID Format urn:oasis:names:tc:SAML:2.0:nameid-format:persistent Signing Algorithm for SAML Messages SHA256 Subject Type Username Enable Single Logout Select the check box Single Logout URL Refer Salesforce Configuration Settings document Single Logout Binding HTTP POST Verify Request Signatures Refer Salesforce Configuration Settings document Mobile App Settings Enable Mobile Leave it unchecked Canvas App Settings Enable Canvas Leave it unchecked
Adding Custom Attributes
- On the top right corner of the screen, click Setup.
- In the left navigation pane, use the Quick Find box to type Apps.
- In the left panel, navigate to Apps > External Client Apps > External Client App Manager.
- In the External Client App Manager page, click Pramata.
- In the Policies tab, click Edit.
- Scroll down to Custom Attributes section and click the + button to add attributes.
- In the Add Custom Attribute page, add one Attribute Key and its corresponding Value, then click Save. Repeat this process for each Attribute in the table below.
| Attribute Key | Attribute Value |
| uniqueEmail | $User.Username + ".sfdc" |
| sfdc_session_id | $User.prmtlw__Pramata_Role_Name__c & $Api.Session_ID |
| user_last_name | $User.LastName |
| user_first_name | $User.FirstName |
| user_id | $User.Id |
| title_name | $User.Title |
| department_name | $User.Department |
| pramata_role | $User.prmtlw__Pramata_Role_Name__c |
Step 4: Permissions for Pramata External Client App and Components
Use any one of the options to give permission to the Pramata App and Pramata Components:
Option 1: Permission Set
Setup Permission Set
- On the top right corner of the screen, click Setup.
- In the left navigation pane, use the Quick Find box to type Permission.
- In the left panel, under Users click Permission Sets.
- In the Permission Sets page, click New.
- In the Enter permission set information section, type the following values and click Save.
| Field | Value |
| Label | Pramata Permission Set |
| API Name | Pramata_Permission_Set |
Enable Required Access
In the Permission Set Overview page, under the Apps section, click the following Apps and add the values mentioned in the table:
Apex Class Access
- In the Apps section, click Apex Class Access.
- Click Edit against Apex Class Access.
- In the Available Apex Classes box, select the values mentioned in the table below and click the Add button. The values are added to the Enabled Apex Classes box.
- Click Save.
| Apex Classes |
| PramataAccountController |
| PramataSolutionController |
Visualforce Page Access
- In the Apps section, click Visualforce Page Access.
- Click Edit against Visualforce Page Access.
- In the Available Visualforce Pages box, select the pages mentioned in the table below and click the Add button. The values are added to the Enabled Visualforce Pages box.
- Click Save.
| Visualforce Page |
PramataPorfolio(n) |
PramataClassicCustomerSolution(n) |
PramataDocumentFamily |
PramataMiniClassicCustomerSolution(n) |
Pramata App |
Enable Pramata Permission Set
- On the top right corner of the screen, click Setup.
- In the left navigation pane, use the Quick Find box to type Manage.
- In the left panel, navigate to Apps > External Client Apps > External Client App Manager.
- In the External Client App Manager page, click Pramata.
- In the Policies tab, click Edit.
- In the Select Permission Sets section, select Pramata Permission Set from the Available Permission Sets and move it to the Selected Permission Set using the arrow button.
Click Save.
Option 2: Profiles
Enable Profiles
- On the top right corner of the screen, click Setup.
- In the left navigation pane, use the Quick Find box to type Manage.
- In the left panel, navigate to Apps > External Client Apps > External Client App Manager.
- In the External Client App Manager page, click Pramata.
- In the Policies tab, click Edit.
In the Select Profiles section, select the desired profile(s) from the Available Profiles list and move them to the Selected Profiles list using the arrow button.
- Select the Profiles, using which users have access to the Pramata application and click Save.
Enable Required Access
- On the top right corner of the screen, click Setup.
- In the left navigation pane, use the Quick Find box to type Profiles.
- In the left panel, under Users, click Profiles.
- Select the Profile Name for which the Pramata application was assigned. Follow the steps below to enable Apex Class and Visualforce Page access on all Profiles assigned to the Pramata application.
Apex Class Access
- Click Edit against Enabled Apex Class Access.
- In the Available Apex Classes box, select the values mentioned in the table below and click the Add button. The values are added to the Enabled Apex Classes box.
-
Click Save.
Apex Classes PramataAccountController PramataSolutionController - Click Edit against Enabled Visualforce Page Access.
- In the Available Visualforce Pages box, select the pages mentioned in the table below and click the Add button. The values are added to the Enabled Visualforce Pages box.
-
Click Save.
Visualforce Page PramataPorfolio(n)
PramataClassicCustomerSolution(n)
PramataDocumentFamily
PramataMiniClassicCustomerSolution(n)
Pramata App
Step 5: Add Trusted URLs
Note: The steps below require Salesforce System Administrator access. If you do not have Admin privileges, please share these instructions with your Salesforce Admin before proceeding.
- On the top right corner of the screen, click Setup.
- In the left navigation pane, use the Quick Find box to type Trusted URLs.
- In the left panel, navigate to Security > Trusted URLs.
- In the Trusted URLs page, click New Trusted URL.
- In the Trusted URL Edit page, add the URL information shown in the table below.
| Step 1: Add the Pramata CRM URL | |
| Trusted URL Information | |
| Field | Value |
| API Name | pramatacrm |
| URL | Refer Salesforce Configuration Settings document |
| Active | Checked |
| Content Security Policy (CSP) Settings | |
| CSP Context | All |
| frame-src (iframe content) | Checked |
| img-src (images) | Checked |
| Click Save & New to save this entry and immediately add the next one. | |
| Step 2: Add the Pramata Auth0 URL | |
| Trusted URL Information | |
| API Name | pramata_auth0 |
| URL | Refer Salesforce Configuration Settings document |
| Active | Checked |
| Content Security Policy (CSP) Settings | |
| CSP Context | All |
| frame-src (iframe content) | Checked |
| img-src (images) | Checked |
| Click Save. | |
Step 6: Test User Account for Pramata
Create a Pramata Test User if user account does not exist with the information provided below. Note that, the Test User should be provided with the required Profile or Permission Set which has access to Pramata external client app and Pramata components.
| User Field | Values |
| Refer Salesforce Configuration Settings document | |
| First Name | Pramata |
| Last Name | Test User |
| Username | Refer Salesforce Configuration Settings document |
Step 7: List of items to be provided to Pramata
- On the top right corner of the screen, click Setup.
- In the left navigation pane, use the Quick Find box to type Apps.
- In the left panel, navigate to Apps > External Client Apps > External Client App Manager.
- In the External Client App Manager page, click Pramata.
- In the Policies tab, scroll down to SAML Login Info.
- From the SAML Login Info section provide the following details to Pramata.
Click Download Metadata and send the downloaded file.
IdP Initiated Login URL
Single Logout Endpoint