Versions Compared

Key

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

...

The API Orchestration user interface is accessed from the APIs List page on the API Builder Console by selecting a Flow icon or a Create Flow icon for a generated or imported endpoint depending upon the current endpoint status. The API Orchestration user interface is divided into the following panels: 

  • Node Flow-node list (left side of the API Orchestration user interface) - Provides a graphical listing of the Model and Core flow-nodes. The default Core nodes flow-node types are: Custom, Codeblock, Compose, Condition, Delay, HTTP, JSON, and Set Context. A model flow-node is displayed for each configured model and an endpoint flow-node is displayed for each imported endpoint.
  • Flow editor (center of the API Orchestration user interface) - Provides a graphical space to view, edit, and create flows.
  • Node Flow-node configuration (right side of the API Orchestration user interface) - Provides the functionality to configure the Name, Method, Parameters, and Outputs of flow-nodes.

This topic is divided into the following sections:

Table of Contents
maxLevel3

Model flow-node

The Model flow-node methods, parameters, and outputs are described in the following sections.

...

The method selections for a Model flow-node are:

  • count - Gets a count of records.
  • create - Creates a new model object.
  • delete - Deletes the model object.
  • deleteAll - Deletes all the model objects.
  • distinct - Finds unique values using the provided field.
  • findAll - Finds all model instances.
  • findAndModify - Finds one model instance and modifies it.
  • findByID - Finds model instance by ID.
  • query - Queries for particular model records.
  • update - Updates a model instance.
  • upsert - Creates a model record if not found, or updates the model record if found.

Parameters

The Model flow-node parameters are described in the following sections.

...

ParameterTypeConfiguration selections
dataobjectSelector, Object

Outputs

The Model flow-node outputs are described in the following sections.

...

OutputTypeDescriptionSave output value as:
updateobjectSuccessfully updated the model.$.model
insertobjectSuccessfully inserted the model.$.model

Codeblock flow-node

The Codeblock flow-node methods, parameters, and outputs for the Greet Codeblock flow-node are described in the following sections. Each method in a Codeblock node Codeblock flow-node corresponds to a single codeblock. The Greet Codeblock flow-node is created when a new application is created, but it can be deleted.

...

The default method for the Greet Codeblock flow-node is:

  • Greet - Some codeblock to run with the greet flow.

...

OutputTypeDescriptionSave output value as:
next
stringThe codeblock completed.
$.greeting
error
objectThe codeblock failed to complete.
$.error

Condition flow-node

The Condition flow-node methods, parameters, and outputs are described in the following sections.

...

The default methods for a Condition flow-node are:

  • equals - Tests is a value is equal.
  • exists - Tests does a value exists, true or false.
  • greater-than - Tests is a value is greater than another value.
  • greater-than-equal - Tests is a value is greater than or equal to another value.
  • less-than - Tests is a value is less than another value.
  • less-than-equal - Tests is a value is less than or equal to another value.

...

ParameterTypeMinimum lengthDescriptionConfiguration selection
sourceany1The input to test.Selector, String, Number, Boolean, Object, Array, Null
valueany1The value to test input against.Selector, String, Number, Boolean, Object, Array, Null

Outputs

The Condition flow-node outputs are described in the following sections.

...

OutputTypeDescriptionSave output value as:
truebooleanThe condition tested true.$.lessThanEqual
falsebooleanThe condition tested false.$.lessThanEqual

Delay flow-node

The Delay flow-node method, parameter, and output are described in the following sections.

Method

The method for a Delay flow-node is:

  • delay - Wait for a certain amount of time before continuing to the next flow-node.

Parameter

The Delay flow-node parameter is described in the following section.

...

ParameterTypeDefaultDescriptionConfiguration selection
delayinteger-The length of delay, in milliseconds.Selector, Number

Output

The Delay flow-node output is described in the following section.

...

OutputTypeDescriptionSave output value as:
nextintegerThe delay is completed.$.delayed

HTTP flow-node

Method

The method for a HTTP flow-node is:

  • setHTTPResponse

Parameter

The HTTP flow-node parameter is described in the following section.

...

The body and headers parameters can be enabled or disabled.

Output

The HTTP flow-node output is described in the following section.

...

The setHTTPResponse method does not have any configurable outputs.

Set Context flow-node

The Set Context flow-node method, parameter, and output are described in the following sections.

...

The method for a Set Context flow-node is:

  • setContext

Parameter

The Set Context flow-node parameter is described in the following section.

...

ParameterTypeDefaultDescriptionConfiguration selection
valueany--Selector, String, Number, Boolean, Object, Array, Null

Output

The Set Context flow-node output is described in the following section.

...

OutputTypeDescriptionSave output value as:
nextany--

Custom flow-nodes

Custom flow-nodes which are not built into the API Builder Console can be created and installed. Axway provides three custom flow-nodes with new projects and more planned for the future. The custom flow-node handlers are created and their methods, parameters, and outputs are defined using the Axway Flow SDK. For additional information, see Axway Flow SDK.

The custom flow-nodes currently provided with a new project are:

Anchor
Base64
Base64
Base64 flow-node

The flow-node methods, parameters, output for the Base64 flow-node are described in the following sections. The Base64 flow-node is created when NPM installs the nodehandler-base64 code. The Base64 flow-node is included in the default application, but it can be removed.

Methods

The Base64 flow-node default methods are:

  • Decode - Decodes base64 encoded data.
  • Encode - Encodes base64 data.

Parameters

The Base64 flow-node parameters are described in the following sections.

...

ParameterTypeDescriptionConfiguration selection
data
anyThe data to encode.Selector, String, Number, Boolean, Object, Array, Null

Outputs

The Base64 flow-node outputs are described in the following sections.

...

OutputTypeDescriptionSave output value as:
Encoded
stringThe base64 encoded data.
$.b64data

Anchor
Compose
Compose
Compose flow-node

The Compose flow-node methods, parameters, and outputs are described in the following sections. The Compose flow-node is created when NPM installs the nodehandler-dot code. The Custom Compose flow-node is included in the default application, but it can be removed.

...

The default methods for a Compose flow-node are:

  • Format object - Compose an object by evaluating a template. The evaluated template is JSON parsed and so must be a valid JSON encoded string.
  • Format string - Compose a string by evaluating a template.

Parameters

The Compose flow-node parameters are described in the following sections.

...

ParameterTypeDescriptionConfiguration selection
dataobjectThe data to evaluate the template with. Use $ to access the entire context.Selector, Object
templatestringThe doT template.Selector, String

Outputs

The Compose flow-node outputs are described in the following sections.

...

OutputTypeDescriptionSave output value as:
Next
any-
$.value
Error
anyThis output is triggered if the evaluated template is not valid. The output value is error object.
$.error

Anchor
JSON
JSON
JSON flow-node

The JSON flow-node methods, parameters, and output are described in the following sections. The JSON flow-node is created when NPM installs the nodehandler-json code. The JSON flow-node is included in the default application, but it can be removed.

...

The default methods for a JSON flow-node are:

  • Parse - The parse method parses a JSON string, constructing the JavaScript value or object described by the string.
  • Stringify - The stringify method converts a JavaScript value to a JSON string.

Parameters

The JSON flow-node parameters are described in the following sections.

...

The space parameter can be enabled or disabled.

Outputs

The JSON flow-node outputs are described in the following sections.

...