system.alarm.queryJournal([startDate], [endDate], [journalName], [priority], [state], [path], [source], [displaypath], [all_properties], [any_properties], [defined], [includeData], [includeSystem], [isSystem])
Date startDate - The start of the time range to query. Defaults to 8 hours previous to now if omitted. Time range is inclusive. [optional]
Date endDate - The end of the time range to query. Defaults to "now" if omitted. [optional]
String journalName - The journal name to query. If only one journal exists on the Gateway, can be omitted. [optional]
List[Integer | String] priority - A list of possible priorities to match. Priorities can be specified by name or number, with the values: Diagnostic(0), Low(1), Medium(2), High(3), Critical(4). [optional]
List[Integer | String] state - A list of event states to match. Valid values can either be integers or strings, representing a number of states. See State Values for a listing of possible values. [optional]
List[String] path - A list of possible source paths to search at. The wildcard "*" may be used. [optional]
List[String] source - A list of possible source paths to search at. The wildcard "*" may be used. [optional]
List[String] displaypath - A list of display paths to search at. Display paths are separated by "/", and if a path ends in "/*", everything below that path will be searched as well. [optional]
List[Tuple[String, String, Any] all_properties - A set of property conditions, all of which must be met for the condition to pass. This parameter is a list of tuples, in the form ("propName", "condition", value). Valid propName values can be either associated data or the keys listed on the PyAlarmEvent object. Valid condition values: "=","!=","<","<=",">",">=". String values can only be compared using "=" and "!=" conditions. [optional]
List[Tuple[String, String, Any] any_properties - A set of property conditions, any of which will cause the overall condition to pass. This parameter is a list of tuples, in the form ("propName", "condition", value). Valid propName values can be either associated data or the keys listed on the PyAlarmEvent object. Valid condition values: "=","!=","<","<=",">",">=". String values can only be compared using "=" and "!=" conditions. [optional]
List[String] defined - A list of string property names, all of which must be present on an event for it to pass. [optional]
Boolean includeData - Whether or not event data should be included in the return. If True, returns Python dictionaries (or nulls) for Active Data, Clear Data, Ack Data, Runtime Data inside of the AlarmQueryResult object. [optional]
Boolean includeSystem - Specifies whether system events are included in the return. [optional]
Boolean isSystem - Specifies whether the returned event must or must not be a system event. [optional]
AlarmQueryResult - The AlarmQueryResult object is a list of PyAlarmEvent objects. See Scripting Object Reference.
Additionally, each PyAlarmEvent inside of the AlarmQueryResult object has several built-in methods to extract alarm information. More details on these methods can be found on the Scripting Object Reference page.
This feature was changed in Ignition version 8.1.11:
As of 8.1.11, objects inside of the AlarmQueryResult object are now instances of PyAlarmEvent. Formerly they were AlarmEvent objects.
Note: Each item in the resulting object is a separate alarm event: an alarm becoming active is one item, while the same alarm becoming acknowledged is a separate item. This differs from system.alarm.queryStatus() which groups each event into a single item.
Gateway, Vision Client, Perspective Session