Page History

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.

Editor_notes

Page Tree Search

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 ignore

Iulink

URL	https://inductiveuniversity.com/video/system-library
Name	System Library

Scripting_function

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.

Caution_friendly

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

Code Block
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

Expand

title	Gateway-scoped functions

Content by Label

showLabels	false
max	500
showSpace	false
sort	title
title	Gateway Scope
excludeCurrent	true
cql	label = "gateway" and ancestor = currentContent()

Expand

title	Vision-scoped functions

Content by Label

showLabels	false
max	500
showSpace	false
sort	title
title	Vision Scope
excludeCurrent	true
cql	label = "vision" and ancestor = currentContent()

Expand

title	Perspective-scoped functions

Content by Label

showLabels	false
max	500
showSpace	false
sort	title
title	Perspective Scope
excludeCurrent	true
cql	label = "perspective" and ancestor = currentContent()

system.alarm

Page Tree

root	system.alarm

system.bacnet

Page Tree

root	system.bacnet
startDepth	2

system.dataset

Page Tree

root	system.dataset
startDepth	2

system.date

Page Tree

root	system.date

system.db

Page Tree

root	system.db

system.device

Page Tree

root	system.device

system.dnp3

Page Tree

root	system.dnp3

system.eam

Page Tree

root	system.eam

system.file

Page Tree

root	system.file
startDepth	2

system.groups

Page Tree

root	system.groups
startDepth	2

system.gui

Page Tree

root	system.gui

system.math

Page Tree

root	system.math

system.nav

Page Tree

root	system.nav

system.net

Page Tree

root	system.net

system.opc

Page Tree

root	system.opc

system.opchda

Page Tree

root	system.opchda

system.opcua

Page Tree

root	system.opcua

system.perspective

Page Tree

root	system.perspective

system.print

Page Tree

root	system.print

system.project

Page Tree

root	system.project

system.report

Page Tree

root	system.report

system.roster

Page Tree

root	system.roster
startDepth	2

system.secsgem

Page Tree

root	system.secsgem
startDepth	2

system.security

Page Tree

root	system.security

system.serial

Page Tree

root	system.serial

system.sfc

Page Tree

root	system.sfc

system.tag

Page Tree

root	system.tag

system.twilio

Page Tree

root	system.twilio

system.user

Page Tree

root	system.user

system.util

Page Tree

root	system.util

OTHER USER MANUAL VERSIONS

GETTING STARTED

OTHER EDITIONS

LAUNCHERS

MODULES

PLATFORM

APPENDIX

TUTORIALS & HELPFUL TRICKS

PARTNER LINKS

RESOURCES

OTHER USER MANUALS

Offline Ignition Manual

Employees

Page History

Versions Compared

Key

System Functions

Functions by Scope

system.project