Extracts data from a historical alarm and event database.


icon

Inputs/Outputs

  • cnclst.png colors —

    colors determines the colors used in the table or multicolumn listbox for alarms and events.

  • cu32.png event —

    event determines the color for events in the display. Use the color picker to set the color.

  • cu32.png alarm —

    alarm determines the color for alarms in the display. Use the color picker to set the color.

  • cu32.png alarm acknowledged —

    alarm acknowledged determines the color for acknowledged alarms and events in the display. Use the color picker to set the color.

  • cu32.png alarm cleared —

    alarm cleared determines the color for alarm-cleared events in the display. Use the color picker to set the color.

  • cu32.png alarm acked & cleared —

    alarm acknowledge and cleared type determines the color in the display for events of unknown type. Use the color picker to set the color.

  • ccclst.png display format —

    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.

  • cbool.png show date —

    show date includes the date that the alarm was logged.

  • cu16.png date format —

    date format determines the format for the date of the alarm.

  • cbool.png show time —

    show time includes the time that the alarm was logged.

  • cu16.png time format —

    time format determines the format for the time of the alarm.

  • cbool.png alarm URL —

    alarm URL includes the full URL to the alarm.

  • cbool.png set time —

    set time includes the time, formatted according to the time format setting.

  • cbool.png set user —

    set user determines whether to display the name of the operator at the set time.

  • cbool.png ack time —

    ack time includes the time at which the alarm or event was acknowledged.

  • cbool.png ack user —

    ack user includes the name of the operator who acknowledged the alarm.

  • cbool.png clear time —

    clear time includes the time the alarm was cleared, formatted according to the time format setting.

  • cbool.png clear user —

    clear user includes the name of the operator who cleared the alarm.

  • cbool.png alarm area —

    alarm area includes an alarm group. This VI returns only alarms and events belonging to this alarm group, or area.

  • cbool.png value at alarm —

    value at alarm includes the value of the shared variable at which the alarm occurred.

  • cbool.png priority —

    priority includes the priority of the alarm.

  • cbool.png alarm setpoint —

    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.

  • cbool.png alarm description —

    alarm description includes the description of the alarm that the ack user entered.

  • cbool.png ack comment —

    ack comment includes the message entered by the ack user when he acknowledged the alarm.

  • cbool.png show events —

    show events includes events. If show events is FALSE, this VI only display alarms.

  • cpath.png database URL —

    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.

  • ccclst.png filter —

    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.

  • catrn.png start timestamp —

    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.

  • catrn.png stop timestamp (now) —

    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.

  • cstr.png shared variable name —

    shared variable name specifies to return the alarms with this shared variable name.

  • cstr.png process —

    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.

  • cstr.png set user —

    set user specifies a user who was logged into the system. The VI returns only alarms and events that were generated when this user was logged into the system.

  • cstr.png clear user —

    clear user specifies to return the alarms that this user cleared.

  • cstr.png ack user —

    ack user specifies to return the alarms that this user acknowledged.

  • cstr.png alarm area —

    alarm area specifies to return the alarms in this alarm group, or area.

  • cstr.png ack comment —

    ack comment specifies to return the alarms with this comment entered by ack user when he acknowledged the alarm.

  • cstr.png alarm description —

    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.

  • cdbl.png alarm setpoint —

    alarm setpoint specifies to return the alarms with this value as the trigger of the alarm.

  • cdbl.png value at alarm —

    value at alarm specifies to return all alarms that had this value when the alarm occurred.

  • ci32.png minimum priority —

    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.

  • ci32.png maximum priority —

    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.

  • ccclst.png filter on... —

    filter on is a set of checkboxes that you can use to specify that you want this VI to return the corresponding alarm information.

  • cbool.png start timestamp —

    start timestamp specifies whether to include the timestamp information in the results of the query.

  • cbool.png shared variable name —

    shared variable name specifies whether to include the name of the shared variable in the results of the query.

  • cbool.png process —

    process specifies whether to include the process information in the results of the query.

  • cbool.png set user —

    set user determines whether to display the name of the operator at the set time.

  • cbool.png clear user —

    clear user includes the name of the operator who cleared the alarm.

  • cbool.png ack user —

    ack user includes the name of the operator who acknowledged the alarm.

  • cbool.png alarm area —

    alarm area includes an alarm group. The VI returns only alarms and events belonging to this alarm group, or area.

  • cbool.png ack comment —

    ack comment includes the message entered by the ack user when he acknowledged the alarm.

  • cbool.png alarm description —

    alarm description includes the description of the alarm that the ack user entered.

  • cbool.png alarm setpoint —

    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.

  • cbool.png value at alarm —

    value at alarm includes the value of the shared variable at which the alarm occurred.

  • cbool.png minimum priority —

    minimum priority specifies whether to include the minimum priority in the results of the query.

  • cbool.png maximum results —

    maximum results specifies whether to include the maximum results in the results of the query.

  • cbool.png newfirst —

    return newest entries first specifies whether to return newest entries first in the results of the query.

  • cu16.png show... —

    show specifies whether this VI returns alarms, events, or both alarms and events.

  • ci32.png maximum results —

    maximum results specifies whether to include the maximum results in the results of the query.

  • cbool.png return newest entries first —

    return newest entries first specifies whether to return newest entries first in the results of the query.

  • ci32.png timeout (30 s) —

    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.

  • cerrcodeclst.png error in (no error) —

    error in describes error conditions that occur before this node runs. This input provides standard error in functionality.

  • cctrn.png table or multicolumn listbox —

    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.

  • i1dcclst.png alarm data —

    alarm data contains the data that describes a historical alarm or event.

  • istr.png alarm URL —

    alarm URL returns the name of the alarm.

  • iatrn.png set time —

    set time returns the time that the alarm occurred.

  • istr.png set user —

    set user returns the user who was logged in when the alarm activated.

  • iatrn.png ack time —

    ack time returns the time that the alarm was acknowledged.

  • istr.png ack user —

    ack user returns the user who acknowledged the alarm.

  • iatrn.png clear time —

    clear time returns the time that the alarm was cleared.

  • istr.png clear user —

    clear user returns the user who cleared the alarm.

  • idbl.png setpoint —

    setpoint returns the value of the shared variable at the time when the alarm occurred.

  • idbl.png value —

    value is the value of the alarm at the time the alarm occurred.

  • iu32.png priority —

    priority is the priority level of the alarm.

  • istr.png alarm area —

    alarm area returns the alarm group, or area, to which the alarm belongs.

  • istr.png alarm description —

    alarm description returns a description of the alarm or event.

  • istr.png ack comment —

    ack comment returns the message the ack user entered when the user acknowledged the alarm.

  • iu32.png Refnum —

    alarm determines the color for alarms in the display. Use the color picker to set the color.

  • ibool.png event? —

    event? returns TRUE if the alarm is an event.

  • ipath.png database URL out —

    database URL out returns the computer name and the database name that specify where the Citadel database resides. The format is \\computer\database.

  • ierrcodeclst.png error out —

    error out contains error information. This output provides standard error out functionality.