system.sfc
SFC Functions
The following functions give you access to interact with the SFCs in the Gateway.
📄️ system.sfc.cancelChart
Cancels the execution of a running chart instance.
📄️ system.sfc.getRunningCharts
Retrieves information about running charts.
📄️ system.sfc.getVariables
Get the variables in a chart instance's scope.
📄️ system.sfc.pauseChart
Pauses a running chart instance.
📄️ system.sfc.redundantCheckpoint
Synchronizes chart and step variables of the specified chart instance across a redundant cluster, allowing the chart instance to continue where it left off if a redundant failover occurs.
📄️ system.sfc.resumeChart
Resumes a chart that was paused.
📄️ system.sfc.setVariable
Sets a variable inside a currently running chart.
📄️ system.sfc.setVariables
Sets any number of variables inside a currently running chart.
📄️ system.sfc.startChart
Starts a new instance of a chart.
Functions by Scope
Chart Scope Variables
Certain chart scoped variables may interfere with the internal functions of the chart. For example, creating a variable like chart.values will conflict with a pyDictionary's values() method and therefore the chart will show an error. Since SFC charts use Python Dictionaries to manage chart scoped variables the methods associated with Python Dictionary's act like reserved words.
There are a number of built-in variables maintained by the SFC engine that can be read through the chart scope.
| Variable Name | Description |
|---|---|
| chart.instanceId | The string UUID of the running chart instance. |
| chart.startTime | A java.util.Date object that indicates when the chart instance started running. |
| chart.runningTime | An integer representing the number of seconds the chart has been running for. |
| chart.parent | The chart scope of the enclosing chart (if any). Null if this chart was not executed as part of an enclosing step. |