Skip to content

Home

Development

IDEs

JAR services

API Explorer

Reserved variables in Flux

Flux uses predefined variables for different purposes. Some variables are used by the engine while some are populated for you for convenience purposes. Do note of these variables because they might come in handy in some cases. Also make sure that your variable names don't conflict with them.

Variable Name Data Type Description
$else String Used as a transition event to handle any undefined events.
$exception String Used as a transition event to handle any exceptions thrown by a state.
$fluxContextId Long ID of the currently running service, can be used on any state.
$fluxEvent String Used by states to know which transition to invoke next.
$fluxException GloopModel Used to identify what exception occurred on a state, available as transition input only if $exception is used.
$fluxName String Name of the currently running service, can be used on any state.
$fluxStateName String Name of the current state, can be used on any state.
$fluxTerminate GloopModel Used as a value of $fluxEvent to immediately terminate the currently running service.
$triggerFluxEvent String Event that was used to trigger the Flux service, available as Flux input.