Omniscript
Elements in Omniscript
Build Elements:
Actions
Display
Functions
Groups : Action Block, Block, Edit Block, Radio Group, Step, Type Ahead Block.
Inputs : Text, Text Area, checkbox,currency, custom LWC, Date, Date/Time,
Time, Disclosure, Email, File, Image, Lookup Multi-Select, Number,
Password, Radio , Range, select, Telephone, URL
Omniscripts
Omniscript input element:
Text, TextArea , Date
Properties : It is used to give the name for steps of omniscript
Name, FieldLabel, chart Label, Instruction
Step contains properties like
Button Properties, Knowledge options, Error Messages, Messaging Framework,
Conditional View
Edit Properties As JSON
Build elements
Input
Text:
For Text Elements we can give Name, fieldLabel, default Value, min,max length,
And also we have properties(elements) for inputs
Repeat settings:
Help Options: it will display message for any inputs when the users hover over
help icon and also we can give positions left, right top right, top bottom, auto
Validation Options:
In validation options we can give patterns(regex) and Pattern Error Text
Pattern:
Pattern Error Text :
Conditional view:
Text Area: It is used enter characters for description purpose
Date:
Name
Field Label
Place Holder
Default Value
Minimum Date : we cant select before date for ex:01-03-2025: it means we
can select date after 01-03, we cant select before it
Maximum Date : Today Keyword is used to select date till today current date
and before date.
Checkbox:
Name, label name
Default value and read only is available
Default is false
Disclosure:
Email: it is used to enter valid email
Password:we can set password min and max size
Telephone:it is used enter mobile number
Number: it is used to enter number , we cant enter alphabets it take only
numbers
Radio:
Display mode : vertical horizontal, image and button
Open source: custom , manual , Sobject
sObject source: by using source we can access any object picklist values
in source field we have to give Api name of object and field(Ex: Account.Rating,
student__c.id__c)
for object : Account.Rating
for Apex :className.methodName and we have to implements an Interface to
class
Ex :
global class getPicklistValue implements OmniStudio.vLocityOpenInterface
here OmniStudio is package name
for object select sObject
for apex select custom
select : we can display object picklist value as radio but display mode is not
available because it display as dropdown
multi-select: we can select more than 1 value picklist value
currency : in this we can enter currency
in currency, we have to give Name Field Label
in format options :
custom Mask : we can give decimal numbers our own
format override decimal places
2 or 3 whatever u can give
And also we have
Minimum currency value and Maximum Currency value
We can check
Allow Negative Numbers
Hide Comma Seperators
Display currency code
To change currency code we can apply currency code in Setup (Properties right
side)
Range:
It contains Name, Field Label, Default Value, Mask, step , Minimum Value,
Maximum Value
Time:
It contains Name, Field Label, Placeholder, Required, Read only, Default Value,
Minimum Time , Maximum Time, Time Format (hh:mm a) , Time Interval
Time Format (hh:mm a): to show time in AM and PM
Time Interval : to display Time format based on Time Interval
Ex: if Time Interval is 15 it will display 15,30,45.
URL:
It contains Name, Field Label, Placeholder, Required, Read only, Default Value
Lookup:
Allows users to search for and select records from a list or database.
Configure the lookup to pull data from a specific Salesforce object (like
Accounts, Contacts, Products) or other sources.
It contains Name , Field Lable, Placeholder, Required, Read Only, Clear Value,
Default Value, open source Type( custom, sObject, Picklist Filtered By Record
Type), source
For custom
For SObject
Add lookup query
Preview and search lookup
We can also search dynamically
Filter value : Name(it is used for dynamic search)
Line break:
it contains Name, additional padding px(ex: 30)
text Block:
It contains Name , text
Here %FirstNames% is the Api Name of any input Name
It will display the text in the text block whatever we enter in FirstNames
omniscript
elements.pdf
Go to omniscription dropdown tab search for data mappers
Click on new
Save it
To retrieve the data follow below steps
Next go to preview
Click edit as params and give key value pair like
Key:AccountId value:001IU00002phUa9YAE and execute it, u will get below
data
Related object
If you want to get account owner data
Click on Related object select
Account.Owner
In search field you can see the data select and move it
Account.Username
Go to preview and execute
Extract mapper contains
Extract, Formulas, Output, Options, Preview
Go to extract do following
In Output click + icon
Give the Output JSON Path any Name
Add one more output click on + icon
Go to preview
Give the key and value and excecute
Key always be the filter name whatever we have give in extract output path
AccountId and give any AccountId
To get the related object contact records data
Go to extract add extract
Select object Contact
Extract Output Path = Contact
Filter=AccountId (It is lookup of Contact and Account)
Last box is Extract Output Path Account and Filter Name of Account
Account:Id
Output
Go to preview and execute
Formulas in extract
Requirement is to show today date
Click on add formula
Formula Result path can be any Name
In output
You can give any Output JSON path name and you can give Output data type
Next go to preview and execute
If else in formula
Formula
Output
preview
Load DataRaptor
Here we are creating new contact record with the Load DataRaptor
Create a mapper with any Name and save
It has Objects, Formulas , Fields, Options, Preview
Go to Object and add object
Select ->Contact
Add Fields
Give Input JSON path and Domain Object Field
Go to preview and add JSON in Input to execute
After execute 1 contact id is create , you can click on Id to navigate to Contact
record page
You can insert or update with Load raptor
Go to fields click on +
Input JSON Path = ContactId
Domain Object Field =Id
Check Upsert checkbox
Go to preview
Add ContactId in Input as JSON
And Change FirstName from “Demo” to “Test”
We can create contact by giving JSON Input in Fields
In right side you can see Contact Info
Click on + icon and add all 4 fields of Contact Info one by one
• ContactInfo:Email LastName
• ContactInfo:FirstName FirstName
• ContactInfo:LastName LastNameContactInfo:
• Telephone Phone
Go to preview and add that JSON Input and execute
The new contact record is created
We can link multiple objects here
Go to Objects and add Object
Select Account object and drag it above contact as given below and click on
add link
Go to fields and add Name in Input JSON Path
Go to preview and execute
Account and Contact is created
Now we will create multiple contacts for Account
Create new Load Raptor
Add Object Account and Contact
Add link
Go to fields
Create field for Account
Create field for contact
To create multiple contact record we have to add List:FirstName and
List:LastName for Input JSON Path
Go to preview
Give the account Name and contact as an Array of list as given below
Execute it and you can see 1 Account and 3 Contacts are created
Next is how to create 3 accounts and 1 contact
In Fields
For Accounts
For Contacts
In preview
Next scenario is how to add 1 contact in account
Go to fields add fields in account
For contact fields
In preview
Give JSON input and execute
Transform DataRaptor
Create Transform DataRaptor
Go to Transform
Go to preview , give JSON input and execute
You can see output in right side
Next is to show True and False value(Boolean)
Go to transform add on field
Give
Input Json Path -> Contact:Rating
Output JSON Path->PersonalInfo:Rating
Output Data Type ->Boolean
In Transform Map Values
Add New key/value pair
Key=Hot and Value=True as shown below
In preview give JSON input and execute
If rating is Hot
If Rating Cold
To add country code to phone number we can use Formula
Transform
Formulas
Go to transform
Add Formula Result path in Transform field
In Preview add PhoneNumber in JSON input and execute
Next scenario
when json input coming from different different objects ,so how to collect in
single object
go to transform field
In preview write JSON Input
Set Value:
Create new Omniscripts
Next add set value from action elements in step
Next click on add New Element and save
Add 1 textblock input
Also we can use expression for value in add element and can give Element
Name to textblock %Addition% to display
Set error
Create new omniscript
