Skip to main content

JPath Read

JPath Read extracts a value from a JSON document using a JPath expression.

It supports selecting:

  • Scalar values (string/number/boolean/null)
  • Objects
  • Arrays

If the selected token is an object or array, it is written as compact JSON.


Parameters

JPATH

JPath expression used to select a token from the input JSON.

Examples:

$.customer.name
$.items[0].sku
$.addresses[?(@.type == 'home')]

Required


INPUT_PARAM

Message parameter name that contains the JSON input string.

Default: INPUT


OUTPUT_PARAM

Message parameter name that receives the extracted value.

Direction: Out
Default: OUTPUT


Execution Context Behavior

  1. Reads JSON text from INPUT_PARAM.
  2. Parses the text as a JSON object.
  3. Selects a token using the JPATH expression.
  4. Converts the selected token to output:
    • Scalar value → string value
    • Object/Array → compact JSON string
    • Not found → null
  5. Writes the result to OUTPUT_PARAM.

Example Configuration

ParameterValue
JPATH$.customer.name
INPUT_PARAMINPUT
OUTPUT_PARAMCUSTOMER_NAME

Example Result

CUSTOMER_NAME = John