Permission Sets

The Relay Package requires two permission sets. One permission set is designated for the Connected Application, while the other grants users access to the Relay LWC. You may be able to utilize existing permission sets provided they are updated to fulfill the requirements outlined in this article.

Relay Connected App Permission Set

IMPORTANT

Before creating the Relay Connected App permission set, make sure you have a Salesforce user that will be assigned to the permission set. This user does not require any UI logon capability. The user will be used to authenticate the connected app and will be the user identified as having created all of the Relay Events and Relay Powerups records.

This permission set is required by the Relay Connected App configuration. These permissions permits the Relay platform to insert records into the custom objects RelayEvents__c and RelayPowerups__c.

Create Relay Connected App Permission Set

1. Access your org’s Setup page.

2. Navigate to ADMINISTRATION → Users → Permission Sets.

3. Client the New button to create a new permission set.

   1. Set the Label name to Relay Connected App.

   2. Set the API Name to Relay_Connected_App.

   3. Click Save.

Edit Permission Set

If you just created the Permission Set, you should already be viewing its settings. If not, navigate to the Permission Sets, locate the Relay Connected App permission set and click on it.

Edit - Object Settings

1. Under the Apps section, click on the Object Settings (Fig 1-1) link.

   1. Scroll down and locate the Relay Events object can click on it.

      1. Click the Edit button.

      2. Ensure that the Object Permissions of Read and Create are Enabled.

      3. Ensure that the Field Permissions have enabled Read and Edit Access for all the fields.

      4. Click the Save button.

   2. Click on the Object Settings breadcrumb to return back to the Object Settings page.

   3. Scroll down and locate the Relay Powerups object and click on it.

      1. Ensure that the Object Permissions of Read and Write are Enabled.

      2. Ensure that the Field Permissions have enabled Read Access for all the fields.

      3. Click the Save button.

   4. Click on the Permission Set Overview breadcrumb to return back to main permission set overview page for the Relay Connected App permission set.

Edit - Manage Assignments

1. Click on the Manage Assignments (Fig 1-2) button.

2. Click on the Add Assignment button.

   1. Locate the desired Connected App user and select it (check the box).

   2. Click the Next button.

   3. Click the Assign button.

3. Click on the PERMISSION SET 'RELAY CONNECTED APP' breadcrumb link.

IMPORTANT

Provide your Relay Implementation Manager the Salesforce username (not the email address) you assigned to the permission set. This value is required to configure the Relay Push API.

Relay LWC Permission Set

IMPORTANT

You must create a new LWC permission set. While you can use the included RelayLWC permission as a template, if you make any change to pre-packaged permission set those changes will be overwritten during your next Relay package upgrade.

This permission set controls access to the Relay LWC. The following users should be assigned to this permission set:

• Any Salesforce user who requires access to the Relay LWC.

• Any user who might invoke a flow, directly or indirectly, that includes any Relay flow actions.

• If you have any scheduled flows that includes a Relay action, then the default flow user will need access to this permission set. 

Create Relay LWC Permission Set

1. Access your org’s Setup page.

2. Navigate to ADMINISTRATION → Users → Permission Sets.

3. Client the New button to create a new permission set.

   1. Set the Label name to Relay LWC Access.

   2. Set the API Name to Relay_LWC_Access.

   3. Set the License option to -None-.

   4. Click Save.

Edit Relay LWC Access Permission Set

Edit - Object Settings

1. Under the Apps section, click on the Object Settings (Fig 2-1) link.

   1. Scroll down and locate the Relay Events object can click on it.

      1. Click the Edit button.

      2. Ensure that the Object Permissions of Read and Create are Enabled.

      3. Ensure that the Field Permissions have enabled Read and Edit Access for all the fields.

      4. Click the Save button.

   2. Click on the Permission Set Overview bread crumb link to return back to the Relay LWC Access permission set overview page. 

Edit - External Credential Principal Access

1. Under the Apps section, click the External Credential Principal Access (Fig 2-2) link. You will be presented with Fig 3.

2. Verify that the RelayNetworkPrincipal is assigned (Fig 3-1). If not continue with step 3.

3. Click the Edit button (Fig 3-2)

   

4. In the Available External Credential Principals list, locate the RelayNetworkCreds - RelayNetworkPrincipal and Add it to the Enabled External Credential Principals list (Fig 4-1.

5. Click the Save button.

6. Click on the Permission Set Overview (Fig 3-3) bread crumb link to return back the Relay LWC Access permission set overview page.

Manage Assignments

IMPORTANT

Make sure you assign all users that require access to the Relay LWC to this permission set.

1. Click on the Manage Assignments (Fig 2-3) button.

2. Click on the Add Assignment button.

   1. Locate the desired user and select it (check the box).

   2. Click the Next button.

   3. Click the Assign button.

3. Click on the PERMISSION SET 'RELAY LWC ACCESS' breadcrumb link.