system.util
Utility Functions
The following functions give you access to view various Gateway and Client data, as well as interact with other various systems.
📄️ audit
Inserts a record into an audit profile.
📄️ execute
Executes the given commands via the operating system, in a separate process.
📄️ getGatewayStatus
Returns a string that indicates the status of the Gateway.
📄️ getGlobals
This method returns a dictionary that provides access to the legacy global namespace.
📄️ getLogger
Returns a Logger object that can be used to log messages to the console.
📄️ getModules
Returns a dataset of information about each installed module.
📄️ getProjectName
Returns the name of the project that is currently being run.
📄️ getProperty
Retrieves the value of a named system property.
📄️ getSessionInfo
Returns a PyDataSet holding information about all of the open Designer sessions and Vision Clients.
📄️ getVersion
Returns the Ignition version number that is currently being run.
📄️ invokeAsynchronous
Invokes (calls) the given Python function on a different thread.
📄️ jsonDecode
Takes a JSON string and converts it into a Python object such as a list or a dictionary.
📄️ jsonEncode
Takes a Python object such as a list or dictionary and converts into a JSON string.
📄️ modifyTranslation
This function allows you to add or modify a global translation.
📄️ queryAuditLog
Queries an audit profile for audit history.
📄️ sendMessage
This function sends a message to clients running under the Gateway, or to a project within the Gateway itself.
📄️ sendRequest
This function sends a message to the Gateway, working in a similar manner to the sendMessage function, except sendRequest expects a response to the message.
📄️ sendRequestAsync
This function sends a message to the Gateway and expects a response.
📄️ setLoggingLevel
Sets the logging level on the given logger.
📄️ threadDump
Creates a thread dump of the current running JVM.
📄️ translate
This function allows you to retrieve the global translation of a term from the translation database using the current locale.