Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
What is a JSON Action?
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Creating JSON Actions
- Click and drag the
icon from the toolbar onto the canvasInsert excerpt _action_json _action_json nopanel true - Enter a name for the JSON action, then select Create Action
- In the JSON action
on the right, populate the following details:Insert excerpt _property_settings _property_settings nopanel true
Field | Description | Example Value | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
Name | Name given to the JSON 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 a HTTP Node. In PhixFlow version 11.1 onwards, this field is mandatory. | // Consists of the name of the connector and mapped attribute
| ||||||||
Use Strict JSON parsing | Defines the parsing of the JSON. Disabled is lenient and enabled is strict. Lenient parsing relaxes validation allowing the following to be present in the JSON data:
| // Leaving the default option
| ||||||||
Path | The JSON Path expression is evaluated against the data provided by the Input Expression and returns a list of JSON elements. It determines which elements are extracted from the JSON. The path starts at the root element represented by $ and each element in the path is separated by a full stop. The ^ traverses up a node and a . traverses down the node. Note that the path determines the number of nodes that are processed, which directly correlates to the number of records returned by the JSON action. For example, if the path returns the root element of the JSON, only one record will be returned. Whereas a path that returns children nodes will return one record for each child element. | // JSON Path $.main_page.title |
Tip |
---|
Use literal values or expressions encapsulated within ${} syntax, for example |
4.
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Path Syntax
Expression | Description |
---|---|
| symbol refers to the root element. |
@ | symbol refers to the current element. |
. | is the dot-child operator, which is used to denote a child element of the current element. |
[ ] | is used to select a child element of the current element (by name or index number). |
* | a wildcard, returning all elements regardless of their name. |
^ | symbol is used to traverse up 1 element in the JSON hierarchy from child to parent. |
Output Attributes
JSON is converted into data objects that can be used by PhixFlow, this information is accessed using the syntax, _result.
ElementName.
HTML Comment | ||
---|---|---|
| ||
ZB I think the references to elements on this page should be replaced with references to "keys". JSON comes in key/value pairs in the syntax "key":"pair" - see https://www.w3schools.com/js/js_json_syntax.asp. Need to read up on this and make changes to this page. |
HTML Comment | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Worked Example
Note |
---|
This example is taken from 2.12 13 HTTP Action Configuration. If you have already completed this chapter as part of the Actionflow course, ensure you are familiar with the content before moving onto the next chapter. |
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|