Alarm & Event Query VI

LabVIEW 2017 Datalogging and Supervisory Control Module Help

Edition Date: March 2017

Part Number: 371618K-01

»View Product Info
Download Help (Windows Only)

Owning Palette: Historical VIs

Requires: DSC Module

Extracts data from a historical alarm and event database.

colors determines the colors used in the table or multicolumn listbox for alarms and events.
event determines the color for events in the display. Use the color picker to set the color.
alarm determines the color for alarms in the display. Use the color picker to set the color.
alarm acknowledged determines the color for acknowledged alarms and events in the display. Use the color picker to set the color.
alarm cleared determines the color for alarm-cleared events in the display. Use the color picker to set the color.
alarm acknowledge and cleared type determines the color in the display for events of unknown type. Use the color picker to set the color.
display format determines the formatting settings for this VI to send data to a file. When the following parameters are TRUE, the results of the query returns values for all those parameter values.
alarm URL includes the full URL to the alarm.
set time includes the time, formatted according to the time format setting.
set user determines whether to display the name of the operator at the set time.
ack time includes the time at which the alarm or event was acknowledged.
ack user includes the name of the operator who acknowledged the alarm.
clear time includes the time the alarm was cleared, formatted according to the time format setting.
clear user includes the name of the operator who cleared the alarm.
alarm setpoint includes the value of the shared variable at the time that the setpoint occurred. The setpoint is the value at which you want any data that exceeds the setpoint to trigger an alarm.
value at alarm includes the value of the shared variable at which the alarm occurred.
priority includes the priority of the alarm.
alarm area includes an alarm group. This VI returns only alarms and events belonging to this alarm group, or area.
alarm description includes the description of the alarm that the ack user entered.
ack comment includes the message entered by the ack user when he acknowledged the alarm.
show events includes events. If show events is FALSE, this VI only display alarms.
date format determines the format for the date of the alarm.

0MM/DD/YYYY (default)
1DD/MM/YYYY
time format determines the format for the time of the alarm.

0AM/PM (default)
124 HOUR
show date includes the date that the alarm was logged.
show time includes the time that the alarm was logged.
database URL specifies the computer name and the database name where the Citadel database resides. Enter the database URL in the format \\computer\database.

For example, if you have a copy of the LabVIEW Datalogging and Supervisory Control (DSC) Module and Citadel service installed on a computer named datalogger and the name of the database on that computer is data, you can access the data on datalogger from another computer by using the path \\datalogger\data. If you provide a database name only, this VI searches for the database on the local computer. If you do not wire database URL, this VI resolves the database URL from the Shared Variable Engine (SVE). If the SVE resolution fails, this VI reads data from the database associated with the default DSC Module process.
filter executes a more selective query of the historical alarms and events database. This VI returns only alarms and events that fit the filter criteria. To use the filter criteria, set filter on to TRUE for the corresponding subparameter.

If you do not wire a value to the filter parameter, the query returns all the alarm and event data from the database. If you do not wire values to the start timestamp and stop timestamp subparameters, this VI returns all the alarms that fit the remaining filter criteria.
filter on is a set of checkboxes that you can use to specify that you want this VI to return the corresponding alarm information.
start timestamp specifies whether to include the timestamp information in the results of the query.
shared variable name specifies whether to include the name of the shared variable in the results of the query.
process specifies whether to include the process information in the results of the query.
set user determines whether to display the name of the operator at the set time.
clear user includes the name of the operator who cleared the alarm.
ack user includes the name of the operator who acknowledged the alarm.
alarm area includes an alarm group. This VI returns only alarms and events belonging to this alarm group, or area.
ack comment includes the message entered by the ack user when he acknowledged the alarm.
alarm description includes the description of the alarm that the ack user entered.
alarm setpoint includes the value of the shared variable at the time that the setpoint occurred. The setpoint is the value at which you want any data that exceeds the setpoint to trigger an alarm.
value at alarm includes the value of the shared variable at which the alarm occurred.
minimum priority specifies whether to include the minimum priority in the results of the query.
maximum results specifies whether to include the maximum results in the results of the query.
return newest entries first specifies whether to return newest entries first in the results of the query.
start timestamp is the date and time associated with the first alarm or event that this VI retrieves from the database. If you do not wire this input, this VI extracts the alarm or event starting at the time of the first alarm or event in the database.
stop timestamp is the date and time associated with the last alarm or event that this VI retrieves from the database. If you do not wire this input, this VI extracts the alarm or event up to the last alarm or event available in the database.
shared variable name specifies to return the alarms with this shared variable name.
process specifies to return the alarms associated with this process. If process is blank, this VI uses the LabVIEW process on the local computer. You can use wildcard characters in this input, where * means zero or more characters and ? means exactly one character. The format of this filter can be \\computer\* to match all processes from a particular computer or \\computer\process to match only a particular process from a particular computer.
set user specifies a user who was logged into the system. This VI returns only alarms and events that were generated when this user was logged into the system. You can use wildcard characters in this input, where * means zero or more characters and ? means exactly one character.
clear user specifies to return the alarms that this user cleared.
ack user specifies to return the alarms that this user acknowledged.
alarm area specifies the alarm group or area in which you want to read alarms. You can specify the alarm area on the Alarming page of the Shared Variable Properties dialog box.
ack comment specifies to return the alarms with this comment entered by ack user when he acknowledged the alarm.
alarm description specifies to return the alarms with this description. You can use wildcard characters in this input, where * means zero or more characters and ? means exactly one character.
alarm setpoint specifies to return the alarms with this value as the trigger of the alarm.
value at alarm specifies to return all alarms that had this value when the alarm occurred.
minimum priority specifies the lowest value of alarms and events for the query to include. If this value is the same as the maximum priority setting, priority filtering is disabled.
maximum priority specifies the highest value of alarms and events for the query to include. If this value is the same as the minimum priority setting, priority filtering is disabled.
maximum results specifies the limit of items returned in the query. If maximum results is less than zero, the query returns all data matching the filter criteria.
return newest entries first specifies the order in which this VI returns data. Set this parameter to FALSE to return data in order from oldest to newest. Set this parameter to TRUE to return data in order from newest to oldest.
show specifies whether this VI returns alarms, events, or both alarms and events.
timeout specifies the maximum time, in seconds, that this VI waits for reading data from the Citadel database. The default is 30. A timeout value of less than or equal to 0 specifies no timeout, which means this VI waits indefinitely until this VI receives data from the Citadel database.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
table or multicolumn listbox is a reference to a string table or multicolumn listbox control or indicator. If valid, the results of the query are sent to the control, formatted according to the settings in the format control.
alarm data contains the data that describes a historical alarm or event.
alarm URL returns the name of the alarm.
event? returns TRUE if the alarm is an event.
set time returns the time that the alarm occurred.
set user returns the user who was logged in when the alarm activated.
ack time returns the time that the alarm was acknowledged.
ack user returns the user who acknowledged the alarm.
clear time returns the time that the alarm was cleared.
clear user returns the user who cleared the alarm.
setpoint returns the value of the shared variable at the time when the alarm occurred.
value is the value of the alarm at the time the alarm occurred.
priority is the priority level of the alarm.
alarm area returns the alarm group, or area, to which the alarm belongs.
alarm description returns a description of the alarm or event.
ack comment returns the message the ack user entered when the user acknowledged the alarm.
database URL out returns the computer name and the database name that specify where the Citadel database resides. The format is \\computer\database.
error out contains error information. This output provides standard error out functionality.

WAS THIS ARTICLE HELPFUL?

Not Helpful