Configuring an Omnistudio Data Mapper Data Source (Managed Package)

For the managed package runtime, configure a Data Mapper data source to fetch data from a Data Mapper Extract.

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

Data Mapper is a mapping tool that enables you to read, transform, and write Salesforce data. See Data Mapper Overview.

Note

For optimal flexibility and easier implementation, use an Integration Procedure as a data source to execute multiple actions in a single server call. See Configuring an Integration Procedure Data Source (Managed Package).

To use a Data Mapper Extract as a data source for a layout or card:

1. On the Vlocity Cards tab, click New to configure a data source for a new cards component, or select an existing component to configure its data source.
2. In the Cards Designer, in the Layout or Cards pane, from the Data Source picklist, select Data Mapper.
3. Enter the Interface Name of a Data Mapper Extract.
4. Click +Add Input Map Variable and add one or more name-value pairs to pass to the Data Mapper.

   For example, to use the Page Parameters {{params}} context variable to dynamically get the ContextId of your layouts and cards:

   1. Open your Data Mapper, click the Preview tab to view the Input Parameters.

      

      Tip

      To quickly access the Data Mapper, click the link icon next to the Interface Name.

   2. In the Data Source section of your card or layout, in the first field of the Input Map, enter the key of the Input Parameter, such as AccountId.

   3. In the second field of the Input Map, enter {{params.id}} as the value. Parameters passed to the page are stored in the {{params}} context variable for use anywhere in the Vlocity Cards framework. In this case, your card or layout inherits the Id of the record page it's on in order to dynamically populate the cards with that record's data.

5. (Optional). Enter values for these properties:

   • To drill down to a specific dataset, in the Result JSON Path field, enter a path. For example, enter records.results, which drills down to the results array and passes the array to the card or card layout.

   • To sort data by a specific data field, enter the field name in the Order By input field.

   • To reverse the order of the data returned, select True from the Reverse Order picklist.

     

   • Set a Timeout value in milliseconds.

     The timeout value controls the time that the framework waits for the designated data source to return a response. Timeouts improve handling user interactions with long running processes. Setting an appropriate timeout value allows the application and users to react accordingly to long wait times.

   • Set an Interval value in milliseconds.

     The card component's data source refreshes continuously at the given interval and checks for changes in data source records. If changes are found, the layout or card component reloads. Setting an interval enables recursive updates of records.

6. To preview a card using real data, add a test variable in the Test Data Source Settings fields.