How to start a DataFlow from FlowEngine

Owned by DevPortal Editor (Unlicensed)
Last updated: 19/09/23 by Onesait Platform
3 min read

In this tutorial, we will show how to run a DataFlow from the FlowEngine.

To do this, we will be using the node “Start Dataflow“ on the “Onesait Platform Dataflows“ category

Let's see how you can use that node. To do this, follow these steps:

  1. Select the "FlowEngine Management" option from the menu:

     

 

  1. Select the domain you want to work on:

     

  2. Once you are in the domain, drag a node of type "Start Dataflow" to the flow and double click on it to see its configuration properties.


    The following are the base properties:

    • Name: The name that you want the node to have when viewing it within the flow.

    • Dataflows available: List of all the Dataflows available to the user.

    • Dataflow: Dataflow selected in the previous box. This is the dataflow that will be started. If msg.dataflowIdentification exists in the incoming message and it has content, its value will be used insted of the base property.

    • Reset origin: If checked, it will reset the origin's pointer. If msg.resetOrigin exists and it has content in the incoming message, this value will be used insted of the base property.

    • Parameters: A list of properties that will be sent to the dataflow. The value of each parameter can either be a static value (string) or coming from a field of a message (msg).

      If the incoming message has the property msg.parameters defined and it has content, its value will be used instead of the node's property. The format of this field must be an JSON contaning key/value as follows:

      msg.parameters = '{"query":"where field=”value”"}'

  3. Run the dataflow
    Whenever a message reaches the node, it will try to start the selected DataFlow. The result of the operation, and its state, will be shown in the msg.payload: