Salesforce Docs Portal

Configure an Omnistudio Data Mapper Turbo Extract (Managed Package)

For the managed package runtime, to configure a Data Mapper Turbo Extract, specify the object type, filters, fields to extract, and options.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

Custom objects must have unique names and shouldn't use API names that already exist for custom objects in a managed package. Custom objects are accessed in the managed package namespace and not as an object without a namespace. For example, in the vlocity_ins__ namespace, a custom object named Policy__c is the same as the existing vlocity_ins__Policy__c.

  1. On the Extract tab, in the topmost field, select the source Salesforce object type, for example, Contact.
    The FeedComment and IdeaComment objects aren't selectable.
  2. In the next field, specify the Extract Output Path.

    This value is typically the same as the source object name. It specifies the top-level JSON node in the output.

  3. Specify at least one Filter, which determines the data to be read. The item on the left is a field of the source object type. The item in the middle is a comparison operator. The item on the right can be a quoted literal value, an input parameter, or another field of the same source object. 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.

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

    Turbo extracts have an operator option no other Data Mappers have: IN. The IN operator lets you match values to items in an array. For example, if the filter is Name IN Names, and the JSON input is {"Names": ["Miller", "Torres"]}, records with Miller or Torres in their Name fields are retrieved.

    To download a data pack of this example for either Omnistudio for Managed Packages, click here.

  4. Configure optional additional filter settings by clicking the down arrow to the right of the first filter:
    • AND - Add another filter and specify that both filters must be true.
    • OR - Add another 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. Choose OFFSET from the dropdown list and specify the name of a node in the input payload where the caller maintains a dynamic 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
      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, you can 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.

  5. Select the fields to extract by moving them from the left list to the right list. You can enter a search value to filter the left list. The Id field is always included in the output.

    To select fields in related objects, see the next section.

  6. Configure optional additional settings on the Options tab:
    • Check Field Level Security: Checks the user's access permissions for the fields before executing the Data Mapper. Enabling this setting disables the Org Cache but not the Session Cache.
    • Time To Live In Minutes: If data caching is enabled, determines how long data remains in the cache. The minimum value is 5.
    • Salesforce Platform Cache Type: Enables data caching. Set to Session Cache for data related to users and their login sessions, or to Org Cache for all other types of data. See Cache for Omnistudio Data Mappers (Managed Package).
  7. To observe the effects of caching when testing the Data Mapper Turbo Extract, go to the Preview tab and deselect the Ignore Cache checkbox. See Cache for Omnistudio Data Mappers (Managed Package).