system.sfc.startChart
This function is used in Python Scripting.
Description
Starts a new instance of a chart. The chart must be set to "Callable" execution mode.
Client Permission Restrictions
Permission Type: SFC Management
Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.
Syntax
system.sfc.startChart(path, arguments)
Parameters
Type | Parameter | Description |
---|---|---|
String | path | The path to the chart, for example "ChartFolder/ChartName". |
Dictionary | arguments | A dictionary of arguments. Each key-value pair in the dictionary becomes a variable in the chart scope and will override any default. |
Returns
String - The unique ID of this chart.
Scope
All
Code Examples
Code Snippet
# The following will start an SFC with a dictionary of values to use inside the chart
args= {"var1":10, "Var2":15,"Var3":1}
path = "ChartFolder/ChartName"
sfcID = system.sfc.startChart(path, args)