system.importScript(string scriptName)

Executes a script in the current project named scriptName on the current thread. Any variables and functions declared in the target script will become accessible in the calling script.

Note: The calling script will not continue to execute until the target script finishes executing.

string scriptName: the name of the script to execute.

The value of the last expression of the specified script. For example, if the external script “myScript“ contains the following:

notification.send("In external script...");
7;

then system.importScript("myScript"); would return 7.

This can be used to pass information from the target script to the calling script.

system.runScript(scriptName)

Executes a script in the current project named scriptName.

Note: The target script will run on a separate thread. Execution of the calling script will immediately continue. The target script will not be able to access any variables defined in the calling script, and vice-versa. tag.read and tag.write are the recommended method of communication between script threads.

In most cases, it is recommended that you use system.importScript instead of system.runScript.

string scriptName: the name of the script to execute.

undefined

system.openConfig()

Opens the runtime config (3 touch) menu.

N/A

undefined

system.openXpanelManager()

Opens the Xpanel Control Center (desktop).

Note: This function does nothing in the simulator.

N/A

undefined

system.setLanguage(string language)

Sets the language used by the runtime translation feature.

string language: the name of the language to use. This should be one of the column names defined in the Translation Editor window.

undefined

system.login(string username, string password)

Immediately logs in as the specified user for the runtime IAM feature.

Note: Do not store user passwords using tags that can be accessed by other devices or by non-authorized users.

string username: the name of the IAM user to log in.

string password: the password for the specified user. If the user does not have a password, you may omit this argument or use an empty string "".

true if the user was successfully logged in, false otherwise.

Note: a return value of false typically indicates that the provided password was incorrect.

system.openLoginWindow(properties)

Opens the built-in dialog for logging in a user for the IAM system.

Note: This function does not wait for user input, nor does it return whether the user was logged in. The rest of the script will be executed immediately.

object properties (optional): an object specifying optional properties to be used for the popup. See the properties section below for details.

undefined

system.openAuthWindow(properties)

Opens the built-in dialog for authenticating a user. The user will be required to re-enter their password.Note: This function blocks the event loop.

If no user is specified, the current user will be used instead. If no user is logged in, the function will return false.

Note: This function blocks the event loop. The calling script will not continue executing until the dialog is closed.

object properties: an object specifying optional properties to be used for the popup. See the properties section below for details.

true if successfulthe user is successfully logged in, false if not otherwise.

system.logout()

Logs out the current user from the IAM system.

N/A

undefined

system.hasPermission(string permission)

Checks to see if the current user has the specified permission.

string permission: the name of the permission to check.

true if the current user has the specified permission, false if not.

system.exit()

Closes the current project and the runtime application. The gateway will also be closed if running on the same device.

N/A

undefined