Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview


Use a  Loop Node to process JSON in string format, and convert it into specific data objects that can be used by PhixFlow for processing. The JSON Action Node extracts one or more records from the provided JSON object using the JSON path specified.

 Properties Tab

Basic Settings

Expect literal values or expressions encapsulated within ${} syntax, for example ${in.MyValue}. A worked example of the JSON Action is provided at the end of this page.

FieldDescriptionExample Value
NameName given to the action node. This will be displayed on the actionflow canvas.MyJSONReader
Input Expression

The input expression provides the JSON data to be operated upon. Typically this will be a simple expression pointing at an incoming attribute such as the body from an HTTP Action or the body from an API request.

// consist of the name of the pipe and the name of a // mapped attribute.

in.body

Use Strict JSON parsing

Defines the parsing of the JSON, disabled will be lenient and enabled will be strict.

Lenient parsing relaxes validation allowing the following to be present in the JSON data:

  • Use of single quotes, for example: {'name': 'Some “quotes” in a string'}
  • Unquoted field names, for example:  {name: “value”}
  • Unescaped control characters, including literal new lines to appear within a string.
  • Allow trailing commas {“name”: ”value”,}

// leaving the default option

Disabled.

Path

The JSON Path expression is evaluated against the data provided by the Input Expression and returns a list of JSON node items.

It can be used to specify which nodes are extracted from the JSON.

// JSON Path

$.main_page.title

Input Connection Points

Can Accept a single  Driving input connection point.

The grid contains a list of all input connection points and their type.

  • To add a new input connection point, in the section toolbar click  Add New to open a new input connection point and set its properties; see Input Connection Points.
  • To edit an existing input connection point, double-click it in the list to open its properties.
  • To remove an input connection point, select one and in the section toolbar click  Delete.

Output Connection Points

This section has a toolbar with standard buttonsThe grid contains a list of all output connection points.

  • To add a new output path, in the section toolbar click  Add New to open a new output path and set the expression; see Output Connection Points.
  • To edit an existing output path, double-click it in the list to open its properties.
  • To remove an output path, select one and in the section toolbar click  Delete.

Output Attributes

JSON is converted into data objects that can be used by PhixFlow, this information is accessed using the syntax, _result.AttributeName.

Worked Example

Below is an example JSON object passed to the JSON Action Node:

Example JSON
// Example JSON string.
{
    "main_page": {
        "page": "PF Main Page",
        "title": {
            "name": "PF Title Text",
            "data": [
                {"initials": "AA", "value" : "Alistair Andrews"},
                {"initials": "BB", "value" : "Bert Brown"}
            ]
        }
    }
}


JSON Path$.main_page.title

This path will bring back all elements matching the JSON path including the parent/grandparents and all child elements. The path defines the starting point from which we reference the JSON nodes.

The following examples show how to reference the returned JSON data:

  1. _result.namereturns PF Title Text
  2. _result.^.page, returns PF Main Page
    1. The ^ traverses up the JSON hierarchy. 
  3. listToString(_result.data.initials)returns "AA, BB"
    1. Because there are multiple JSON nodes under  _result.data.initialsan array of data is returned. See Array Handling Functions.


Note the use of

  • ^ traverses up the hierarchy 1 layer.
  • . tranverses down the heirach 1 layer.


  • No labels