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

Owning Palette: Database Management VIs

Installed With: DSC Module

Performs an archival operation for alarms and events on a Citadel database.

	timeout limits the time that the VI waits for data to be returned from the database. The default value is 30 seconds. A timeout value of less than or equal to 0 indicates no timeout, and the VI waits indefinitely until the data is returned. The VI ignores this value if you set show status bar to TRUE.
	source database URL is the computer name and database name of the database to perform the data operation on.
	destination database URL is the computer name and database name of the Citadel historical or alarm and event database to receive the archival data.
	filter executes a more selective query of the historical alarms and events database. The 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, this VI archives all the alarm and event data to the destination database. If you do not wire values to the start timestamp and stop timestamp subparameters, this VI archives 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 the 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. The 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 to be retrieved from the database. If you do not wire this parameter, the alarm or event is extracted 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 to be retrieved from the database. If you do not wire this parameter, the alarm or event is extracted 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. The 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 to return the alarms in this alarm group, or area. 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 the 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.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	delete data from source database sets the VI to delete archived data from the source database. If delete data from source database is TRUE, the VI deletes archived data. If delete data from source database is FALSE (default), the VI does not delete archived data.You can delete archived data only from a local database and not from a remote database. If you try to delete data from a remote database, the VI returns an error. When you delete data, make sure that the source database is not in use. If the source database is in use, the VI archives the data but does not delete the data and returns an error.
	show status bar enables a progress bar during the operation if show status bar is TRUE.
	source database URL out is the database URL of the source database.
	destination database URL out is the database URL of the destination database.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.