Define the Initial Extraction (Managed Package)

For the managed package runtime, on the Extract tab, you specify the Salesforce objects to be queried and the filters that determine the data to be returned from the object. You can also specify a limit and offset for paging or a field on which to sort.

1. Click Add Extract Step and choose the source object from the dropdown list of objects.
   The FeedComment and IdeaComment objects aren't selectable.
2. Configure settings for the source object:
   • Extract Output Path: The top-level node in the JSON extraction step where you want the data to reside.

     When possible, name the Extract Output Path for the Salesforce object that is its data source. This value defines the first node of the Extract JSON Path field values on the Output tab. If the object relates to another, specify the hierarchy of the data model. For example, if your Contact object has Case as parent object, and Case has Account as parent, the extract output path is Account:Case:Contact.

   • Filter: The comparison used to determine what data is to be read. The item on the left is a field of the source object. The item in the middle is a comparison operator. The item on the right can be a quoted literal value, an input parameter, another field of the same source object, or a field of a source object in a previous extract step. To filter for null values, use the $Vlocity.NULL variable.

     You can use fields in related objects in filters, such as Parent.Name, but you have to enter them manually. For details about the notation, see Relationship Notation versus Multiple Extract Steps (Managed Package).

     The most basic filter is Id = Id, which sets the Id of the object to an input parameter named Id.

     Data Mapper Extract also supports case-sensitive filter queries using Equals, and case-insensitive filter queries using Not Equal To.

     The INCLUDES and EXCLUDES operators apply only to multi-select picklist fields. See Querying Multi-Select Picklists.

     

     Note Omnistudio Data Mapper Extract doesn’t directly support filtering on lookup fields on external objects. To filter on a lookup field on an external object, create a field on the external object and map the value of the new field to the value of the lookup field. The new field can be of any type except lookup. Then, filter on the new field. You can set the value of the new field dynamically using triggers or flows.
3. Configure optional additional filter settings by clicking the down arrow to the right of the first filter:
   • AND: Add a filter and specify that both filters must be true.
   • OR: Add a filter and specify that either filter can be true.
   • LIMIT: Specify the maximum number of records returned. Valid values are 1 through 50000; the default is 50000.
   • OFFSET: To implement paging logic, add a filter to specify where record retrieval starts. The OFFSET must be a dynamic, not a static, value. Choose OFFSET from the dropdown list and specify the name of a node in the input payload where the caller maintains the offset (for example, offsetValue).

     Use OFFSET with LIMIT to specify the first record to appear on a page in a multi-page retrieval. The offset must be an integer. For example, if the LIMIT is 5, the offsets for successive pages are 0, 5, 10, and so on.

     

     Note Salesforce imposes a 2000-record limit on queries that use OFFSET. Allowed OFFSET values are from 0 to 2000. See Workaround for offset 2000 limit on SOQL query.
   • ORDER BY: Sort the results by the specified field. To sort by multiple fields, specify a comma-separated list of field names in order of precedence, for example LastName,FirstName.

     You can optionally specify ASC or DESC for an ascending or descending sort. You can optionally specify NULLS FIRST or NULLS LAST to place blank values at the beginning or end. For example, to sort Accounts by the number of employees, listing the companies of unknown size first and the largest employers last, specify the ORDER BY value NumberOfEmployees ASC NULLS FIRST.