You are here:
Omnistudio Data Mapper Extract Overview (Managed Package)
For the managed package runtime, Data Mapper Extracts read Salesforce data and return results in JSON, XML, or custom formats. You can filter the data and select the fields to return. Formulas, attributes, default values, and translations are supported. Extracts typically provide Omniscripts, Integration Procedures, and Cards with the data they require.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
To define a Data Mapper extract:
- Create the Data Mapper extract. See Creating a Data Mapper Extract
- Configure the initial extraction. See Define the Initial Extraction (Managed Package).
- Determine whether you need multiple extract steps or relationship notation. See When to Use Multiple Extract Steps (Managed Package) and Relationship Notation versus Multiple Extract Steps (Managed Package).
- (Optional) Add data using formulas. See Use Formulas in Omnistudio Data Mappers (Managed Package).
- Compose the output. See Defining the Output of an Extract.
- Test the Data Mapper. See Test an Omnistudio Data Mapper Extract (Managed Package).
- Create an Omnistudio Data Mapper Extract (Managed Package)
For the managed package runtime, to create a Data Mapper Extract, specify its name, input and output types, and permissions. - 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. - When to Use Multiple Extract Steps (Managed Package)
For the managed package runtime, how many extract steps you need depends on how the object types you are extracting from are related. There are three basic scenarios: single, single with relationship notation, and multiple. - Relationship Notation versus Multiple Extract Steps (Managed Package)
For the managed package runtime, using relationship notation improves the performance of Omnistudio Data Mappers that retrieve data from a parent of the primary sObject. You use this notation in the Extract JSON Paths for the parent sObject's fields instead of adding a second sObject in the Data Mapper's Extract tab. Two examples illustrate how to use relationship notation. - Omnistudio Data Mapper Extract Output (Managed Package)
For the managed package runtime, to map data from the extraction step JSON to the output JSON, go to the Output tab. You can also handle null values, attributes, translations, field-level permissions, caching, and list transforms. - Test an Omnistudio Data Mapper Extract (Managed Package)
For the managed package runtime, you can test the input and output of a Data Mapper Extract on the Preview tab. - Omnistudio Data Mapper Extract Examples (Managed Package)
For the managed package runtime, Data Mapper Extract examples demonstrate object relationships, paging with data values, paging with offsets, working with attributes, and relationship notation.
Løste denne artikel dit problem?
Giv os besked, så vi kan forbedre os!
