Access Integration Procedure Data JSON with Merge Fields (Managed Package)

For the managed package runtime, enable Integration Procedure elements and element properties to access data JSON using merge fields. A merge field is a variable that references the value of a JSON node. For example, if a JSON node is "FirstName": "John", then the merge field %FirstName% returns John.

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

Merge fields access data JSON using syntax to indicate to an Integration Procedure element that a merge field is present. The syntax requires you to wrap a full JSON path with a percent sign on both ends.

Note

Only certain element properties support merge fields.

Text between two percent (%) signs in a Set Values formula or text field is treated as a merge field. To represent literal percent (%) signs, use the $Vlocity.Percent environment variable.

Common Use Cases

Setting values to rename elements, access JSON nodes, run formulas, and populate elements. See Set Values for Integration Procedures (Managed Package).
Access data stored in Integration Procedure elements in a formula or in a future step.
Access data returned from an action. For example, an Omnistudio Data Mapper Action or an HTTP Action returns data from Salesforce or an external source. See Integration Procedure Actions (Managed Package).

Access the Data JSON

Use existing data JSON in an element property by indicating the use of a merge field.

Locate the name of the JSON node in the Integration Procedure's data JSON.
Enter the name of the JSON node and wrap the name in percentage signs to indicate it's a merge field. For example, a merge field accessing a JSON node named firstName must use the syntax %firstName%.
Preview the Integration Procedure to ensure the merge field works correctly.

Additional Syntax

This table provides additional syntax examples for nested JSON.

JSON Node	Merge Field Syntax Example
`"ContactInfo": { "FirstName": "John" }`	Use a colon symbol `:` to access a nested JSON node. `%ContactInfo:FirstName%`
`"ContactInfo": { "ContactInfoList": [ { "FirstName": "John" }, { "FirstName": "Adam" }, { "FirstName": "Steve" } ] }`	Use `\|n` to access a specific node in a list. This merge field returns `Steve`: `%ContactInfo:ContactInfoList\|3:FirstName%`

JSON Node

Merge Field Syntax Example

"ContactInfo": {
    "FirstName": "John"
  }

Use a colon symbol : to access a nested JSON node.

%ContactInfo:FirstName%

 "ContactInfo": {
    "ContactInfoList": [
      {
        "FirstName": "John"
      },
      {
        "FirstName": "Adam"
      },
      {
        "FirstName": "Steve"
      }
    ]
  }

Use |n to access a specific node in a list. This merge field returns Steve:

%ContactInfo:ContactInfoList|3:FirstName%