You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.

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.

Keyboard Shortcut

A complete list of these functions (with their definitions) is available wherever you can add a script. Just type system. and then press Ctrl+Space to get a list of all the functions available. If you keep typing, the list will even be automatically narrowed down for you!

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.

  • No labels