What is a JSON Action?

JSON actions process JSON data, and convert it into specific data objects that can be used by PhixFlow for processing. The JSON action extracts one or more records from the provided JSON object using the JSON path specified.

Creating JSON Actions

Click and drag the JSON icon from the toolbar onto the canvas
Enter a name for the JSON action, then select Create Action
In the JSON action Properties on the right, populate the following details:

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 `in.body`
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: 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
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`

Use literal values or expressions encapsulated within ${} syntax, for example ${in.MyValue}.

4. Apply and Close all settings

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.

Worked Example

This example is taken from 2.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.

Here is a worked example using the Retail Data (available from the Learning Centre) and JSON data from the UK government website (https://www.gov.uk/bank-holidays.json).

In this example, we are using:

A Shop Shipping screen containing a grid of Orders data, a grid of Order Lines data, an area containing a Date form field and buttons - this screen was created using the Multi-Tile template
A Shop Shipping Popup screen containing a grid of the bank holiday data - this screen was created using the Tile no Buttons template

If you are completing this chapter as part of the Actionflow course and using a training instance, the data and screens have already been pre-loaded into the Actionflow Intermediate Application. For these example, we'll be working on the Search button on the Shop Shipping screen, and the Shop Shipping Popup screen.

Identify Bank Holiday Dates

In this example, we'll create an Actionflow that retrieves bank holiday dates in the UK from the government website in JSON format and map this onto a screen in a grid.

Table Setup

Create a new Table on your ERD to save the bank holiday data to, and ensure it contains the following attributes:
1. Name: UID
  1. Type: String
  2. Length: 50
  3. Expression: _NULL
2. Name: Name
  1. Type: String
  2. Length: 200
  3. Expression: _NULL
3. Name: Date
  1. Type: Date
    1. Leave the Expression field blank
4. Name: Country
  1. Type: String
  2. Length: 50
    1. Leave the Expression field blank

HTTP Action Setup

On the Shop Shipping screen, add an Actionflow to the ("GetDates") button
Select Click to Connect and choose On Click
Drag a HTTP action onto the canvas and give it a suitable name - this will be used to retrieve the bank holidays from the government JSON URL
Drag the input connection point node onto the HTTP action
Click on the HTTP action to open its Properties
1. HTTP Method: GET
2. URL: https://www.gov.uk/bank-holidays.json
Drag a JSON action onto the canvas and give it a suitable name - this will be used to convert the JSON data into data suitable for our bank holiday table
Connect the out connector from the HTTP node to the JSON node
1. Map across attribute, body
  Checkpoint

JSON Action Setup

Click on the JSON action to open its Properties
1. Input Expression: in.body
2. Path: $..events
3. Output Attributes:
  Name: Country, Type: String
```
_result.^.^.division
```
  Name: Date, Type: Date
```
toDate(_result.date, "yyyy-MM-dd")
```
  Name: ID, Type: String
```
toString(_result.date, "yyyyMMdd") + substring(_result.^.^.division, 1,1)
```
  Name: Title, Type: String
```
_result.title
```
Hover over the JSON action and select out
Create a Save action
1. Primary Table: The Bank Holidays table you created earlier
2. Map across the JSON attributes to their relevant attributes on the Save action
  How?
Hover over the Save action and choose out
Create an Open Screen action to open the Shop Shipping Popup screen
Checkpoint

Screen Setup

Open the Shop Shipping Popup screen
Click on Attributes in the toolbar, then select the Bank Holidays table you created earlier
In the Available Attributes selector, select all attributes and drag them onto the screen, then choose to display the data as a Grid

Testing

Close all open screens and reopen the Shop Shipping screen
Click the button to run the Actionflow
If the Actionflow is working, the Shop Shipping Popup screen should open containing all of the bank holiday data from the government website

Background Filter and Default Sort Order

Tidy up your Shop Shipping Popup screen by hiding the UID column on the grid, adding a Default Filter to show only bank holidays in the future, and Default Sort Order to show the most recent bank holidays first.

How?

Right-click on the grid and choose, Show the View Configuration
In the Data Retrieval Options section of the Properties:
1. For Background Filter, select the icon to create a new background filter
3. For Default Sort Order, select the icon to create a new sort order

HELP100

2.14 JSON Action Configuration