Work-Relay Documentation

Complete Overview of Setup

Below is a complete overview of the setup process. Follow the steps below to prepare your organization to use Work-Relay.

Total time to complete these steps: ~10 Minutes.

Setting up Work-Relay

See below to view the step-by-step instructions for setting up Work-Relay in your organization.

1. Select Your Organization

Get your organization ready

System Requirements

To install and successfully use Work-Relay, you must have one of the following versions of Salesforce.com:

Unlimited Edition
Enterprise Edition
Developer Edition
Sandbox

Work-Relay also works with the following:

Salesforce Customer Communities
Salesforce Partner Communities
Salesforce Employee Communities
Force.com Platform

Select which organization you want to install Work-Relay in

If you don't have an org, go to Salesforce.com and sign up for a 30-day free trial.

NOTE: Setting up Work-Relay requires System Admin authorization.

Make sure domain name is set up for your organization

For the instructions on setting up custom domain name please refer the following article:

Setting up custom domain for your Salesforce organization

2. Initialize the Work-Relay environment in your organization

See below how to accomplish each step.

2.1 Enable Chatter if not already enabled

2.1.1 Navigate to your Chatter

Click on your name (1).
Select Setup (2).

2.1.2 Click on Chatter Settings

Note: You may need to scroll down the page to select Chatter Settings (3):

2.1.3 Click on the "Enable" checkbox (4) and click "Save" button (5)

More information about Chatter is available directly from Salesforce

2.2 Install the Work-Relay package

2.2.1 Navigate to the installation page

Copy the last part of the installer link provided to you by a Work-Relay representative (link below is an example):

https://login.salesforce.com/packaging/installPackage.apexp?p0=04tj0000001xxxxx

In this example you would copy /packaging/installPackage.apexp?p0=04tj0000001xxxxx

Login to your instance of Salesforce and remove everything after the base URL, then paste the last part of URL from step 1 at the end:

2.2.2 Install package

The installation dialog will appear. Please select "Install for Admins Only" and then the "Install" button:

After pressing Install, you will see the following status screen:

2.2.3 Finish installation

Since Work-Relay is a large package, you will see the following notice. You can click "Done" and you will receive an email when the package has been installed:

2.3 Add Remote Site URL

2.3.1 Add this Remote Site URLs

Go to the Work-Relay App in Salesforce Classic, click on the Processes tab and copy the base URL (6):

Редактор изображений PicPick - [Screenshot 2023-11-23 - 62]

2.3.2 Navigate to Remote Site Settings

In Setup, click on Remote Site Settings (7):

2.3.3 Add a new remote site

Add a new remote site, and paste the URL from above into the proper field (8). The Remote Site name can be "Work-Relay" or similar:

The naming convention should help you remember what this remote site is. You can also add a description.

Do the same for Work-Relay app. in Lightning Interface:

2.4 Add CSP Trusted Site URLs and CORS URLs

2.4.1 CSP Trusted Sites - Copy URLs

For CSP you will need 3 URLs - the base Lightning URL, the base Salesforce Classic URL, and the base Salesforce Classic Work-Relay App URL (same as Remote Site Settings).

1. Go to the Work-Relay App in Salesforce Classic, click on the Processes tab and copy the base URL (yellow highlight below):

2. Go to the Home page in Salesforce Classic and copy the base URL (highlighted below):

3. Switch to the Lightning Experience and copy the base URL (highlighted below):

2.4.2 Navigate to CSP Trusted Sites

In Setup, click on CSP Trusted Sites (9):

2.4.3 Add 3 new CSP trusted sites

Add 3 new CSP trusted sites, and paste in the URLs from above. The Site names can be "Lightning", "Classic", and "Work-Relay" or similar:

2.4.4 Add CORS URLs

In Setup, click on CORS (10):

Click New and add the following 2 URL patterns (11):

2.4.5. Add Trusted Domain to Session Settings

*May only be needed if clickjack protection is enabled in Session Settings.

** In Production, domains would be: *.lightning.force.com & *.vf.force.com

In Setup, go to Session Settings. Add 2 domain to Trusted Domains.

2.5 Provide License key

2.5.1 Ask for a license key from your Work-Relay representative

You will need to provide your Organization ID, found here (12):

2.5.2 Provide license on Settings tab

Go to the "Licenses" subtab of Settings tab in Work-Relay. See proper article for license management.

2.6 Assign Permission Sets for Users

WR Process Admin - any user that will need to administer Work-Relay (create processes, forms, etc).
WR Process User - any user that will be assigned Work-Relay tasks, complete forms, etc.
If you need to add more permissions (i.e. Visualforce pages generating by Work-Relay) you can clone the Permission Sets and add them to the clone.

3. Select your Objects

In Salesforce, Objects store the field definitions and records that make up your data. As your organization data may contain many objects, you will likely only use a subset of those within Work-Relay. For this reason, you will want to indicate which objects in your organization are available to Work-Relay.

Please refer to the proper article.

4. Turn on Workflow Scheduler

Click [Turn On]

Navigate to Work-Relay Settings.
Click Schedulers Settings (18).
Click Turn On (19) link.

5. Specify Email Contact

This is needed for the "Send Email" action when you want to use a standard Salesforce email template. The reason for this is that in order to send an email from Apex code using a Salesforce email template and you want to pass a record as context to that template - you must send an email to a Contact (standard Salesforce object).

That is why you need to specify the helper Contact on the Work-Relay Settings page.

5.1 Create a Dummy Contact Record

In your organization, create a dummy Contact record with an email like "[email protected]".

5.2 Register that Contact on the Work-Relay Settings page

Go to "Notifications Settings" subtab (20).
Select this contact (21) in the proper field.

Now, whenever Work-Relay sends an email using a Salesforce email template, that email is sent to a Contact specified on the Settings page (which allows us to pass a flow context record to a template). The real email addresses to whom you want to send the emails are provided in a separate apex method. I.e. if you want to send an email alert to "[email protected]" then in the end it will be sent to two addresses "[email protected]; [email protected]".

6. Update Chatter Email settings

Starting with Salesforce Winter, 24 chatter emails are no longer sent from orgs where the From Name and Email Address fields in Chatter Email Settings are blank.

In Setup, go to Chatter > Email Settings. In 'Sender' section fill in From Name and Email Address if they are blank.