You are here:
Map Inputs and Outputs for Transformations
To map data from the input to the output, go to the Transform tab. If you're using the designer on a managed package, go to the Output tab. You can also handle null values, data types, caching, and list transforms.
You can map data by using one of these methods:
-
Use Quick Match to quickly map input and output data in a Data Mapper Transform. See Use Quick Match to Map Data.
-
Specify each mapping individually using the Create Mapping option.
Both methods apply to JSON input and output and to other input and output types.
Data Restructuring and Renaming
All types of Data Mappers can restructure data and rename fields using mappings. To restructure or rename a field, you map the input path to the desired output path.
This 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 and JSON in Omnistudio Data Mappers.
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 select Include null values in the response.
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 verify that your mappings create the desired structure and output, go to the Preview tab, paste the sample input into the Input pane in the correct format, and click Execute. The results appear in the Response pane. The Data Mapper Transform generates the desired output only if the input data format is correct. For example, for the Date data type, you must enter the supported format, which is mm/dd/yyyy or yyyy-mm-dd.
To define key value pairs for the output, open the mapping, go to Transform Map Values, and enter values in the Key Value pair fields. For example, if the incoming field contains TRUE or FALSE, and your OmniScript requires a Y or N value, enter TRUE or FALSE in the Key field, and Y or N in the Value field, respectively.
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.
Data Caching
You can configure optional caching settings on the Options tab:
Time To Live In Minutes: If data caching is enabled, it 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 Improving Data Mapper Performance with Caching.
Maintain List Order When Combining Multiple Inputs
When you map multiple input lists to the same output list in a Data Mapper Transform, the system does not guarantee the order of the items in the output. The results may vary between executions.
To ensure a predictable and consistent order, use a formula to combine and filter the lists instead of using direct mappings.
Example Scenario
You have three input lists: inputList1, inputList2, and
inputListNew. You want to combine them into a single
OutputList where the items from inputList1 always appear
first, followed by inputList2, and then inputListNew.
Required Configuration
- Remove direct mappings: Remove any individual mappings that target the
OutputList. - Add a formula: On the Formulas tab, create a formula to merge the lists in your preferred order.
| Formula | Formula Result Path | Description |
|---|---|---|
LIST(inputList1, inputList2, inputListNew) |
CombinedList | Merges the lists in the exact order specified. |
FILTER(LIST(inputList1, inputList2, inputListNew), "PolicyNumber !=
null") |
OutputList | Merges the lists in order and excludes items with null Policy Numbers. |
Mapping the Result
On the Transforms tab, map the result of your formula to the final output path.
| Input JSON Path | Output JSON Path |
|---|---|
| OutputList | OutputList |
- Use Quick Match to Map Data
Quick Match is an easy way to map input and output data in an Omnistudio Data Mapper Transform. - Transforming Lists with Data Mappers
Data Mappers can perform list transformations. For mapping input to output, Data Mappers require a list input in which every value is paired with a key.
