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 on a Citadel database.

Use the Alarm & Event Archive VI to archive alarm and event data.

	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.
	time interval is the span of time between the start timestamp and stop timestamp. If you do not wire this input, the VI reads all data logged up to now. start timestamp is the start date and time of data you want to retrieve from the database. The LabVIEW Datalogging and Supervisory Control (DSC) Module retrieves the entire page on which the data appears. When you view the data, you might see data logged before the actual time you specified.If you do not wire this input, the DSC Module uses the timestamp of the first data point in the database. stop timestamp is the end date and time of data you want to retrieve from the database. The DSC Module retrieves the entire page on which the data appears. When you view the data, you might see data logged after the actual time you specified.If you do not wire this input, the DSC Module uses the timestamp of the last data point in the database.
	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.
	trace names specifies the traces. You can specify either Shared Variable references or existing traces for this parameter.
	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.
	options are the settings for the archive operation. show status bar enables a progress bar during the operation if show status bar is TRUE. compact compacts the source database to free the disk space previously consumed by the removed data if compact is TRUE. This input has no effect if no gaps exist in the database that is being archived. If you set this parameter to FALSE, the source database is not compacted. use * as wildcard signals the VI to interpret the asterisk character as a wildcard character in any trace name given if use * as wildcard is TRUE. The wildcard matches any set of zero or more characters. 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.
	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.