Glossary
OmniStudio
This is where you create Vlocity data packs.
OmniStudio Console
This is where you can view records (e.g. Accounts)
FlexCard
Sometimes called Vlocity Card. A piece of UI that will appear in OmniStudio Console. The UI will use data from an integration procedure or a data raptor, or you can embed FlexCards within each other.
IntegrationProcedure
A data source for a FlexCard. It is similar to a flowchart where you give some input and it does a series of steps to give an output. For example, you might give an account ID as input, and it will use a DataRaptor to extract some fields from that account. Alternatively, you might give it a contact ID, and it will pull the weather for the contactʼs home address from a third party service.
DataRaptor
This transforms data from one format to another. It might take data from an Account record, and then turn that data into a JSON format which can be used as the input for an IntegrationProcedure or a FlexCard.
For example, the output of a DataRaptor for an account might look like:
{
"Name": "Gearset",
"NumberOfEmployees": 150,
...
}
OmniScript
This is similar to a wizard for getting a user to fill out information. It can ask for different data based on your responses. The typical example we would use to explain this would be imagining something like the form you fill out to compare health insurance plans.
Setting up the org
Note: After you start using an org, you may need to fix some configuration in the org. This need for configuration fixes is something that we will demonstrate in our example below.
1) Go to OmniStudio via the App Launcher.
2) Switch to OmniStudio FlexCards - itʼll take a while to actually load the page.
3) Once that page loads, youʼll see some warnings near the top right.
4) In another tab, open Setup.
5) Go to Remote Site Settings.
6) Edit FlexCardLightningForceURL.
7) Go back to the first tab and open the warnings.
8) Take the URL ending lightning.force.com and use this as the value for FlexCardLightningForceURL and save.
9) Edit the FlexCardVisualForceURL remote site setting and replace it with the URL ending visual.force.com from the warning.
Testing the initial org setup
1) Add a new remote site.
Remote Site Name: Weather
Remote Site URL: https://www.metaweather.com/
2) If you go back to the first tab and refresh, the warnings should be gone.
Run your first (org-to-org) deployment
1) Begin running a new comparison in Gearset.
Metadata Types: Custom Object, Custom Application, Lightning Page, Lightning Web Component
Vlocity Types: DataRaptor, IntegrationProcedure, OmniScript, VlocityCard, VlocityUILayout, VlocityUITemplate
2) Select 'Compare Now'. Upon the comparison completing to load, select some of the new and changed items.
In this example, we will be selecting these 12 new items and these 2 changed items as shown below.
3) Select 'Next' and continue through running the deployment all the way to the successful deployment screen that Gearset gives on each deployment.
Check the results
1) Go back to your org and open OmniStudio Console from the app launcher.
2) Confirm that you can see the components you've deployed.
Normally, you'd look for these by doing the following:
Switch to All Accounts.
Open an account. (It might look like this)
Based on this example, this is what we can see:
A data raptor that pulls information from the account (contact, phone, website, city)
An integration procedure that takes the account's city and gets the weather for the account
Two flex cards
A child flex card which shows the weather (on the right side)
A flex card which uses the information from the data raptor (on the left side) and contains the child flex card with the weather (on the right side)
This setup is roughly based on the content from Trailhead. For more tips, tricks, and suggestions regarding Omnistudio deployments, we recommend consulting the latest Trailhead material from Salesforce on how to keep your environment up to date with the latest features.