Skip to end of metadata
Go to start of metadata

This topic describes how to manage the API endpoint flow nodes and the connections between nodes on the API Orchestration user interface. The API Orchestration user interface is divided into the following panels: 

  • Node list (left side of the API Orchestration user interface) - Provides a graphical listing of the Model and Core nodes. The default Core nodes types are Custom, Codeblock, Compose, Condition, Delay, HTTP, JSON, and Set Context. A model node is displayed for each configured model and an endpoint 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 configuration (right side of the API Orchestration user interface) - Provides the functionality to configure the Name, Method, Parameters, and Outputs of nodes.

API Orchestration user interface example:

The procedures in this topic appear in the most probable configuration order. To manage API endpoints, refer to Manage Endpoints. To manage API endpoint flows, refer to Manage Flows.

Add nodes

To add nodes to a flow:

  1. Select the node to add to the flow from the listed nodes from the panel on the left.
  2. Drag the selected node into the flow editor panel in the center of the API Orchestration user interface. The node will automatically align with any additional nodes in the flow. A warning message may be displayed and the node may be highlighted until it is configured.

Configure nodes

To configure nodes in a flow:

  1. Select a node on the flow editor panel to configure its properties.
  2. If necessary, select and change the default node name. Node naming should reflect the function of the node.
  3. Select a Method from the Method drop-down menu. For additional information on the Model and General node Method selections, refer to Flow Orchestration.
  4. Select Parameters and complete or edit the parameter configuration entries. If selector is selected from the selector drop-down menu, as you begin typing in the parameter field, a drop-down menu of valid or previously used selector options is displayed. You may optionally choose a selector from the list, or continue typing to manually configure the parameter. For additional selector auto-complete information, refer to Selector and output auto-complete. Note that the parameter entries are dependent on the selected node method. For additional information on the Model node and General node configuration parameters, refer to Flow Orchestration.
  5. Select Outputs and complete or edit the output configuration entries. As you begin typing in the output field, a drop-down menu of valid or previously used output options is displayed. You may optionally choose a output from the list, or continue typing to manually configure the parameter. For additional information on the Model and General node output configuration for each method, refer to Flow Orchestration. Once the node is properly configured, the warning message is longer displayed and the node is longer highlighted.

Selector and output auto-complete

When you edit a selector or a output parameter. any previously used or valid selectors or outputs are displayed in a context-assisted drop-down menu that shows the selectors or outputs that match the input text. You may optionally choose a selector or output from the list, or continue typing to manually configure the parameter.

Connect nodes

Icon
All API endpoint flows begin with a default Start node.

Start nodes can only be connected to one other node in the flow. To connect the output of the Start node to the input of another node:

  1. Click on the Start node.
  2. While leaving the Start node selected, move your pointer off the Start node. The output connection on Start node and the input connections on the additional nodes in the flow will be displayed. The connector from the Start node will follow the movement of the cross-hair of your pointer.
  3. Pull the connector towards the next node to include in the flow. The connector will snap to the input of the next node to include in the flow when you hover over it.
  4. To finish the connection, drop the connector on the input of the next node in the flow. The flow is automatically rearranged according to the existing connectors and nodes.

To connect the output or outputs of a node to the input of another node:

  1. Click on the output of a node to connect to the input of another node.
  2. While leaving the output of node selected, move your pointer off the output of the node. The output connection and the input connections on the additional nodes in the flow that can be connected with will be displayed. The connector from the output of the node will follow the movement of the cross-hair of your pointer.
  3. Pull the connector towards the next node to include in the flow. The connector will snap to the input of the next node to include in the flow when you hover over it.
  4. To finish the connection, drop the connector on the input of the next node in the flow. The flow is automatically rearranged according to the existing connectors and nodes.

Delete node connectors

To delete a node connector:

  1. Select the node connector to delete.
  2. Click the keyboard Del key or Backspace key. The selected connector is deleted and the flow is automatically rearranged according to the existing connectors and nodes.

Delete nodes

To delete nodes in a flow:

  1. Select the node to delete.
  2. Click the keyboard Del key or Backspace key. The Node delete caution screen is displayed.
  3. Click Proceed to complete the deletion of the selected node and return to the flow. Select Cancel to cancel the deletion of the selected node and return to the flow.
  • No labels

14 Comments

  1. listed nodes

    listed nodes from the panel on the left

    1. I have incorporated this comment.

       

  2. Drag the selected node into the flow editor panel

    ... on the right

    1. I have incorporated this comment.

  3. Select a node to configure its properties

    Select a node on the flow editor panel to configure its properties

    1. I have incorporated this comment.

       

  4. Configure the node parameters. To configure the node parameters

    Redundant

    1. I have removed the redundancies.

  5. Beginning with API Builder V3.1.0

    Not sure if that is necessary.

  6. selector or selectors

    selector(s) ?

    1. Incorporated comment.

       

  7. You may select a selector from the listed selector options or continue typing to manually configure the selector parameter.

    You may optionally choose a selector from the list, or continue typing to manually configure the parameter.


    1. Incorporated comment.