OmniStudio Integration Procedures

Exercise Guide

Before You Begin

Did you sign up for a special OmniStudio Developer Edition org already? You’ll need one to
do the steps in this guide. Here’s how to request one if this is your first time completing an
OmniStudio module:
1. Sign up for a free Developer Edition org with OmniStudio.
2. Fill out the form.
a. For Email, enter an active email address.
b. For Username, enter a username that looks like an email address and is
unique, but it doesn't need to be a valid email account (for example,
[email protected]).
c. After you fill out the form, click Sign me up. A confirmation message appears.
3. When you receive the activation email (this might take about 10 minutes), open it
and click Verify Account.
4. Complete your registration by setting your password and security challenge question.
Tip: Write down your username, password, and login URL for easy access later.

Update Session Settings

1. Click the “Gear” > Setup. This opens a new tab.

2. In the Quick Find enter session and select Session Settings.
3. Scroll up the page and clear the checkbox next to Use Lightning Web Security for
Lightning web components. (The checkbox should be blank.)
4. Scroll back down and click Save.

You are logged in to your Developer Edition and you can begin practicing.

© Copyright 2021 Salesforce.com, inc. All rights reserved. 1

OmniStudio Integration Procedures
Exercise Guide

Build Simple Integration Procedures

Requirements
“As a user, I'd like the OmniScript that allows me to update basic account details to be able to
extract the data from Salesforce and save any updated data back into Salesforce.”

Build the Integration Procedure that extracts Account data from Salesforce into the Edit
Account OmniScript, then build another Integration Procedure that allows you to save
updated data from the OmniScript back to Salesforce.

Prerequisites
● None

Tasks
1. Build an Integration Procedure to Get Data for the Edit Account OmniScript

2. Build an Integration Procedure to Save Updated Data from the Edit Account
OmniScript

Time
● 20 mins

© Copyright 2021 Salesforce.com, inc. All rights reserved. 2

OmniStudio Integration Procedures
Exercise Guide

Task 1: Build an Integration Procedure to Get Data for the Edit Account
OmniScript
1. Create a new version of an existing Integration Procedure.

a. Open the App Launcher, then select the OmniStudio app.

b. From the dropdown, select OmniStudio Integration Procedures.

c. Type team into the search text box.

d. Open team/getAccountDetails > Team Stub Get Account Details (Version 1).

e. Click Create Version to preserve the version with stub details.

f. Edit the name to remove Stub. The new name is Team Get Account Details
(Version 2).

g. Delete the Set Values element.

2. Link the Get Account Details Integration Procedure to the sampleGetAccountDetails

DataRaptor.

a. Drag a DataRaptor Turbo Action component into the STRUCTURE panel,

immediately below the Procedure Configuration element.

b. Fill in the fields as follows:

Property Value
Element Name DRGetAccountDetails

DataRaptor Interface sampleGetAccountDetails

© Copyright 2021 Salesforce.com, inc. All rights reserved. 3

OmniStudio Integration Procedures
Exercise Guide

c. In the INPUT PARAMETERS table, click + Add Input Parameter and fill in the
fields as follows:

Property Value Notes

Data Source AccountId You may see suggestions
for this value, but you
must enter it yourself.

Filter Value AccountId

d. In SEND/RESPONSE TRANSFORMATIONS, enter Account|1 in the Response

JSON Path.

DataRaptor Turbos return data in a nested array, no matter how many entries.
The Response JSON Path field allows you to trim the response from the
DataRaptor. Using Account|1, you identify the Object node (Account) and
identify the correct instance in the array (1).

e. Click PREVIEW.

f. Click + Add New Key/Value Pair and enter the following:

Property Value
Key AccountId

Value [Acme’s AccountId]

NOTE:
If you don’t already have it, locate Acme's Record Id as follows:
1. Select Accounts from the Object dropdown.
2. If needed, switch the view to All Accounts.
3. Click Acme to view Acme's detail page.
4. Copy the RecordId from the URL (Account Ids always begin with 001,
Contact Ids with a 003) and paste it somewhere to use it again.
5. Return to the DataRaptor and paste the RecordId into the Value field.

© Copyright 2021 Salesforce.com, inc. All rights reserved. 4

OmniStudio Integration Procedures
Exercise Guide

g. Click Execute. (You need to scroll down to see the button).

h. Under Debug Log, select DRGetAccountDetails from the dropdown and

confirm you see Acme's information. The DataRaptor is now connected to the
Integration Procedure.

NOTE:
In the Debug Log dropdown, Original Input is what you expect to pass to the
Integration Procedure. Debug Log would allow you to work through and
identify any issues with the output and the input for each element. In
addition, there are two entries for each component. The first, NAME, displays
the output. The second, NAMEDebug shows the input for the step. If you
don't see expected outputs, you can review the debug entry to help find out
what is wrong with the input data

3. Tell the Integration Procedure what data to send back to the Edit Account
OmniScript.

a. Click PROPERTIES.

b. Click on the Response Action element ResponseAction in the STRUCTURE

panel.

© Copyright 2021 Salesforce.com, inc. All rights reserved. 5

OmniStudio Integration Procedures
Exercise Guide

