User Manual

GETTING STARTED


OTHER EDITIONS


LAUNCHERS


MODULES


PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support

ALL USER MANUAL VERSIONS

Ignition 8.1. Offline Version (04/2021)
Ignition 8 Online Version
Ignition 7.9 Online Version
Ignition 7.8 Online Version

Deprecated Pages

SDK Documentation

Employees

Sign In

Skip to end of metadata
Go to start of metadata

The following sections describe the structure of some prominent objects returned or expected by Ignition system functions. Not all classes, fields, and methods are included in the lists below. For a fully comprehensive reference of all Ignition types, refer to the Javadocs in the Ignition SDK Programmers Guide.

Alarming

AlarmQueryResult

Used By: system.alarm.queryStatussystem.alarm.queryJournal

The AlarmQueryResult object represents a collection of AlarmEvent objects with some additional helper methods.

Methods
NameReturnsDescription
getDataset()dataset

Returns the alarms as a dataset. Columns for realtime (queryStatus) calls are:

  • EventId
  • Source 
  • DisplayPath 
  • EventTime
  • State 
  • Priority 

Columns from historical calls (queryJournal) have the following columns:

  • EventId 
  • Source 
  • DisplayPath 
  • EventTime 
  • EventState 
  • Priority 
  • IsSystemEvent 

PyAlarmEvent

Used By: Perspective - Alarm Journal Table, Perspective - Alarm Status Tablesystem.alarm.queryJournalsystem.alarm.queryStatus

This object contains information about alarm events.

ScriptableBlockPyAlarmEvent

Used By: This object is the "event" object made available to Script Blocks in alarm pipelines. 

Note: The methods listed in the table below are shared between the PyAlarmEvent and ScriptableBlockPyAlarmEvent objects, with the latter being the "event" object made available to Script Blocks in alarm pipelines. However, there is one method called cancelNotification that is exclusive to ScriptableBlockPyAlarmEvent.

Methods
NameReturnsDescription
cancelNotification()NoneWhen invoked, cancels the running pipeline instance.
contains(String propertyName)BooleanReturns a boolean, based on whether or not the alarm event contains a value for the named property. Useful when testing for associated data. 
get(String propertyName)AnyReturns the value of propertyName. Useful in cases when trying to view the value of associated data. A full list of built-in alarm properties can be found on the Tag Alarm Properties page. 
getAckData()EventDataReturns an object containing information acknowledgement information for the event, assuming the event has been acknowledged.
getActiveData()EventDataReturns an object containing information detailing when the alarm went active. 
getClearedData()EventDataReturns an object containing information detailing when the alarm transitioned to a cleared status, assuming it has done so. 
getDisplayPath()StringReturns the Display Path of the alarm.
getDisplayPathOrSource()StringIf the Display Path for the alarm in an empty string, then returns the Source Path, otherwise, returns the Display Path.
getId()java.util.UUIDReturns the UUID of the alarm event.
getLabel()StringThe label of the alarm event.
getLastEventState()AlarmStateTransition

Returns the last state of the alarm. Possible return values are Active, Acknowledged, or Cleared.

The last event is always returned, so if you're looking to see if an alarm has been both Acknowledged and Cleared, use getState() instead.

getName()StringReturns the name of the alarm.
getNotes()String or NoneReturns the value of the Notes property. Returns a None-type object if a Note has not been configured on the Alarm.
getOrDefault(String propertyName)AnyReturns the value of the propertyName, or the default value if one isn't defined. Can return null if the value is null. 
getOrElse(String propertyName, Object fallBackValue)AnyReturns the value of propertyName. If there is property by that name, fallBackValue is returned instead. Can return null if the value is null. 
getPriority()AlarmPriorityReturns an AlarmPriority object representing the the Priority of the alarm. Can easily be converted to a String with str().
getProperties()SetReturns a set of all properties on the event. 
getSource()QualifiedPathReturns the Source path of the alarm.
getState()AlarmStateReturns the current state of the alarm: i.e., Active, Unacknowledged.
isAcked()BooleanReturns a boolean flag indicating that the alarm has been Acknowledged.
isCleared()BooleanReturns a boolean flag indicating that the alarm has been Cleared.
isShelved()BooleanReturns a boolean flag indicating that the alarm has been Shelved.

In addition, PyAlarmEvents have the following keys that can be used to identiy certain property values. For example:

results = system.alarm.queryStatus()
for i in results:
	print i["EventId"]

KeyDescription

EventId

A unique identifier for the alarm event. 
SourcePathThe source path of the alarm event.
DisplayPath The display path of the alarm event.
EventTimeA date representing when the alarm event changed State/EventState. 
State 

queryStatus Only. A string representing the state of the alarm. Expected values are:

  • Active, Unacknowledged
  • Active, Acknowledged
  • Cleared, Unacknowledged
  • Cleared, Acknowledged
