You are here:
Omnistudio Data Mapper Transform Data Mappings (Managed Package)
For the managed package runtime, to map data from the input to the output, go to the Output tab. You can also handle null values, data types, caching, and list transforms.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
You can map data on the Transforms tab in one of two ways:
-
If the input and output names match, Use Quick Match to Map Data (Managed Package).
-
Specify each mapping individually.
Both ways apply to JSON input and output and to other input and output types.
To specify individual mappings:
-
Click +. An empty mapping is added to the list.
-
In the Input JSON Path field, specify the input path.
-
In the Output JSON Path field, specify the desired output path.
Use colons to separate path levels, for example Contact:LastName.
Data Restructuring and Renaming
All types of Data Mappers can restructure data and rename fields using mappings. To restructure and/or rename a field, you map the input path to the desired output path.
The following example shows JSON input being mapped to XML output. The incoming top-level Case fields, CaseNumber, AccountId, and AccountName, are reparented under an XML element named <XCASEDETAILS>. Although the list of contacts is unchanged, note the difference between the representation of a list in JSON and in XML. In JSON, the Contacts list is enclosed in square brackets, [], then each item in the Contacts list is enclosed in brackets, {}. In XML, each item in the Contacts list is enclosed in a <CONTACTS> element. For details about converting between JSON and XML, see XML in Omnistudio Data Mappers (Managed Package).
For the PDF, DocuSign, and Document Template output types, output mappings are generated based on the fields in the Target Output file you selected when you created the Data Mapper Transform.
By default, if a value is null, no node is created for the field in the output JSON. To ensure that a node is created, regardless of whether the field is null, go to the Options tab and check Overwrite Target For All Null Inputs.
Input Value to Output Value Mappings
To verify that your mappings create the desired structure, go to the Preview tab, paste sample input into the Input pane on the left side of the screen, and click Execute. The results are displayed in the Response pane.
To replace one value with another, open the mapping and create entries in the Transform Map Values list. For example, if the incoming field contains TRUE or FALSE and your Omniscript requires a Y or N value, create the following entries:
Output Data Types
On the Output tab, you can specify the data type of the output data. If you change the type, be sure to choose a compatible output type. (For example, changing a numeric type to a string is fine, but changing a string to a numeric is risky, because a string can contain non-numeric characters.) See Omnistudio Data Mapper Output Data Types (Managed Package).
Data Caching
You can configure optional caching settings on the Options tab:
-
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).
