Reads alarms for the specified tags, processes, or alarm areas. You must manually select the polymorphic instance to use.

Note This VI interacts with data in the Citadel database only.

Use the pull-down menu to select an instance of this VI.


icon

Inputs/Outputs

  • 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.

  • cTag_Readerlvclass.png

    Tag Reader in specifies the data of a group of tags that the Open Tag Reader VI opens.

  • cstr.png alarm area

    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.

  • ccclst.png time interval

    time interval specifies the span of time between the start timestamp and stop timestamp. If you do not wire this input, this VI reads all the alarms that are relevant to the specified tag from the Shared Variable Engine (SVE).

  • catrn.png start timestamp

    start timestamp specifies the date and time associated with the first alarm that this VI retrieves from the SVE. If you do not wire this input, this VI extracts the alarm starting at the time of the first alarm in the SVE.

  • catrn.png stop timestamp (now)

    stop timestamp specifies the date and time associated with the last alarm that this VI retrieves from the SVE. If you do not wire this input, this VI extracts the alarm up to the last alarm available in the SVE.

  • cerrcodeclst.png error in (no error)

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

  • iTag_Readerlvclass.png

    Tag Reader out returns data of the tags that this VI opens.

  • i1dcclst.png alarms

    alarms returns the alarm information for the specified shared variables, processes, or alarm areas.

  • 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 returns the shared variable value when it changes alarm states. The shared variable value updates only when the shared variable changes alarm states and is not necessarily the most recent alarm value.

  • iu32.png priority

    priority returns 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.

  • ibool.png event?

    event? returns TRUE if the alarm is an event.

  • iu64.png Refnum

    Refnum return the reference number of the alarm.

  • ierrcodeclst.png error out

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