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.
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.
📂 system.alarm
📂 system.dataset
📂 system.date
📂 system.db
📂 system.device
📂 system.dnp3
📂 system.eam
📂 system.file
📂 system.groups
📂 system.gui
📂 system.math
📂 system.nav
📂 system.net
📂 system.opc
📂 system.opchda
📂 system.print
📂 system.report
📂 system.secsgem
📂 system.security
📂 system.serial
📂 system.sfc
📂 system.tag
📂 system.twilio
📂 system.user
📂 system.util
Functions by Scope​
Gateway
- alarm.acknowledge
- alarm.cancel
- alarm.createRoster
- alarm.getRosters
- alarm.getShelvedPaths
- alarm.listPipelines
- alarm.queryJournal
- alarm.queryStatus
- alarm.unshelve
- dataset.addColumn
- dataset.addRow
- dataset.addRows
- dataset.appendDataset
- dataset.clearDataset
- dataset.dataSetToExcel
- dataset.dataSetToHTML
- dataset.deleteRow
- dataset.deleteRows
- dataset.filterColumns
- dataset.formatDates
- dataset.fromCSV
- dataset.getColumnHeaders
- dataset.setValue
- dataset.sort
- dataset.toCSV
- dataset.toDataSet
- dataset.toPyDataSet
- dataset.updateRow
- date.add*
- date.*Between
- date.format
- date.fromMillis
- date.get*
- date.getDate
- date.getTimezone
- date.getTimezoneRawOffset
- date.getTimezoneOffset
- date.isAfter
- date.isBefore
- date.isBetween
- date.isDaylightTime
- date.midnight
- date.now
- date.parse
- date.setTime
- date.toMillis
- db.addDatasource
- db.beginTransaction
- db.clearAllNamedQueryCaches
- db.clearNamedQueryCache.md
- db.closeTransaction
- db.commitTransaction
- db.createSProcCall
- db.dateFormat
- db.execSProcCall
- db.getConnectionInfo
- db.getConnections
- db.refresh
- db.removeDatasource
- db.rollbackTransaction
- db.runNamedQuery
- db.runPrepQuery
- db.runPrepUpdate
- db.runQuery
- db.runSFPrepUpdate
- db.runSFUpdateQuery
- db.runScalarPrepQuery
- db.runScalarQuery
- db.runUpdateQuery
- db.setDatasourceConnectURL
- db.setDatasourceEnabled
- db.setDatasourceMaxConnections
- device.addDevice
- device.listDevices
- device.refreshBrowse
- device.removeDevice
- device.setDeviceEnabled
- device.setDeviceHostname
- dnp3.directOperateAnalog
- dnp3.directOperateBinary
- dnp3.freezeAnalogs
- dnp3.freezeAnalogsAtTime
- dnp3.freezeCounters
- dnp3.freezeCountersAtTime
- dnp3.selectOperateAnalog
- dnp3.selectOperateBinary
- eam.getGroups
- eam.queryAgentHistory
- eam.queryAgentStatus
- eam.runTask
- file.fileExists
- file.getTempFile
- file.readFileAsBytes
- file.readFileAsString
- file.writeFile
- groups.loadFromFile
- groups.removeGroups
- gui.chooseColor
- gui.closeDesktop
- gui.confirm
- gui.convertPointToScreen
- gui.getOpenedWindowNames
- gui.isTouchscreenModeEnabled
- math.geometricMean
- math.kurtosis
- math.max
- math.mean
- math.meanDifference
- math.median
- math.min
- math.mode
- math.normalize
- math.percentile
- math.populationVariance
- math.product
- math.skewness
- math.standardDeviation
- math.sum
- math.sumDifference
- math.sumLog
- math.sumSquares
- math.variance
- nav.centerWindow
- net.getHostName
- net.getIpAddress
- net.getRemoteServers
- net.httpDelete
- net.httpGet
- net.httpPost
- net.httpPut
- net.sendEmail
- opc.browse
- opc.browseServer
- opc.browseSimple
- opc.getServerState
- opc.getServers
- opc.isServerEnabled
- opc.readValue
- opc.readValues
- opc.setServerEnabled
- opc.writeValue
- opc.writeValues
- opchda.browse
- opchda.getAggregates
- opchda.getAttributes
- opchda.getServers
- opchda.insert
- opchda.insertReplace
- opchda.isServerAvailable
- opchda.readAttributes
- opchda.readProcessed
- opchda.readRaw
- opchda.replace
- report.executeAndDistribute
- report.executeReport
- report.getReportNamesAsDataset
- report.getReportNamesAsList
- secsgem.deleteToolProgram
- secsgem.getResponse
- secsgem.getToolProgram
- secsgem.getToolProgramDataset
- secsgem.sendRequest
- secsgem.sendResponse
- secsgem.startSimEventRun
- secsgem.toDataset
- secsgem.toTreeDataset
- security.getUsername
- security.isScreenLocked
- security.logout
- security.validateUser
- serial.closeSerialPort
- serial.configureSerialPort
- serial.openSerialPort
- serial.readBytes
- serial.readBytesAsString
- serial.readLine
- serial.readUntil
- serial.sendBreak
- serial.write
- serial.writeBytes
- sfc.cancelChart
- sfc.getRunningCharts
- sfc.getVariables
- sfc.pauseChart
- sfc.redundantCheckpoint
- sfc.resumeChart
- sfc.setVariable
- sfc.setVariables
- sfc.startChart
- tag.addTag
- tag.browseConfiguration
- tag.browseHistoricalTags
- tag.browseTags
- tag.browseTagsSimple
- tag.editAlarmConfig
- tag.editTag
- tag.editTags
- tag.exists
- tag.getAlarmStates
- tag.isOverlaysEnabled
- tag.loadFromFile
- tag.queryTagCalculations
- tag.queryTagDensity
- tag.queryTagHistory
- tag.read
- tag.readAll
- tag.removeTag
- tag.removeTags
- tag.scan
- tag.storeTagHistory
- tag.write
- tag.writeAll
- tag.writeAllSynchronous
- tag.writeSynchronous
- twilio.getAccounts
- twilio.getAccountsDataset
- twilio.getPhoneNumbers
- twilio.getPhoneNumbersDataset
- twilio.sendSms
- user.addHoliday
- user.addRole
- user.addSchedule
- user.editHoliday
- user.editRole
- user.editSchedule
- user.getHoliday
- user.getHolidayNames
- user.getHolidays
- user.getRoles
- user.getSchedule
- user.getScheduleNames
- user.getScheduledUsers
- user.getSchedules
- user.getUser
- user.getUsers
- user.isUserScheduled
- user.removeHoliday
- user.removeRole
- user.removeSchedule
- util.execute
- util.getGlobals
- util.getLocale
- util.getLogger
- util.getProjectName
- util.getProperty
- util.getSessionInfo
- util.invokeAsynchronous
- util.jsonDecode
- util.jsonEncode
- util.sendMessage
- util.sendRequest
- util.sendRequestAsync
- util.setConnectTimeout
- util.setConnectionMode
- util.setLoggingLevel
- util.threadDump
Vision
- alarm.acknowledge
- alarm.cancel
- alarm.createRoster
- alarm.getRosters
- alarm.getShelvedPaths
- alarm.listPipelines
- alarm.queryJournal
- alarm.queryStatus
- alarm.unshelve
- dataset.addColumn
- dataset.addRow
- dataset.addRows
- dataset.appendDataset
- dataset.clearDataset
- dataset.dataSetToExcel
- dataset.dataSetToHTML
- dataset.deleteRow
- dataset.deleteRows
- dataset.exportCSV
- dataset.exportExcel
- dataset.exportHTML
- dataset.filterColumns
- dataset.formatDates
- dataset.fromCSV
- dataset.getColumnHeaders
- dataset.setValue
- dataset.sort
- dataset.toCSV
- dataset.toDataSet
- dataset.toPyDataSet
- dataset.updateRow
- date.add*
- date.*Between
- date.format
- date.fromMillis
- date.get*
- date.getDate
- date.getTimezone
- date.getTimezoneRawOffset
- date.getTimezoneOffset
- date.isAfter
- date.isBefore
- date.isBetween
- date.isDaylightTime
- date.midnight
- date.now
- date.parse
- date.setTime
- date.toMillis
- db.addDatasource
- db.beginTransaction
- db.clearAllNamedQueryCaches
- db.clearNamedQueryCache.md
- db.closeTransaction
- db.commitTransaction
- db.createSProcCall
- db.dateFormat
- db.execSProcCall
- db.getConnectionInfo
- db.getConnections
- db.refresh
- db.removeDatasource
- db.rollbackTransaction
- db.runNamedQuery
- db.runPrepQuery
- db.runPrepUpdate
- db.runQuery
- db.runSFPrepUpdate
- db.runSFUpdateQuery
- db.runScalarPrepQuery
- db.runScalarQuery
- db.runUpdateQuery
- db.setDatasourceConnectURL
- db.setDatasourceEnabled
- db.setDatasourceMaxConnections
- device.addDevice
- device.listDevices
- device.refreshBrowse
- device.removeDevice
- device.setDeviceEnabled
- device.setDeviceHostname
- dnp3.directOperateAnalog
- dnp3.directOperateBinary
- dnp3.freezeAnalogs
- dnp3.freezeAnalogsAtTime
- dnp3.freezeCounters
- dnp3.freezeCountersAtTime
- dnp3.selectOperateAnalog
- dnp3.selectOperateBinary
- eam.getGroups
- eam.queryAgentHistory
- eam.queryAgentStatus
- eam.runTask
- file.fileExists
- file.getTempFile
- file.openFile
- file.openFiles
- file.readFileAsBytes
- file.readFileAsString
- file.saveFile
- file.writeFile
- gui.chooseColor
- gui.closeDesktop
- gui.color
- gui.confirm
- gui.convertPointToScreen
- gui.createPopupMenu
- gui.desktop
- gui.errorBox
- gui.findWindow
- gui.getCurrentDesktop
- gui.getDesktopHandles
- gui.getOpenedWindowNames
- gui.getOpenedWindows
- gui.getParentWindow
- gui.getQuality
- gui.getScreens
- gui.getSibling
- gui.getWindow
- gui.getWindowNames
- gui.inputBox
- gui.isTouchscreenModeEnabled
- gui.messageBox
- gui.openDesktop
- gui.openDiagnostics
- gui.passwordBox
- gui.setScreenIndex
- gui.setTouchscreenModeEnabled
- gui.showNumericKeypad
- gui.showTouchscreenKeyboard
- gui.transform
- gui.warningBox
- math.geometricMean
- math.kurtosis
- math.max
- math.mean
- math.meanDifference
- math.median
- math.min
- math.mode
- math.normalize
- math.percentile
- math.populationVariance
- math.product
- math.skewness
- math.standardDeviation
- math.sum
- math.sumDifference
- math.sumLog
- math.sumSquares
- math.variance
- nav.centerWindow
- nav.closeParentWindow
- nav.closeWindow
- nav.desktop
- nav.getCurrentWindow
- nav.goBack
- nav.goForward
- nav.goHome
- nav.openWindow
- nav.openWindowInstance
- nav.swapTo
- nav.swapWindow
- net.getExternalIpAddress
- net.getHostName
- net.getIpAddress
- net.getRemoteServers
- net.httpDelete
- net.httpGet
- net.httpPost
- net.httpPut
- net.openURL
- net.sendEmail
- opc.browse
- opc.browseServer
- opc.browseSimple
- opc.getServerState
- opc.getServers
- opc.isServerEnabled
- opc.readValue
- opc.readValues
- opc.setServerEnabled
- opc.writeValue
- opc.writeValues
- opchda.browse
- opchda.getAggregates
- opchda.getAttributes
- opchda.getServers
- opchda.insert
- opchda.insertReplace
- opchda.isServerAvailable
- opchda.readAttributes
- opchda.readProcessed
- opchda.readRaw
- opchda.replace
- print.createImage
- print.createPrintJob
- print.printToImage
- report.executeAndDistribute
- report.executeReport
- report.getReportNamesAsDataset
- report.getReportNamesAsList
- secsgem.deleteToolProgram
- secsgem.copyEquipment
- secsgem.enableDisableEquipment
- secsgem.getResponse
- secsgem.getToolProgram
- secsgem.getToolProgramDataset
- secsgem.sendRequest
- secsgem.startSimEventRun
- secsgem.toDataset
- secsgem.toTreeDataset
- security.getRoles
- security.getUserRoles
- security.getUsername
- security.isScreenLocked
- security.lockScreen
- security.logout
- security.switchUser
- security.unlockScreen
- security.validateUser
- serial.closeSerialPort
- serial.configureSerialPort
- serial.openSerialPort
- serial.readBytes
- serial.readBytesAsString
- serial.readLine
- serial.readUntil
- serial.sendBreak
- serial.write
- serial.writeBytes
- sfc.cancelChart
- sfc.getRunningCharts
- sfc.getVariables
- sfc.pauseChart
- sfc.redundantCheckpoint
- sfc.resumeChart
- sfc.setVariable
- sfc.setVariables
- sfc.startChart
- tag.addTag
- tag.browseConfiguration
- tag.browseHistoricalTags
- tag.browseTags
- tag.browseTagsSimple
- tag.editAlarmConfig
- tag.editTag
- tag.editTags
- tag.exists
- tag.getAlarmStates
- tag.isOverlaysEnabled
- tag.loadFromFile
- tag.queryTagCalculations
- tag.queryTagDensity
- tag.queryTagHistory
- tag.read
- tag.readAll
- tag.removeTag
- tag.removeTags
- tag.scan
- tag.setOverlaysEnabled
- tag.storeTagHistory
- tag.write
- tag.writeAll
- tag.writeAllSynchronous
- tag.writeSynchronous
- twilio.getAccounts
- twilio.getAccountsDataset
- twilio.getPhoneNumbers
- twilio.getPhoneNumbersDataset
- twilio.sendSms
- user.addHoliday
- user.addRole
- user.addSchedule
- user.editHoliday
- user.editRole
- user.editSchedule
- user.getHoliday
- user.getHolidayNames
- user.getHolidays
- user.getRoles
- user.getSchedule
- user.getScheduleNames
- user.getScheduledUsers
- user.getSchedules
- user.getUser
- user.getUsers
- user.isUserScheduled
- user.removeHoliday
- user.removeRole
- user.removeSchedule
- util.beep
- util.execute
- util.exit
- util.getAvailableLocales
- util.getAvailableTerms
- util.getClientId
- util.getConnectTimeout
- util.getConnectionMode
- util.getEdition
- util.getGatewayAddress
- util.getGatewayStatus
- util.getGlobals
- util.getInactivitySeconds
- util.getLocale
- util.getLogger
- util.getProperty
- util.getReadTimeout
- util.getSessionInfo
- util.getSystemFlags
- util.invokeAsynchronous
- util.invokeLater
- util.jsonDecode
- util.jsonEncode
- util.modifyTranslation
- util.playSoundClip
- util.queryAuditLog
- util.retarget
- util.sendMessage
- util.sendRequest
- util.sendRequestAsync
- util.setConnectTimeout
- util.setConnectionMode
- util.setLocale
- util.setLoggingLevel
- util.setReadTimeout
- util.threadDump
- util.translate
Designer
- alarm.cancel
- alarm.createRoster
- alarm.getRosters
- alarm.getShelvedPaths
- alarm.listPipelines
- alarm.queryJournal
- alarm.queryStatus
- alarm.unshelve
- dataset.addColumn
- dataset.addRow
- dataset.addRows
- dataset.appendDataset
- dataset.clearDataset
- dataset.dataSetToExcel
- dataset.dataSetToHTML
- dataset.deleteRow
- dataset.deleteRows
- dataset.filterColumns
- dataset.formatDates
- dataset.fromCSV
- dataset.getColumnHeaders
- dataset.setValue
- dataset.sort
- dataset.toCSV
- dataset.toDataSet
- dataset.toPyDataSet
- dataset.updateRow
- date.add*
- date.*Between
- date.format
- date.fromMillis
- date.get*
- date.getDate
- date.getTimezone
- date.getTimezoneRawOffset
- date.getTimezoneOffset
- date.isAfter
- date.isBefore
- date.isBetween
- date.isDaylightTime
- date.midnight
- date.now
- date.parse
- date.setTime
- date.toMillis
- db.addDatasource
- db.clearAllNamedQueryCaches
- db.clearNamedQueryCache.md
- db.closeTransaction
- db.commitTransaction
- db.dateFormat
- db.execSProcCall
- db.getConnectionInfo
- db.getConnections
- db.refresh
- db.removeDatasource
- db.rollbackTransaction
- db.runNamedQuery
- db.runSFPrepUpdate
- db.runSFUpdateQuery
- db.setDatasourceConnectURL
- db.setDatasourceEnabled
- db.setDatasourceMaxConnections
- device.addDevice
- device.listDevices
- device.refreshBrowse
- device.removeDevice
- device.setDeviceEnabled
- device.setDeviceHostname
- dnp3.directOperateAnalog
- dnp3.directOperateBinary
- dnp3.freezeAnalogs
- dnp3.freezeAnalogsAtTime
- dnp3.freezeCounters
- dnp3.freezeCountersAtTime
- dnp3.selectOperateAnalog
- dnp3.selectOperateBinary
- eam.getGroups
- eam.queryAgentHistory
- eam.queryAgentStatus
- eam.runTask
- file.fileExists
- file.getTempFile
- file.readFileAsBytes
- file.readFileAsString
- file.writeFile
- gui.chooseColor
- gui.closeDesktop
- gui.confirm
- gui.convertPointToScreen
- gui.getOpenedWindowNames
- gui.isTouchscreenModeEnabled
- math.geometricMean
- math.kurtosis
- math.max
- math.mean
- math.meanDifference
- math.median
- math.min
- math.mode
- math.normalize
- math.percentile
- math.populationVariance
- math.product
- math.skewness
- math.standardDeviation
- math.sum
- math.sumDifference
- math.sumLog
- math.sumSquares
- math.variance
- nav.centerWindow
- net.getHostName
- net.getIpAddress
- net.getRemoteServers
- net.httpDelete
- net.httpGet
- net.httpPost
- net.httpPut
- net.sendEmail
- opc.browse
- opc.browseSimple
- opc.getServerState
- opc.getServers
- opc.isServerEnabled
- opc.readValue
- opc.readValues
- opc.setServerEnabled
- opc.writeValue
- opc.writeValues
- opchda.browse
- opchda.getAggregates
- opchda.getAttributes
- opchda.getServers
- opchda.insert
- opchda.insertReplace
- opchda.isServerAvailable
- opchda.readAttributes
- opchda.readProcessed
- opchda.readRaw
- opchda.replace
- report.executeAndDistribute
- report.executeReport
- report.getReportNamesAsDataset
- report.getReportNamesAsList
- secsgem.deleteToolProgram
- secsgem.copyEquipment
- secsgem.enableDisableEquipment
- secsgem.getResponse
- secsgem.getToolProgram
- secsgem.getToolProgramDataset
- secsgem.sendRequest
- secsgem.startSimEventRun
- secsgem.toDataset
- secsgem.toTreeDataset
- security.getUsername
- security.isScreenLocked
- security.logout
- serial.closeSerialPort
- serial.configureSerialPort
- serial.openSerialPort
- serial.readBytes
- serial.readBytesAsString
- serial.readLine
- serial.readUntil
- serial.sendBreak
- serial.write
- serial.writeBytes
- sfc.cancelChart
- sfc.getRunningCharts
- sfc.getVariables
- sfc.pauseChart
- sfc.redundantCheckpoint
- sfc.resumeChart
- sfc.setVariable
- sfc.setVariables
- sfc.startChart
- tag.addTag
- tag.browseConfiguration
- tag.browseHistoricalTags
- tag.browseTags
- tag.browseTagsSimple
- tag.editAlarmConfig
- tag.editTag
- tag.editTags
- tag.exists
- tag.getAlarmStates
- tag.isOverlaysEnabled
- tag.loadFromFile
- tag.queryTagCalculations
- tag.queryTagDensity
- tag.queryTagHistory
- tag.read
- tag.readAll
- tag.removeTag
- tag.removeTags
- tag.scan
- tag.storeTagHistory
- tag.write
- tag.writeAll
- tag.writeAllSynchronous
- tag.writeSynchronous
- twilio.getAccounts
- twilio.getAccountsDataset
- twilio.getPhoneNumbers
- twilio.getPhoneNumbersDataset
- twilio.sendSms
- user.addHoliday
- user.addRole
- user.addSchedule
- user.editHoliday
- user.editRole
- user.editSchedule
- user.getHoliday
- user.getHolidayNames
- user.getHolidays
- user.getRoles
- user.getSchedule
- user.getScheduleNames
- user.getScheduledUsers
- user.getSchedules
- user.getUser
- user.getUsers
- user.isUserScheduled
- user.removeHoliday
- user.removeRole
- user.removeSchedule
- util.execute
- util.getGlobals
- util.getLocale
- util.getLogger
- util.getProperty
- util.getSessionInfo
- util.invokeAsynchronous
- util.jsonDecode
- util.jsonEncode
- util.sendMessage
- util.sendRequest
- util.sendRequestAsync
- util.setConnectTimeout
- util.setConnectionMode
- util.setLoggingLevel
- util.threadDump