---
schema_version: "1"
id: 07bdeac12992dbc63a4360ad5527b268ed2d829237f8d5fd788cb9221a20d876
title: Configure a Data Mapper Turbo Extract
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_configure_a_dataraptor_turbo_extract_45667.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_configure_a_dataraptor_turbo_extract_45667.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 36e394470250e58543f3cdf50121dcc933f89fabde0cc6b6e2446f2a118e1701
description: To configure a Data Mapper Turbo Extract, specify the object type, filters, fields to extract, and options.
products:
  - Omnistudio
release: "264"
---
# Configure a Data Mapper Turbo Extract

To configure a Data Mapper Turbo Extract, specify the object type, filters, fields to extract, and options.

1. From the App Launcher, find and select **Data Mappers**.
2. Select the Data Mapper Turbo Extract that you want to configure.
3. Search and select an extraction object.
4. Enter an extraction object path.
5. Add required filters that determine the data to be read. To filter for null values, use the `$Vlocity.NULL` variable.
    
    The most basic filter is `Id = Id`, which sets the ID of the object to an input parameter ID. The `INCLUDES` and `EXCLUDES` operators apply only to multiselect picklist fields. See [Querying Multi-Select Picklists](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_querying_multiselect_picklists.htm) in Salesforce Help.
    
    Turbo Extract has an additional operator option `IN`. The `IN` operator lets you match values to items in an array. For example, if the filter is `LastName IN Names`, and the JSON input is `{"Names": ["Miller", "Torres"]}`, it retrieves all records with Miller or Torres in their LastName fields.
    
    Data Mapper Turbo Extract doesn't support multiple input fields with single quotation marks in the field values. Use a Data Mapper Extract instead. For instance, adding one input called FirstName with the value T’an, and another input called LastName with the value C’os, isn’t supported on a Data Mapper Turbo Extract.
6. To configure additional filters, click the down arrow: <table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
            <tbody><tr class="">
              <th style="vertical-align:top;" headers="d73991e105-option" id="d73991e109">
                <strong class="uicontrol">AND</strong>
              </th>

              <td style="vertical-align:top;" headers="d73991e105-desc d73991e109">Add another filter and specify that both filters must be true</td>

            </tr>
            <tr class="">
              <th style="vertical-align:top;" headers="d73991e105-option" id="d73991e121">
                <strong class="uicontrol">OR</strong>
              </th>

              <td style="vertical-align:top;" headers="d73991e105-desc d73991e121">Add another filter and specify that either filter can be true.</td>

            </tr>
            <tr class="">
              <th style="vertical-align:top;" headers="d73991e105-option" id="d73991e133">
                <strong class="uicontrol">LIMIT</strong>
              </th>

              <td style="vertical-align:top;" headers="d73991e105-desc d73991e133">Specify the maximum number of records returned. Valid values are 1 through
                50000; the default is 50000.</td>

            </tr>
            <tr class="">
              <th style="vertical-align:top;" headers="d73991e105-option" id="d73991e145">
                <strong class="uicontrol">OFFSET</strong>
              </th>

              <td style="vertical-align:top;" headers="d73991e105-desc d73991e145">
                <p>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,
                  <code>offsetValue</code>).
                </p>
                <p>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.</p>
                <div class="slds-box slds-box_x-small slds-theme_shade slds-m-top_medium slds-m-bottom_medium">
                  <div class="slds-media slds-media_responsive">
                    <div class="slds-media__figure"><span class="slds-icon_container slds-icon_container_circle slds-icon-note-note"><img style="margin-bottom:0;" src="https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio-264-0-0-production-enus/f526eaa8-ae05-487a-8944-4bb99b0b78ac/images/icon_note.png" alt="Note"></span></div>
                    <div class="slds-media__body" style="padding-top:.5rem;padding-bottom:.5rem;" id="os_configure_a_dataraptor_turbo_extract_45667__UUID-1aa94ebf-82a3-604c-0631-e1b54183c79d_note-idm263221291092488"><a name="os_configure_a_dataraptor_turbo_extract_45667__UUID-1aa94ebf-82a3-604c-0631-e1b54183c79d_note-idm263221291092488"><!-- --></a><span class="slds-text-title_caps">Note</span>
                      Salesforce imposes a 2000-record limit on queries that use OFFSET. Allowed
                      OFFSET values are from 0 to 2000. See <a href="https://help.salesforce.com/s/articleView?id=000387840&amp;type=1&amp;language=en_US" target="_blank">Workaround for offset 2000 limit on SOQL
                        query</a>.</div>
                  </div>
                </div>

              </td>

            </tr>
            <tr class="">
              <th style="vertical-align:top;" headers="d73991e105-option" id="d73991e173">
                <strong class="uicontrol">ORDER BY</strong>
              </th>

              <td style="vertical-align:top;" headers="d73991e105-desc d73991e173">
                <p>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 <code>LastName,FirstName</code></p>
                <p>You
                  can optionally specify ASC for ascending sort or DESC for 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 <code>NumberOfEmployees ASC NULLS FIRST</code>.</p>
              </td>

            </tr>
            <tr class="">
              <th style="vertical-align:top;" headers="d73991e105-option" id="d73991e197">
                <strong class="uicontrol">DELETE</strong>
              </th>

              <td style="vertical-align:top;" headers="d73991e105-desc d73991e197">Remove a filter.</td>

            </tr>
          </tbody></table>
