What is a HTTP Action?

Image Added

HTTP actions performs HTTP(S) requests to external APIs and returns the response.

A HTTP action has two outputs. One input request will generate one output record, which will be sent on either the out or error output. A HTTP request will be triggered for each input record and generate one output record.

The response from the server (headers and body) will be treated as the result record, with the input attributes added as passthrough fields.

Creating HTTP Actions

1. Click and drag the 

   Insert excerpt
   _http _http nopanel true

    icon from the toolbar onto the canvas
2. Enter a name for the HTTP action, then select Create Action
3. In the HTTP action 

   Insert excerpt
   _property_settings _property_settings nopanel true

    on the right, populate the following details:

4. 

5. Hover over the 

Output Connection Points

The grid contains a list of output connection points, by default this will be out and error

A HTTP action has two outputs. One input request will generate one output record, which will be sent on either the out or error output. A HTTP request will be triggered for each input record and generate one output record.

The response from the server (headers and body) will be treated as the result record, with the input attributes added as passthrough fields.

Output Attributes

The attribute expression will have access to the input (in) and an _result record.

The result record will be structured equivalently to the following JSON document (there is no requirement to actually generate a JSON string to produce the document, just conceptually this is what the string would look like and JEP should operate as if it had come from the equivalent string.

• Result fields

  • body: the response body as a string (string)

  • url: the url the request was sent to (string)

  • status: the returned status code as an in (getCode()) (int)

  • status message: the returns status message (getReasonPhase()) (string)

  • status family: the returned status code family (100, 200, 300, 400, 500) (int)

  • error: true if internalError is true, or the error expression (or default expression) returned true (TrueFalse)

  • transmissionError: true if the error was generated internally by PhixFlow (e.g. a pseudo response for connection timed out etc) (TrueFalse)

  • headers: a map of header names → array of values ( headerName : [value1, value2]} (Structured Data)

Output Record

An HTTP Node has two output connection points out and error. An HTTP Node is triggered for each input record and will generate one output record which will be sent on either the out or error output. 

The

resulting record contains the attributes specified by the output connection point, successful records are passed down the out connection point and records containing an error are passed down the error connection point. The stricture of the records by default is as follows:

1. body: The content returned by a successful request. For example, JSON content.

2. contentType: The type of response provided by the target HTTP request. For example, application/json; charset=utf-8.

3. status: the returned status code.For example, 200.

4. status message: the returns status message. For example, OK.

Headers

A table of name, value pairs. The name will be treated as a case insensitive string, the value will be treated as a template expression. Duplicate names are permitted and should result in each value being sent in the request.

Worked Example

Here is a worked example using the Shop Data (available from the Learning Centre).

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

GIF/SCREENSHOT OF FINISHED RESULT   

Identify Bank Holiday Dates

In this example, we'll create an Actionflow that checks if a new customer's name matches any existing customers, then shows this information in a pop up.

Example

Bank Holidays

Select shipment date date field (date picker), then press Ship Date which changes the status of the order and order lines to completed.
Area underneath showing upcoming bank holidays

Shop Shipping Screen

Shop Shipping Popup Screen

Table Setup

1. Create a new

   Insert excerpt
   _tables _tables nopanel true

    on your

   Insert excerpt
   _erd _erd nopanel true

    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

Initial Configuration

1. On the Shop Shipping screen, add an Actionflow to the  button ("GetDates")

2. Add an Actionflow to the button that is triggered by the button click

   Expand
   title How?
   You may notice that right-clicking the button does not display the option to add an Actionflow. The Actionflow must be created using an event handler. See 2.01 Connecting Actionflows to Events. Open the  Insert excerpt _property_settings _property_settings nopanel true  for the button and click on the  Insert excerpt _property_tabs _property_tabs name action nopanel true In the Action Settings section, choose an Action Method of Actionflow Create a new Actionflow

   
   

HTTP Action Setup

1. Select Click to Connect and choose On Click
2. Drag a 

   Insert excerpt
   _http _http nopanel true

    action onto the canvas and give it a suitable name - this will be used to retrieve the bank holidays from the government JSON URL
3. Drag the 

   Insert excerpt
   _input _input nopanel true

    connection point node onto the

   Insert excerpt
   _http _http nopanel true

    action
4. Click on the 

   Insert excerpt
   _http _http nopanel true

    action to open its Properties
   1. HTTP Method: GET
   2. URL: https://www.gov.uk/bank-holidays.json
   3. Log Traffic: 

      Insert excerpt
      _toggle_on _toggle_on nopanel true

   4. Maximum HTTP Log Length: 100000
5. Drag a 

   Insert excerpt
   _action_json _action_json nopanel true

    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
6. Connect the out connector from the HTTP node to the JSON node
7. Click on the connector between the 

   Insert excerpt
   _http _http nopanel true

    action and the

   Insert excerpt
   _action_json _action_json nopanel true

    action
   1. Map across all attributes

JSON Action Setup

1. Click on the 

   Insert excerpt
   _action_json _action_json nopanel true

    action to open its Properties
   1. Input Expression: in.body
   2. Path: $..events

   3. Output Attributes:
      

      Code Block
      theme Emacs title Name: Country, Type: String
      _result.^.^.division

      
      

      Code Block
      theme Emacs title Name: Date, Type: Date
      toDate(_result.date, "yyyy-MM-dd")

      
      

      Code Block
      theme Emacs title Name: ID, Type: String
      toString(_result.date, "yyyyMMdd") + substring(_result.^.^.division, 1,1)

      
      

      Code Block
      theme Emacs title Name: Title, Type: String
      _result.title

      
      

2. Hover over the JSON action and select out
3. Create a

   Insert excerpt
   _action_save _action_save nopanel true

    action
   1. Primary Table: Shop Bank Holidays

Save Action and Open Screen Action Setup

1. Click on the connector between the JSON action and the Save action

2. Map across the JSON attributes to their relevant attributes on the Save action

   Expand
   title How?

   
   

3. Hover over the Save action and choose out
4. Create an 

   Insert excerpt
   _action_screen _action_screen nopanel true

    action to open the Shop Shipping Popup screen

Testing

1. Close all open screens and reopen the Shop Shipping screen
2. Click the  button to run the Actionflow
3. 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

Tidy up your popup screen by adding a background filter to show the most recent bank holidays.

1. On the Shop Shipping Popup screen, configure a Background Filter on the

   Insert excerpt
   _action_view _action_view nopanel true

    Configuration to only show future dates 

   Expand
   title How?
   Right-click on the grid and choose, Show the View Configuration In the Data Retrieval Options section of the Properties, select the  Insert excerpt _addIcon _addIcon nopanel true  icon to create a new background filter

   
   

1.02 Actionflow Principles