Version: 7.9

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.

📄️ system.util.beep

Tells the computer to make a "beep" sound.

📄️ system.util.execute

Executes the given commands via the operating system, in a separate process.

📄️ system.util.exit

Exits the running client, as long as the shutdown intercept script doesn't cancel the shutdown event.

📄️ system.util.getAvailableLocales

Returns a collection of strings representing the Locales added to the Translation Manager, such as 'en' for English.

📄️ system.util.getAvailableTerms

Returns a collection of available terms defined in the translation system.

📄️ system.util.getClientId

Returns a hex-string that represents a number unique to the running client's session.

📄️ system.util.getConnectionMode

Retrieves this client session's current connection mode.

📄️ system.util.getConnectTimeout

Returns the connect timeout in milliseconds for all client-to-gateway communication.

📄️ system.util.getEdition

Returns the Edition of the Vision client - standard, limited, or panel.

📄️ system.util.getGatewayAddress

Returns the address of the gateway that the client is currently communicating with.

📄️ system.util.getGatewayStatus

Returns a string that indicates the status of the Gateway.

📄️ system.util.getGlobals

This method returns a dictionary that provides access to the legacy global namespace.

📄️ system.util.getInactivitySeconds

Returns the number of seconds since any keyboard or mouse activity.

📄️ system.util.getLocale

Returns the current string representing the user's Locale, such as 'en' for English.

📄️ system.util.getLogger

Returns a Logger object that can be used to log messages to the console.

📄️ system.util.getProjectName

(The first sentence of the page's description)

📄️ system.util.getProperty

(The first sentence of the page's description)

📄️ system.util.getReadTimeout

Returns the read timeout in milliseconds for all client-to-gateway communication.

📄️ system.util.getSessionInfo

Returns a PyDataSet holding information about all of the sessions (logged-in users) on the Gateway.

📄️ system.util.getSystemFlags

Returns an integer that represents a bit field containing information about the currently running system.

📄️ system.util.invokeAsynchronous

This is an advanced scripting function. Invokes (calls) the given Python function on a different thread.

📄️ system.util.invokeLater

This is an advanced scripting function. Invokes (calls) the given Python function object after all of the currently processing and pending events are done being processed, or after a specified delay.

📄️ system.util.jsonDecode

Takes a json String and converts it into a Python object such as a list or a dict.

📄️ system.util.jsonEncode

Takes a Python object such as a list or dict and converts into a json string.

📄️ system.util.modifyTranslation

This function allows you to add or modify a global translation.

📄️ system.util.playSoundClip

Plays a sound clip from a wav file to the system's default audio device.

📄️ system.util.queryAuditLog

Queries an audit profile for audit history.

📄️ system.util.retarget

This function allows you to programmatically 'retarget' the Client to a different project and/or different Gateway.

📄️ system.util.sendMessage

This function sends a message to clients running under the Gateway, or to a project within the Gateway itself.

📄️ system.util.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.

📄️ system.util.sendRequestAsync

This function sends a message to the Gateway and expects a response.

📄️ system.util.setConnectionMode

Sets the connection mode for the client session.

📄️ system.util.setConnectTimeout

Sets the connect timeout for client-to-gateway communication.

📄️ system.util.setLocale

Sets the user's current Locale.

📄️ system.util.setLoggingLevel

Sets the logging level on the given logger.

📄️ system.util.setReadTimeout

Sets the read timeout for Client-to-Gateway communication.

📄️ system.util.threadDump

Creates a thread dump of the current running JVM.

📄️ system.util.translate

This function allows you to retrieve the global translation of a term from the translation database using the current locale.

Functions by Scope

Gateway

Vision

Designer

Utility Functions​