Package com.inductiveautomation.ignition.common.script

Class ScriptConfig

java.lang.Object

com.inductiveautomation.ignition.common.script.ScriptConfig

Direct Known Subclasses:

ClientScriptConfig, SystemEventsConfig

public class ScriptConfig
extends Object

This class is simply a storage class for the serialization of various script configuration things. An instance of this class is held by the root FPMIApp and it stores things like the startup and shutdown scripts, the keystroke scripts, and the timer scripts.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MESSAGE_SCRIPT_VALUE
protected MessageHandlerManager	messageHandlerManager
protected Map<MessageHandlerKey,String>	messageHandlerScripts
static final String	MODULE_ID
static final String	PROJECT_UPDATE_VALUE
static final ResourceType	RESOURCE_TYPE
static final String	SCHEDULED_SCRIPT_VALUE
protected ScheduledScriptManager	scheduledScriptManager
protected List<com.inductiveautomation.ignition.common.script.ScheduledScript>	scheduledScripts
static final String	SHUTDOWN_LOCATION_VALUE
protected String	shutdownScript
static final String	STARTUP_LOCATION_VALUE
protected String	startupScript
static final String	TAG_CHANGE_VALUE
protected TagChangeScriptManager	tagChangeManager
protected List<TagChangeScript>	tagChangeScripts
static final String	TIMER_SCRIPT_VALUE
protected TimerScriptManager	timerScriptManager
protected Map<TimerKey,String>	timerScripts
protected String	updateScript

Constructor Summary

Constructors

Constructor	Description
ScriptConfig()

Method Summary

Modifier and Type	Method	Description
List<ScriptExecutionReport>	getMessageHandlerExecutionReports()
MessageHandlerManager	getMessageHandlerManager()	Returns an instance of the MessageHandlerManager so that the client can register a push listener and use this manager.
List<ProjectScriptDiagnostic>	getMessageHandlerScriptDiagnostics()
Map<MessageHandlerKey,String>	getMessageHandlerScripts()
List<ProjectScriptDiagnostic>	getScheduledScriptDiagnostics()
List<com.inductiveautomation.ignition.common.script.ScheduledScript>	getScheduledScripts()
String	getShutdownScript()
String	getStartupScript()
List<ProjectScriptDiagnostic>	getTagChangeScriptDiagnostics()
List<ScriptExecutionReport>	getTagChangeScriptExecutionReports()
List<TagChangeScript>	getTagChangeScripts()
List<ProjectScriptDiagnostic>	getTimerScriptDiagnostics()
List<ScriptExecutionReport>	getTimerScriptExecutionReports()
Map<TimerKey,String>	getTimerScripts()
String	getUpdateScript()
void	invokeGWMessageHandler(String messageHandlerName, org.python.core.PyDictionary messageParams)	Deprecated.
void	invokeGWMessageHandler(String messageHandlerName, org.python.core.PyDictionary messageParams, Properties filterParams)
void	invokeGWRequestHandler(String messageHandlerName, org.python.core.PyDictionary messageParams, MessageResultHandler handler)	Deprecated.
void	invokeGWRequestHandler(String messageHandlerName, org.python.core.PyDictionary messageParams, MessageResultHandler handler, Properties filterParams)
void	setMessageHandlerScripts(Map<MessageHandlerKey,String> map)
void	setScheduledScripts(List<com.inductiveautomation.ignition.common.script.ScheduledScript> scheduledScripts)
void	setShutdownScript(String string)
void	setStartupScript(String string)
void	setTagChangeScripts(List<TagChangeScript> scripts)
void	setTagChangeScripts(Map<String,String> oldMap)	Deprecated.
void	setTimerScripts(Map<TimerKey,String> map)
void	setUpdateScript(String updateScript)
void	shutdown()	Shuts down long-running tasks in the script config, such as timer scripts and tag change scripts
void	startup(String projectName, ScriptManager manager, TagManager tagManager, IScriptsEnabled scriptsEnabled)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MODULE_ID

public static final String MODULE_ID

See Also:

• Constant Field Values

RESOURCE_TYPE

public static final ResourceType RESOURCE_TYPE

STARTUP_LOCATION_VALUE

public static final String STARTUP_LOCATION_VALUE

See Also:

• Constant Field Values

SHUTDOWN_LOCATION_VALUE

public static final String SHUTDOWN_LOCATION_VALUE

See Also:

• Constant Field Values

PROJECT_UPDATE_VALUE

public static final String PROJECT_UPDATE_VALUE

See Also:

• Constant Field Values

TAG_CHANGE_VALUE

public static final String TAG_CHANGE_VALUE

See Also:

• Constant Field Values

TIMER_SCRIPT_VALUE

public static final String TIMER_SCRIPT_VALUE

