You are here: NI Home > Support > Product Reference > Manuals > LabVIEW 2009 Datalogging and Supervisory Control Module Help

Owning Palette: Tags VIs

Requires: DSC Module

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

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

Select an instance Read Tag Alarms (Live, Single)Read Tag Alarms (Live, Multiple)Read Tag Alarms (Live, All in Process)Read Tag Alarms (Historical, Tag Name)Read Tag Alarms (Historical, Area)

Read Tag Alarms (Live, Single)

	Tag Reader in specifies the data of a group of tags that the Open Tag Reader VI opens.
	tag name specifies the name of the tag for which you want to read the alarms.
	timeout specifies the maximum time, in seconds, that this VI waits for reading data from the Citadel database. The default is 5. 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 (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.
	Tag Reader out returns data of the tags that this VI opens.
	alarms returns the alarm information for the specified shared variables, processes, or alarm areas. alarm URL returns the name of the alarm. set user returns the user who was logged in when the alarm activated. ack user returns the user who acknowledged the alarm. 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 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. priority returns the priority level of the alarm. event? returns TRUE if the alarm is an event. Refnum return the reference number of the alarm. set time returns the time that the alarm occurred. ack time returns the time that the alarm was acknowledged. clear time returns the time that the alarm was cleared. 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.
	error out contains error information. This output provides standard error out functionality.

Read Tag Alarms (Live, Multiple)

Note  Use this instance to read alarms for multiple tags.

	Tag Reader in specifies the data of a group of tags that the Open Tag Reader VI opens.
	tag names specifies the list of tags for which you want to acknowledge alarms.
	timeout specifies the maximum time, in seconds, that this VI waits for reading data from the Citadel database. The default is 5. 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 (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.
	Tag Reader out returns data of the tags that this VI opens.
	alarms returns the alarm information for the specified shared variables, processes, or alarm areas. alarm URL returns the name of the alarm. set user returns the user who was logged in when the alarm activated. ack user returns the user who acknowledged the alarm. 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 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. priority returns the priority level of the alarm. event? returns TRUE if the alarm is an event. Refnum return the reference number of the alarm. set time returns the time that the alarm occurred. ack time returns the time that the alarm was acknowledged. clear time returns the time that the alarm was cleared. 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.
	error out contains error information. This output provides standard error out functionality.

Read Tag Alarms (Live, All in Process)

Note  Use this instance to read alarms for all tags under the specified Tag Reader instance.

	Tag Reader in specifies the data of a group of tags that the Open Tag Reader VI opens.
	timeout specifies the maximum time, in seconds, that this VI waits for reading data from the Citadel database. The default is 5. 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 (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.
	Tag Reader out returns data of the tags that this VI opens.
	alarms returns the alarm information for the specified shared variables, processes, or alarm areas. alarm URL returns the name of the alarm. set user returns the user who was logged in when the alarm activated. ack user returns the user who acknowledged the alarm. 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 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. priority returns the priority level of the alarm. event? returns TRUE if the alarm is an event. Refnum return the reference number of the alarm. set time returns the time that the alarm occurred. ack time returns the time that the alarm was acknowledged. clear time returns the time that the alarm was cleared. 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.
	error out contains error information. This output provides standard error out functionality.

Read Tag Alarms (Historical, Tag Name)

Note  Use this instance to read historical alarms for a tag.

	Tag Reader in specifies the data of a group of tags that the Open Tag Reader VI opens.
	tag name specifies the name of the tag for which you want to read the alarms.
	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 Citadel database. start timestamp specifies the date and time associated with the first alarm that this VI retrieves from the database. If you do not wire this input, this VI extracts the alarm starting at the time of the first alarm in the database. stop timestamp specifies the date and time associated with the last alarm that this VI retrieves from the database. If you do not wire this input, this VI extracts the alarm up to the last alarm available in the database.
	error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.
	Tag Reader out returns data of the tags that this VI opens.
	alarms returns the alarm information for the specified shared variables, processes, or alarm areas. alarm URL returns the name of the alarm. set user returns the user who was logged in when the alarm activated. ack user returns the user who acknowledged the alarm. 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 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. priority returns the priority level of the alarm. event? returns TRUE if the alarm is an event. Refnum return the reference number of the alarm. set time returns the time that the alarm occurred. ack time returns the time that the alarm was acknowledged. clear time returns the time that the alarm was cleared. 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.
	error out contains error information. This output provides standard error out functionality.

Read Tag Alarms (Historical, Area)

Note  Use this instance to read historical alarms that belong to an alarm area.

	database URL specifies the computer name and the database name where the Citadel database resides. Enter the database URL in the format \\computer_name\database_name.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.
	Tag Reader in specifies the data of a group of tags that the Open Tag Reader VI opens.
	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.
	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 Citadel database. start timestamp specifies the date and time associated with the first alarm that this VI retrieves from the database. If you do not wire this input, this VI extracts the alarm starting at the time of the first alarm in the database. stop timestamp specifies the date and time associated with the last alarm that this VI retrieves from the database. If you do not wire this input, this VI extracts the alarm up to the last alarm available in the database.
	error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.
	Tag Reader out returns data of the tags that this VI opens.
	alarms returns the alarm information for the specified shared variables, processes, or alarm areas. alarm URL returns the name of the alarm. set user returns the user who was logged in when the alarm activated. ack user returns the user who acknowledged the alarm. 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 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. priority returns the priority level of the alarm. event? returns TRUE if the alarm is an event. Refnum return the reference number of the alarm. set time returns the time that the alarm occurred. ack time returns the time that the alarm was acknowledged. clear time returns the time that the alarm was cleared. 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.
	error out contains error information. This output provides standard error out functionality.