c. Under SEND/RESPONSE TRANSFORMATIONS, in the Send JSON Path field,

replace SetValues with DRGetAccountDetails.

d. Click PREVIEW > Execute.

e. Confirm the Response section displays Acme's Account information.

f. Click PROPERTIES.

g. Click Procedure Configuration > Activate Version.

4. Confirm the Get Account Details Integration Procedure is working in the Edit Account
OmniScript.

a. From the dropdown, select the OmniScripts tab.

b. Search for sample and select the sample/editAccount Omniscript > Sample
Edit Account (Version 1).

© Copyright 2021 Salesforce.com, inc. All rights reserved. 6

OmniStudio Integration Procedures
Exercise Guide

c. Click IPGetAccountDetails on the Canvas and edit the Integration Procedure

field under the Properties tab to team_getAccountDetails.

d. Click Preview in the Header.

e. Paste the Acme Account Record Id into the Context ID field and click
Refresh.

f. Confirm the account details for Acme populate in the preview screen and
JSON.

© Copyright 2021 Salesforce.com, inc. All rights reserved. 7

OmniStudio Integration Procedures
Exercise Guide

Task 2: Build an Integration Procedure to Save Updated Data

1. Create a new version of an existing Integration Procedure.

a. From the dropdown, select OmniStudio Integration Procedures.

b. Search for team and open the team/saveAccountDetails > Team Starter Save
Account Details (Version 1) Integration Procedure.

c. Create a new version.

d. Edit the name to remove Starter from the name. The new name is Team Save
Account Details.

e. Drag a DataRaptor Post Action into the STRUCTURE panel (below Procedure
Configuration).

f. In the Element Name field, enter DRSaveAccountDetails.

g. Click DataRaptor Interface and select sampleSaveAccountDetails from the

dropdown.

h. Click Procedure Configuration and Activate Version to activate the

Integration Procedure.

2. Confirm the active Integration Procedure is connected to your OmniScript.

a. Return to the sample/editAccount>Sample Edit Account (Version 1)

OmniScript tab.

b. Click IPSaveAccountDetails on the Canvas and edit the Integration

Procedure field under the Properties tab to team_saveAccountDetails.

c. Click Preview in the Header.

d. If needed, paste Acme's RecordId into the Context ID field.

e. Click Refresh.

© Copyright 2021 Salesforce.com, inc. All rights reserved. 8

OmniStudio Integration Procedures
Exercise Guide

f. Edit either the website address or the phone number.

g. Click Next.

h. Click on the browser tab where Acme's information displays.

i. Refresh the browser page (F5 or reload the page) and confirm the edit you
made displays.

3. Activate the OmniScript.

a. Click Activate Version.

b. Click Done.

© Copyright 2021 Salesforce.com, inc. All rights reserved. 9

OmniStudio Integration Procedures
Exercise Guide

Challenge: Build Additional Integration

Procedures
Solidify what you learned when you created the Integration Procedures for the Edit Account
OmniScript. We’ve summarized the requirements; refer to the step-by-step instructions
above if you get stuck.

Build an Integration Procedure to extract data from the Contact object, and build an
Integration Procedure to save the updated Contact data back into Salesforce.

1. Version and edit the Team Stub Get Contact Details Integration Procedure to use the
sampleGetContactDetails DataRaptor.

○ Use ContactId for the Input Parameters Data Source and Filter Value.

○ Update the Send JSON Path in the Response action.

○ To preview, locate the recordId for Leanne Tomlin’s contact record.

○ Don’t forget to activate the new version of the Integration Procedure.

○ Test the new version in the sample/editContact OmniScript. Make sure to

replace the Integration Procedure in the Integration Procedure action element
first.

2. Version and edit the Team Starter Save Contact Details Integration Procedure to use
the sampleSaveContactDetails DataRaptor Load to save data from the
sample/editContact OmniScript.
○ Test the Integration Procedure using the Edit Contact OmniScript Preview.
Make sure to replace the Integration Procedure in the Integration Procedure
action element first.

© Copyright 2021 Salesforce.com, inc. All rights reserved. 10

OmniStudio Integration Procedures
Exercise Guide

Build an Integration Procedure to extract data from the Cases object, and build an
Integration Procedure to save the updated Cases data back into Salesforce.

1. Version and edit the Team Stub Get Case Details Integration Procedure to use the
sampleGetCaseDetails DataRaptor.

○ Use CaseId for the Input Parameters Data Source and Filter Value.

○ Update the Send JSON Path in the Response action.

○ To preview, locate the recordId for case number 00001026.

○ Don’t forget to activate the new version of the Integration Procedure.

○ Test the new version in the sample/editCase OmniScript. Make sure to

replace the Integration Procedure in the Integration Procedure action element
first.

2. Version and edit the Team Starter Save Case Details Integration Procedure to use the
sampleSaveCaseDetails DataRaptor Load to save data from the sample/editCase
OmniScript. Test the Integration Procedure using the Edit Cases OmniScript Preview.
Make sure to replace the Integration Procedure in the Integration Procedure action
element first.

© Copyright 2021 Salesforce.com, inc. All rights reserved. 11