7. To retrieve data from a parent of the primary object, select related objects. For example, `Contact.Account`. For information about the notation, see [Relationship Notation versus Multiple Extract Steps](https://help.salesforce.com/s/articleView?id=xcloud.os_relationship_notation_versus_multiple_extract_steps_45995.htm&release=264.0.0&type=5 "Using relationship notation improves the performance of Omnistudio Data Mappers that retrieve data from a parent of the primary object. Use this notation in the Extract JSON Paths for the parent object's fields instead of adding a second object in the Data Mapper's Extract tab.").
    
    After you select a relationship with another object, its fields appear in Available Fields. Clicking these fields reveals second-level relationships, enabling navigation through five levels. To go back a level, simply click the list and select the previous level.
8. In Field Mapping, search for the available fields. This option isn’t available if you’re using the designer on a managed package.
9. Select the fields that you want to extract, and move them from Available to Selected Fields. The Id field is always included in Selected Fields.
10. Click **Options**, and configure additional settings:
    1. Specify the number of minutes that the cached value is retained in the org cache or session cache, if data caching is enabled. The minimum value is 5 minutes.
    2. To enable data caching, choose a cache type from the Salesforce Platform Cache Type picklist. See [Improving Data Mapper Performance with Caching](https://help.salesforce.com/s/articleView?id=xcloud.os_cache_for_dataraptors_and_integration_procedures_48057.htm&release=264.0.0&type=5 "Omnistudio offers multiple caching options to improve performance and minimize unnecessary data processing in Data Mappers. The two primary user-configurable caching types are Org Cache and Session Cache, which are available in the Data Mapper designer. These caching mechanisms are part of the Salesforce Platform Cache and are implemented through Scale Cache in Omnistudio with standard runtime. Each serves a distinct purpose and comes with specific configuration considerations.").
        
        **None** - Disables data caching for this Data Mapper.
        
        **Session Cache** - Data related to users and their login sessions.
        
        **Org Cache** - All other types of data.
    3. To check the user's access permissions for the fields before executing the Data Mapper, select **Check field level security before execution**. Selecting this option disables the Org Cache, but not the Session Cache.
    4. To include null values in the Data Mapper response, select **Include null values in the response**.
    5. Save your changes.
11. To observe the effects of caching when testing the Data Mapper Turbo Extract, deselect **Ignore Cache**. See [Improving Data Mapper Performance with Caching](https://help.salesforce.com/s/articleView?id=xcloud.os_cache_for_dataraptors_and_integration_procedures_48057.htm&release=264.0.0&type=5 "Omnistudio offers multiple caching options to improve performance and minimize unnecessary data processing in Data Mappers. The two primary user-configurable caching types are Org Cache and Session Cache, which are available in the Data Mapper designer. These caching mechanisms are part of the Salesforce Platform Cache and are implemented through Scale Cache in Omnistudio with standard runtime. Each serves a distinct purpose and comes with specific configuration considerations.").

## Related Object Fields in Omnistudio Data Mapper Turbo Extracts

Although a Data Mapper Turbo Extract retrieves from a single object type, you can select specific fields in related objects.

For more information about relationship names and other relevant topics, see [Relationship Queries](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_relationships.htm) in Salesforce Help. Data Mappers support only child-to-parent relationship queries.

When you click the Related Objects dropdown list, relationships to other objects appear, for example:

![Selecting Account lists Account relationships.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio-264-0-0-production-enus/f526eaa8-ae05-487a-8944-4bb99b0b78ac/omnistudio/images/ro_level1.png)

If you select one of those relationships and click the list again, second-level relationships to other objects appear, for example:

![Selecting Account.CreatedBy lists relationships to objects that represent people who create Accounts.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio-264-0-0-production-enus/f526eaa8-ae05-487a-8944-4bb99b0b78ac/omnistudio/images/ro_level2.png)

You can traverse up to five relationship levels.

To back up a level, click the list and select the previous level, for example:

![Select Account again to return to the list of Account relationships.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio-264-0-0-production-enus/f526eaa8-ae05-487a-8944-4bb99b0b78ac/omnistudio/images/ro_uplevel.png)

After you’ve selected a relationship with another object, fields in that object appear in the left field-selection list. You can enter a search value and move the fields to the right list as you would the base object fields.