How Do I Use Labels?
What Are Labels?
Labels let you provide special attributes on any given state which can then be used for reporting. There are four pre-built labels you can use:
-
CRITICAL_PATH_START - this signifies that the state is the start of a critical path in a flow.
-
CRITICAL_PATH_END - similar to the above, this specifies the end of the defined critical path in a flow.
-
WAITING_STATE - this specifies the state as one you’d expect to be 'waiting' in, and is typically used for determining various graphs that wish to exclude waiting time.
-
HTM - this specifies that, when in this state, the in-flight payment/transaction is currently with HTM. Note: this label is only available when using the HTM flo client.
When a label is added to the state, it’s included as part of the descriptor for the model and is therefore published as part of the initiation event. ODS uses this to determine how it sets up metrics processing.