Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



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:


Scroll HTML Exporter Ignore


Iulink
URLhttps://inductiveuniversity.com/video/system-library
NameSystem Library

 




Scripting_function


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!
 

Info
titleFactoryPMI

"I'm upgrading from FactoryPMI - will my calls to fpmi.* still work?"

Yes. Ignition's scripting API is backwards compatible. You'll probably want to gradually move your "fpmi" references to "system" but you don't need to.

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.

system.alarm

Page Tree
rootsystem.alarm

system.dataset

Page Tree
rootsystem.dataset
startDepth2

system.date

Page Tree
rootsystem.date

system.db

Page Tree
rootsystem.db

system.device

Page Tree
rootsystem.device

system.dnp3

Page Tree
rootsystem.dnp3

system.eam

Page Tree
rootsystem.eam

system.file

Page Tree
rootsystem.file
startDepth2

system.groups 

Page Tree
rootsystem.groups
startDepth2

system.gui

Page Tree
rootsystem.gui

system.math

Page Tree
rootsystem.math

system.nav

Page Tree
rootsystem.nav

system.net

Page Tree
rootsystem.net

system.opc

Page Tree
rootsystem.opc

system.opchda

Page Tree
rootsystem.opchda

system.print

Page Tree
rootsystem.print

system.report

Page Tree
rootsystem.report

system.security

Page Tree
rootsystem.security

system.serial

Page Tree
rootsystem.serial

system.sfc

Page Tree
rootsystem.sfc

system.tag

Page Tree
rootsystem.tag

system.twilio

Page Tree
rootsystem.twilio

system.user

Page Tree
rootsystem.user

system.util

Page Tree
rootsystem.util