In this tutorial, we will show how to check the status of a DataFlow from the FlowEngine.
We will be using the node “Check Dataflow Status“ on the “Onesait Platform Dataflows““ category
Let's see how we can use that node. To do this, we will follow the following steps:
Select the "FlowEngine Management" option from the menu:
Select the domain belonging to your user:
Once you are in the domain, drag a node of type "Check Dataflow Status" to the flow and double click on it to see its 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 dataflows availables by the user
Dataflow: Dataflow selected in the previous box. This dataflow is the one that will be started. If msg.dataflowIdentification has content, this will be used insted of the base property.
Wait until Status: It will allow us to configura a single execution from an incoming message (none option) or a scheduled periodic polling for a status value. The options are:
none: Default node behaviour. It will check the status only if there is an incoming message
interval: It will check the status every time you configure since the last deploy instant
interval between times: It wil set a scheduled check in a crontab like manner.
at specific time: It will schedule one status check at a given time.
If any of the scheduled options is selected, two more properties will appear:Status: It will only generate an output if the DataFlow is in the specified status.
Restart checking status after receiving a message. If marked, it will restart the scheduled status check after a msg is received. If not, the shceduled task will be done after deployment.
Stop after first match. It will stop the scheduler once the given status has matched after one execution. If the schedured has stopped it will ve indicated in the node status as follows:
Waiting for status/scheduler running
Status found/scheduler stopped
Run the dataflow
Whenever a message reaches the node (or the scheduler runs matching the statuses), it will try to check the selected DataFlow’s status. The result of the execcion (and its state) will be shown in the msg.payload:
