Installing the Managed Package

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

  1. Package URL & Password

    Field Value
    URL Refer Salesforce Configuration Settings document
    Password Refer Salesforce Configuration Settings document
  2. Select any of the following options
    • Install for Admins Only
    • Install for All Users
    • Install for Specific Profiles (recommended)
  3. Click Install to begin installation. You will receive an email confirmation after the package is installed.

Step 2: Apply Pramata Admin Settings

  1. On the top left corner of the screen, click the App Launcher icon.
  2. In the Search apps and items... box, type Pramata Admin Settings.
  3. Click Pramata Admin Settings.
    App Launcher.png
     
  4. In the Edit Pramata Admin Settings page, add the following values and click Save.
    Edit Pramata Admin Settings.png

    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.  

image1.png

Step 3: Create Pramata External Client App

  1. On the top right corner of the screen, click Setup.
  2. In the left navigation pane, use the Quick Find box to type Apps.
  3. In the left panel, navigate to Apps > External Client Apps > External Client App Manager.
  4. To start creating the External Client App, click the New External Client App button.
  5. Add the following values in the respective sections and click Create
    new ext client app.png

    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

  1. On the top right corner of the screen, click Setup.
  2. In the left navigation pane, use the Quick Find box to type Apps.
  3. In the left panel, navigate to Apps > External Client Apps > External Client App Manager.
  4. In the External Client App Manager page, click Pramata.
  5. In the Policies tab, click Edit.
  6. Scroll down to Custom Attributes section and click the + button to add attributes.
  7. 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.
    add custom attribute.png
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

  1. On the top right corner of the screen, click Setup.
  2. In the left navigation pane, use the Quick Find box to type Permission.
  3. In the left panel, under Users click Permission Sets.
  4. In the Permission Sets page, click New.
  5. In the Enter permission set information section, type the following values and click Save.
    permission set.png
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:

apps.png

Apex Class Access

  1. In the Apps section, click Apex Class Access.
  2. Click Edit against Apex Class Access.
  3. 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. 
  4. Click Save.
Apex Classes
PramataAccountController
PramataSolutionController
 

Visualforce Page Access

  1. In the Apps section, click Visualforce Page Access.
  2. Click Edit against Visualforce Page Access.
  3. 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. 
  4. Click Save.
Visualforce Page

PramataPorfolio(n)

PramataClassicCustomerSolution(n)

PramataDocumentFamily

PramataMiniClassicCustomerSolution(n)

Pramata App

 

Enable Pramata Permission Set

  1. On the top right corner of the screen, click Setup.
  2. In the left navigation pane, use the Quick Find box to type Manage.
  3. In the left panel, navigate to Apps > External Client Apps > External Client App Manager.
  4. In the External Client App Manager page, click Pramata.
  5. In the Policies tab, click Edit.
  6. 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.
  7. Click Save.

    permission set new.png

 

Option 2: Profiles

Enable Profiles

  1. On the top right corner of the screen, click Setup.
  2. In the left navigation pane, use the Quick Find box to type Manage.
  3. In the left panel, navigate to Apps > External Client Apps > External Client App Manager.
  4. In the External Client App Manager page, click Pramata.
  5. In the Policies tab, click Edit.
  6. 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. 

  7. Select the Profiles, using which users have access to the Pramata application and click Save.

    select profiles.png

Enable Required Access

  1. On the top right corner of the screen, click Setup.
  2. In the left navigation pane, use the Quick Find box to type Profiles.
  3. In the left panel, under Users, click Profiles.
  4. 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

  1. Click Edit against Enabled Apex Class Access.
  2. 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. 
  3. Click Save.

    Apex Classes
    PramataAccountController
    PramataSolutionController
  4. Click Edit against Enabled Visualforce Page Access.
  5. 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. 
  6. 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.

  1. On the top right corner of the screen, click Setup.
  2. In the left navigation pane, use the Quick Find box to type Trusted URLs.
  3. In the left panel, navigate to Security > Trusted URLs.
  4. In the Trusted URLs page, click New Trusted URL.
  5. In the Trusted URL Edit page, add the URL information shown in the table below.
trusted url.png
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
Email 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

  1. On the top right corner of the screen, click Setup.
  2. In the left navigation pane, use the Quick Find box to type Apps.
  3. In the left panel, navigate to Apps > External Client Apps > External Client App Manager.
  4. In the External Client App Manager page, click Pramata.
  5. In the Policies tab, scroll down to SAML Login Info.
  6. 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

saml login info.png