Custom flow variables

Custom flow variables are manipulable name-value pairs by the nodes of a flow instance being executed by the flow engine.

Examples of custom flow variables are as follows:

interest.rate

message.id

myflowvar

Some custom flow variables are used for a specific purpose. The nodes of a flow can set these custom flow variables as needed. One such example is reporting metrics to a flow dashboard.
  • A node can set metrics by a flow variable named metrics.<name>
  • A node can set context information by a flow variable named context.<name>

where <name> can be anything that attaches a meaning and purpose of its usage in the flow. A node can internally set these types of custom variables as required for its reporting purposes.

Examples of such variables are:

metrics.record_count

metrics.success_count

context.campaign_id

A Parallelizer node internally sets metrics.record_count by tracking number of record sets it has processed in parallel and reports the same to the flow dashboard in real time.