Explore DataRaptor Features

Learning Objectives

After completing this unit, you’ll be able to:

Describe the features of the DataRaptor Designer.
Explain the purpose of formulas and functions.

Dig In to the DataRaptor Designer

When you’re ready to configure DataRaptors, you use the OmniStudio DataRaptor Designer. You can access it via the OmniStudio DataRaptors tab in the OmniStudio app. The designer has tabs too. Use the following designer tabs to specify what you want the DataRaptor to do. We are only covering the DataRaptor Extract type in this unit and we will cover the other types in later modules.

Extract tab
Formulas tab
Output tab
Options tab
Preview tab

Let’s take a closer look at each one.

Extract Tab

On the Extract tab (1), you specify the Salesforce objects you want the DataRaptor to query and the filters that determine the data to be returned from the object.

[Alt text: The Extract tab]

Formulas Tab

On the Formulas tab (2), you define formulas. Three types of DataRaptors (Extract, Transform, and Load) support formulas. When you define a formula, you map its output to the output JSON (for extracts and transforms) or Salesforce object field (for loads).

The Formulas tab

Output Tab

On the Output tab (3), you map data from the extract step JSON to the output JSON.

The Output TAB

Options Tab

On the Options tab (4), you set advanced options such as whether to check the user's access permissions for the fields before executing the DataRaptor. Set the Platform Cache Type to Session Cache for data related to users and their login sessions, or Org Cache for all other types of data. The Time to Live in Minutes setting determines how long the data remains in the cache.

The Options tab

Preview Tab

On the Preview tab (5), you test the output of the DataRaptor. You provide input parameters as Key/Value pairs and then click Execute. The result is displayed in the Response section.

The Preview tab

These tabs are fab! Now it’s time to...

Get Familiar with Functions

When you need to change the data you are working with in more complex ways than with mapping inputs and outputs, use functions.

A DataRaptor function is an equation you use for operations to do the following.

Manipulate data about date and time
String text together
Determine a result based on logic
Perform mathematical operations on numbers using fractions

Here are the types of functions available.

Function Type	Includes	Example
Numerical	+, -, *, /, ^, ROUND	Multiply the number of texts sent by the rate per text to get a total amount for a cell phone bill.
Aggregate	SUM, AVG, MAX, and MIN	A customer signs up for a flat-rate payment plan. The payment is calculated based on the average amount spent over the past 12 months.
Logical	OR, AND, and IF	If the customer is less than 18 years old, return a value of “Minor”. Otherwise, return a value of “Adult”. To make this functionality work, the function would be: IF(AGE<18, “Minor”, “Adult”).
String	CONCAT	Display city and state together, separated by a comma.
Date and Time	AGE, AGEON, DATEDIFF	TODAY() returns today’s date and NOW() returns the current date and time.

You wanted the deets on DataRaptors, and we delivered! Remember, no matter which type of DataRaptor you use, you can trust that your integrations of data will be faster to implement and easier to maintain.

Now it’s time to put what you’ve learned to use! Head to the next unit, where you learn to build a couple of different DataRaptors.