EventStatequeryJournal Only. A string representing the state of the alarm.  See State for a list of possible values. 
Priority A string representing the priority of the alarm.
IsSystemEventqueryJournal Only. A boolean representing if this event was a system event. 

ShelvedPath

Used By:  system.alarm.getShelvedPaths

This class provides information about an alarm that has been "shelved", including the alarm path, when it was shelved, and by whom.

Methods
NameReturnsDescription
getPath()path

Returns a Path object representing the path to the alarm. Can be cast to a string.

getExpiration()dateReturns the time that the shelve expires.
getUser()QualifiedPathReturns the actual AlarmEvent object for the specified event UUID.
isExpired()booleanReturns True if the shelve has expired for the alarm; otherwise returns False.

On this page ...


Datasets and PyDatasets

Used By: Many facets of Ignition including queries, Vision and Perspective components, and Tags

See Datasets.





Tags

Results

Used By:  system.tag.browsesystem.tag.browseHistoricalTags

Methods
NameReturnsDescription
getResults()list

Returns a list of node dictionaries, one for each Tag (including folders and UDT instances) in the result set. See Tag Dictionary Keys below for a summary of available keys in the Tag dictionaries.

getReturnedSize()integer

Returns the number of results contained in this object. If different than getTotalAvailableSize(), only a partial browse was performed, and the continuation point should be non-null.

Tag Dictionary Keys
All Nodes (Tags, Folders, UDT Definitions, and UDT Instances)
NameTypeDescription
fullPathBasicTagPath

A fully qualified Tag path to the node, including the name of the node. 

The value returned by this key is a BasicTagPath. However, Python's str() method can be used to convert the path to a string.

hasChildrenboolean

Represents whether the node contains sub-nodes, such as folders and UDT definitions.

namestringThe name of the node.
tagTypestring

The type of the node. Possible values are:

  • AtomicTag: Represents a standard Tag.
  • Folder: Represents a Tag folder.
  • UdtType: Represents a UDT definition.
  • UdtInstance: Represents a UDT instance.
Tags (tagType = AtomicTag)
NameTypeDescription
dataTypestringThe data type of the Tag.
valueSourcestringRepresents how the Tag derives its value.
value
VariesThe last known qualified value on the Tag. 
UDT Definitions and Instances (tagType = UdtType or UdtInstance)
NameTypeDescription
typeIdstring

Represents the parent data type for the UDT. 

UDT definitions without a specified parent type will have a value of None





Misc Objects

QualifiedValue

Used By: Many facets of Ignition including Tag Event Scripts, various system.tag functions, and Perspective Property Change scripts

The QualifiedValue class is a representation of an Ignition value often used to represent a Tag's current condition (as in the result of a Tag read) and is meant to provide more context than a value alone. Two qualified values are considered equal if their quality and value are equal. The properties and methods on a QualifiedValue object are as follows:

Properties
NameTypeDescription

value

variesThe data associated with the QualifiedValue object. Type depends on the type of the underlying value.
qualityqualityCodeThe quality associated with the returned value. See QualityCode.
timestampdateThe time associated with the returned value. 
Methods
NameReturnsDescription
getValue()variesGets the data associated with the QualifiedValue object. Type depends on the type of the underlying value.
getQuality()qualityCodeGets the quality associated with the returned value. See QualityCode.
getTimestamp()dateGets the time associated with the returned value. 

QualityCode

Used By: QualifiedValue Objects

The QualityCode class describes a quality for a value.

Methods
NameReturnsDescription
getCode()integer

Returns the 32-bit integer code associated with the quality. For more information on quality codes, including a list of available codes, see Quality Codes and Overlays.

getDiagnosticMessage()stringReturns the diagnostic message associated with this quality, if present. Otherwise, returns None.
isGood()booleanReturns True if this code represents a Good quality level. Otherwise, returns False.
isUncertain()booleanReturns True if this code represents an Uncertain quality level. Otherwise, returns False. Note that Bad and Error quality levels return False.
isBad()booleanReturns True if this code represents a Bad quality level. Otherwise, returns False. Note that Uncertain and Error quality levels return False.
isError()booleanReturns True if this code represents an Error quality level. Otherwise, returns False. Note that Bad and Uncertain quality levels return False.
isNotGood()booleanReturns True if this code represents an Uncertain, Bad, or Error quality level. Otherwise, returns False.
isBadOrError()booleanReturns True if this code represents a Bad or Error  quality level. Otherwise, returns  False.
toValue()QualifiedValueReturns this quality as the quality component of a QualifiedValue object.
is(QualityCode other)booleanCompares the integer quality codes of another QualityCode object to this one. Returns True if they match.
isNot(QualityCode other)booleanCompares the integer quality codes of another QualityCode object to this one. Returns True if they do not match.




  • No labels