The Ignition scripting API, which is available under the module name "system", is full of functions that are useful when designing projects in Ignition. From running database queries, manipulating components, to exporting data, scripting functions can help. Some of these functions only work in the Gateway scope, and other only work in the Client scope, while the rest will work in any scope.

Additional information on scripting Ignition can be found in the Scripting section. In this section, we cover all of the built in scripting functions available inside of Ignition. Each page will have a banner at the top that looks like this:


System Library

This function is used in Python Scripting.
This lets you know that you are looking at a function for the Python scripting language.

System Functions

You can see below there are many different categories of system functions available for your use. For an overview and syntax scripting, refer to the Python Scripting section.


Many built-in objects, such as the system library, are mutable objects. Mutable objects can be overridden within a script. For example:

system = "foo"

Doing so will prevent later lines in the script from using methods on the object. While this is expected behavior in Python, it is strongly advised to not override built-in objects. 

Functions by Scope

Gateway Scope

Vision Scope

Perspective Scope

  • No labels