Performs an archival operation on a Citadel database.

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


icon

Inputs/Outputs

  • 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 indicates no timeout, which means this VI waits indefinitely until this VI receives data from the Citadel database. This VI ignores this value if you set show status bar to TRUE.

  • 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 data logged up to now.

  • catrn.png start timestamp —

    start timestamp specifies the start date and time of data you want to retrieve from the Citadel 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, this VI uses the timestamp of the first data point in the database.

  • catrn.png stop timestamp (now) —

    stop timestamp is the end date and time of data you want to retrieve from the Citadel database. This VI 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, this VI uses the timestamp of the last data point in the database.

  • cpath.png source database URL —

    source database URL is the computer name and database name of the database to perform the data operation on.

  • cpath.png destination database URL —

    destination database URL is the computer name and database name of the Citadel historical or alarm and event database to receive the archival data.

  • c1dgenclassrntag.png trace names —

    trace names specifies the traces. You can specify either Shared Variable references or existing traces for this input.

  • cerrcodeclst.png error in (no error) —

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

  • ccclst.png options —

    options are the settings for the archive operation.

  • cbool.png show status bar (T) —

    show status bar enables a progress bar during the operation if show status bar is TRUE.

  • cbool.png compact (T) —

    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.

    Note This VI does not compact the source database that is in use. If you set this input to TRUE when the source database is in use, this VI only archives the data and returns an error.
  • cbool.png use * as wildcard (F) —

    use * as wildcard signals this 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.

  • cbool.png delete data from source database (F) —

    delete data from source database sets this VI to delete archived data from the source database. If delete data from source database is TRUE, this VI deletes archived data. If delete data from source database is FALSE (default), this 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, this 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, this VI archives the data but does not delete the data and returns an error.

  • ipath.png source database URL out —

    source database URL out is the database URL of the source database.

  • ipath.png destination database URL out —

    destination database URL out is the database URL of the destination database.

  • ierrcodeclst.png error out —

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