Scripting Functions

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.

Keyboard Shortcut

A complete list of these function (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!

FactoryPMI

"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.

For an overview and syntax of the scripting functions, see Scripting Overview and Syntax.

system.db

    system.alarm

      system.opc

        system.print

          system.serial

            system.user

              system.sfc

                system.twilio

                  system.gui

                    system.util

                      system.nav

                        system.report

                          system.dnp3

                            system.tag

                              system.dataset

                                system.file

                                  system.net

                                    system.security

                                      system.device

                                        system.date