Versions Compared

Old Version 24

changes.mady.by.user Zoe Baldwin

Saved on

compared with

New Version 25

changes.mady.by.user Zoe Baldwin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_Banners
_Banners
nameactionflow
nopaneltrue


 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 .

    Configuration

    The configuration of each output connection point is identical:
    Excerpt

    Overview

    Use a 

    Insert excerpt
    _action_http
    _action_http
    nopaneltrue
     to make HTTPS requests to external APIs;

    Insert excerpt
    _property_tabs
    _property_tabs
    namebasic-h
    nopaneltrue

    Basic Settings

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

    Insert excerpt
    2.13 HTTP Action Configuration
    2.13 HTTP Action Configuration
    nameBasicSettings
    nopaneltrue

    Input Connection Points

    Can Accept a single

    Insert excerpt
    _driving_input_connection_point
    _driving_input_connection_point
    nopaneltrue
    .

    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 
      Insert excerpt
      _add
      _add
      nopaneltrue
       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 
      Insert excerpt
      _delete
      _delete
      nopaneltrue
      .

    Output Connection Points

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

    Output Connection PointDescription
    OutContains the resulting record of the request. 
    ErrorContains the resulting record of the request where it satisfies the error expression specified on the HTTP Node. 

    Adding and Editing

    To add a new output path, in the section toolbar click 
    Insert excerpt
    _add_add
    nopaneltrue
    Insert excerpt
    _delete_delete
    nopaneltrue
    FieldDescriptionExample
    NameName of the outputout

    Output

    TypeA drop-down field containing: String, Raw Data, JSON.StringSkip Invalid RecordsSkip attributes which are considered invalid.enabledDefault CharsetA drop-down field containing character set options including utf-8.utf-8PathThe JSON path to apply. If empty this will default to '$' which matches the entire object.

    // $ returns everything, this syntax traverses down two levels using two full // stops.

    $..events

    JSON LenientWhen enabled this removes JSON specification restrictions, allowing for a degree of leniency in malformed JSON data. When disabled the JSON will be treated strictly.enabledAttributesContains the attributes which hold the values returned by the Output Connection Point. Result values are obtained using the keyword _result followed by the attribute name. _result.status

    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.

    Insert excerpt
    2.13 HTTP Action Configuration
    2.13 HTTP Action Configuration
    nameOutputAttributes
    nopaneltrue

    Tip

    Connect to a JSON Node or XML Node to the output connection to interpret the response into individual records.

    Headers

    Are typically used to specify information for the request such as character sets, session tokens or passwords. Headers can make use of the Secret Key Details see below. For more information see HTTP Header. 

    For example,

    • Name: Content-Type
    • Value:  text/xml; charset=UTF-8

    Secret Key Details

    Secret Keys allow sensitive data such as passwords or security tokens to be encrypted and stored in the PhixFlow Database.

    Secret keys have a name which they can be referenced by using the syntax ${_datasource.keyName}. For full details on secret keys see Secret Key and Local Secret.

    Description

    We recommend that you always enter a description to explain the purpose of this item.

    Advanced

    FieldDescription
    Connection Timeout (s)The maximum time to wait to while attempting to create a connection, measured in seconds. The default for this is set to 300 seconds.
    Response Packet Timeout (s)The maximum time to wait between responses from the data packets, measured in seconds. The default for this is set to 180 seconds.
    Prioritise throughput over ordering

    When this option is ticked records are processed in parallel to optimise performance. This means the order records are processed is nondeterministic.

    When unticked (default), records are processed in the order they are provided.



    Learn More

    For links to all pages in this topic, see Understanding Actionflows.