See Also:

• Constant Field Values

SCHEDULED_SCRIPT_VALUE

public static final String SCHEDULED_SCRIPT_VALUE

See Also:

• Constant Field Values

MESSAGE_SCRIPT_VALUE

public static final String MESSAGE_SCRIPT_VALUE

See Also:

• Constant Field Values

startupScript

protected String startupScript

shutdownScript

protected String shutdownScript

updateScript

protected String updateScript

timerScripts

protected Map<TimerKey,String> timerScripts

messageHandlerScripts

protected Map<MessageHandlerKey,String> messageHandlerScripts

tagChangeScripts

protected List<TagChangeScript> tagChangeScripts

scheduledScripts

protected List<com.inductiveautomation.ignition.common.script.ScheduledScript> scheduledScripts

timerScriptManager

protected transient TimerScriptManager timerScriptManager

tagChangeManager

protected transient TagChangeScriptManager tagChangeManager

messageHandlerManager

protected transient MessageHandlerManager messageHandlerManager

scheduledScriptManager

protected transient ScheduledScriptManager scheduledScriptManager

Constructor Details

ScriptConfig

public ScriptConfig()

Method Details

getShutdownScript

public String getShutdownScript()

getStartupScript

public String getStartupScript()

setShutdownScript

public void setShutdownScript(String string)

setStartupScript

public void setStartupScript(String string)

getUpdateScript

public String getUpdateScript()

setUpdateScript

public void setUpdateScript(String updateScript)

getTimerScripts

@Nonnull
public Map<TimerKey,String> getTimerScripts()

setTimerScripts

public void setTimerScripts(Map<TimerKey,String> map)

getMessageHandlerScripts

@Nonnull
public Map<MessageHandlerKey,String> getMessageHandlerScripts()

setMessageHandlerScripts

public void setMessageHandlerScripts(Map<MessageHandlerKey,String> map)

setTagChangeScripts

@Deprecated
public void setTagChangeScripts(Map<String,String> oldMap)

Deprecated.

getTagChangeScripts

@Nonnull
public List<TagChangeScript> getTagChangeScripts()

setScheduledScripts

public void setScheduledScripts(List<com.inductiveautomation.ignition.common.script.ScheduledScript> scheduledScripts)

getScheduledScripts

@Nonnull
public List<com.inductiveautomation.ignition.common.script.ScheduledScript> getScheduledScripts()

setTagChangeScripts

public void setTagChangeScripts(List<TagChangeScript> scripts)

startup

public void startup(String projectName,
 ScriptManager manager,
 TagManager tagManager,
 IScriptsEnabled scriptsEnabled)

shutdown

public void shutdown()

Shuts down long-running tasks in the script config, such as timer scripts and tag change scripts

getTimerScriptExecutionReports

public List<ScriptExecutionReport> getTimerScriptExecutionReports()

getTagChangeScriptExecutionReports

public List<ScriptExecutionReport> getTagChangeScriptExecutionReports()

getTimerScriptDiagnostics

public List<ProjectScriptDiagnostic> getTimerScriptDiagnostics()

getTagChangeScriptDiagnostics

public List<ProjectScriptDiagnostic> getTagChangeScriptDiagnostics()

getMessageHandlerScriptDiagnostics

public List<ProjectScriptDiagnostic> getMessageHandlerScriptDiagnostics()

getScheduledScriptDiagnostics

public List<ProjectScriptDiagnostic> getScheduledScriptDiagnostics()

getMessageHandlerManager

public MessageHandlerManager getMessageHandlerManager()

Returns an instance of the MessageHandlerManager so that the client can register a push listener and use this manager.

getMessageHandlerExecutionReports

public List<ScriptExecutionReport> getMessageHandlerExecutionReports()

invokeGWRequestHandler

@Deprecated
public void invokeGWRequestHandler(String messageHandlerName,
 org.python.core.PyDictionary messageParams,
 MessageResultHandler handler)
                            throws MessageHandlerException

Deprecated.

Throws:

MessageHandlerException

invokeGWRequestHandler

public void invokeGWRequestHandler(String messageHandlerName,
 org.python.core.PyDictionary messageParams,
 MessageResultHandler handler,
 Properties filterParams)
                            throws MessageHandlerException

Throws:

MessageHandlerException

invokeGWMessageHandler

@Deprecated
public void invokeGWMessageHandler(String messageHandlerName,
 org.python.core.PyDictionary messageParams)
                            throws MessageHandlerException

Deprecated.

Throws:

MessageHandlerException

invokeGWMessageHandler

public void invokeGWMessageHandler(String messageHandlerName,
 org.python.core.PyDictionary messageParams,
 Properties filterParams)
                            throws MessageHandlerException

Throws:

MessageHandlerException