Package com.inductiveautomation.sfc.scripting

Interface SfcScriptingFunctions

All Known Subinterfaces:
SfcRpcFunctions
All Known Implementing Classes:
ClientScriptingFunctions
public interface SfcScriptingFunctions

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancelChart(UUID instanceId)
    Cancels the chart instance indicated by instanceId.
    void
    debugResume(UUID instanceId)
    Sends a message to the chart instance stopped at a breakpoint to resume normal operations.
    void
    debugStep(UUID instanceId)
    Sends a message to the chart instance stopped at a breakpoint to step to the next step.
    List<ChartInfo>
    getRunningCharts()
    Returns information about the currently running charts.
    List<ChartInfo>
    getRunningCharts(String chartPath)
    Returns information about the currently running instances of a given chart path.
    PyChartScope
    getVariables(UUID instanceId)
    Returns the chart scope for the specified instance.
    void
    pauseChart(UUID instanceId)
    Pause the chart instance indicated by instanceId.
    void
    redundantCheckpoint(UUID instanceId)
    For charts that have the "redundancy sync" setting enabled, this method synchronizes chart and step variables of the specified chart instance across the redundant cluster, allowing the instance to continue where it left off if a redundant failover occurs.
    void
    resumeChart(UUID instanceId)
    Resume the chart instance indicated by instanceId.
    void
    setVariables(UUID instanceId, UUID stepId, org.python.core.PyObject variableMap)
     
    void
    setVariables(UUID instanceId, org.python.core.PyObject variableMap)
    Updates the chart indicated by instanceId by copying all of the variables from the provided variableMap into the chart's scope.
    UUID
    startChart(String projectName, String chartPath, Map<String,Object> parameters)
    Start a Chart in Project projectName from the definition at chartPath.
    UUID
    startChart(String chartPath, Map<String,Object> parameters)
    Deprecated.
    use startChart(String, String, Map) instead.

  • Method Details

    • startChart

      @Deprecated UUID startChart(String chartPath, Map<String,Object> parameters) throws Exception
      Deprecated.
      use startChart(String, String, Map) instead.
      Start a chart in Project Project.GLOBAL_PROJECT_NAME from the definition at chartPath.
      Parameters:
      chartPath - the path to the chart definition.
      parameters - the parameters passed to the chart scope.
      Returns:
      The UUID of the running chart instance.
      Throws:
      Exception

    • startChart

      UUID startChart(String projectName, String chartPath, Map<String,Object> parameters) throws Exception
      Start a Chart in Project projectName from the definition at chartPath.
      Parameters:
      projectName - the name of the project the chart definition resides in.
      chartPath - the path to the chart definition.
      parameters - the parameters passed to the chart scope.
      Returns:
      The UUID of the running chart instance.
      Throws:
      Exception

    • cancelChart

      void cancelChart(UUID instanceId) throws Exception
      Cancels the chart instance indicated by instanceId.
      Parameters:
      instanceId - the UUID of the chart instance to stop.
      Throws:
      Exception

    • pauseChart

      void pauseChart(UUID instanceId) throws Exception
      Pause the chart instance indicated by instanceId.
      Parameters:
      instanceId - the UUID of the chart instance to pause.
      Throws:
      Exception

    • resumeChart

      void resumeChart(UUID instanceId) throws Exception
      Resume the chart instance indicated by instanceId.
      Parameters:
      instanceId - the UUID of the chart instance to resume.
      Throws:
      Exception

    • debugStep

      void debugStep(UUID instanceId) throws Exception
      Sends a message to the chart instance stopped at a breakpoint to step to the next step.
      Throws:
      Exception

    • debugResume

      void debugResume(UUID instanceId) throws Exception
      Sends a message to the chart instance stopped at a breakpoint to resume normal operations.
      Throws:
      Exception

    • getRunningCharts

      List<ChartInfo> getRunningCharts() throws Exception
      Returns information about the currently running charts.
      Returns:
      Chart information about all of the currently running charts.
      Throws:
      Exception

    • getRunningCharts

      List<ChartInfo> getRunningCharts(String chartPath) throws Exception
      Returns information about the currently running instances of a given chart path.
      Throws:
      Exception

    • setVariables

      void setVariables(UUID instanceId, org.python.core.PyObject variableMap)
      Updates the chart indicated by instanceId by copying all of the variables from the provided variableMap into the chart's scope.
      Parameters:
      instanceId - the of the chart instance to update.
      variableMap - a dictionary containing key-value pairs of serializable things to update in chart scope.

    • setVariables

      void setVariables(UUID instanceId, UUID stepId, org.python.core.PyObject variableMap)

    • getVariables

      PyChartScope getVariables(UUID instanceId) throws Exception
      Returns the chart scope for the specified instance. Step scopes for active steps are found under the "activeSteps" key.
      Throws:
      Exception

    • redundantCheckpoint

      void redundantCheckpoint(UUID instanceId) throws Exception
      For charts that have the "redundancy sync" setting enabled, this method synchronizes chart and step variables of the specified chart instance across the redundant cluster, allowing the instance to continue where it left off if a redundant failover occurs.
      Parameters:
      instanceId - the UUID of the chart instance to update.
      Throws:
      Exception - if the redundant peer is not set up or connected, or if the chart does not have redundancy sync enabled.