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


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.

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

  • ccclst.png filter —

    filter executes a more selective query of the historical alarms and events database. This 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.

  • catrn.png start timestamp —

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

  • catrn.png stop timestamp (now) —

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

  • cstr.png shared variable name —

    shared variable name specifies to return the alarms with this shared variable name.

  • cstr.png process —

    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.

  • cstr.png set user —

    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.

  • cstr.png clear user —

    clear user specifies to return the alarms that this user cleared.

  • cstr.png ack user —

    ack user specifies to return the alarms that this user acknowledged.

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

  • cstr.png ack comment —

    ack comment specifies to return the alarms with this comment entered by ack user when he acknowledged the alarm.

  • cstr.png alarm description —

    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.

  • cdbl.png alarm setpoint —

    alarm setpoint specifies to return the alarms with this value as the trigger of the alarm.

  • cdbl.png value at alarm —

    value at alarm specifies to return all alarms that had this value when the alarm occurred.

  • ci32.png minimum priority —

    minimum priority sets 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.

  • ci32.png maximum priority —

    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.

  • ccclst.png filter on... —

    filter on is a set of checkboxes that you can use to specify that you want this VI to return the corresponding alarm information.

  • cbool.png start timestamp —

    start timestamp specifies whether to include the timestamp information in the results of the query.

  • cbool.png shared variable name —

    shared variable name specifies whether to include the name of the shared variable in the results of the query.

  • cbool.png process —

    process specifies whether to include the process information in the results of the query.

  • cbool.png set user —

    set user determines whether to display the name of the operator at the set time.

  • cbool.png clear user —

    clear user includes the name of the operator who cleared the alarm.

  • cbool.png ack user —

    ack user includes the name of the operator who acknowledged the alarm.

  • cbool.png alarm area —

    alarm area includes an alarm group. This VI returns only alarms and events belonging to this alarm group, or area.

  • cbool.png ack comment —

    ack comment includes the message entered by the ack user when he acknowledged the alarm.

  • cbool.png alarm description —

    alarm description includes the description of the alarm that the ack user entered.

  • cbool.png alarm setpoint —

    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.

  • cbool.png value at alarm —

    value at alarm includes the value of the shared variable at which the alarm occurred.

  • cbool.png minimum priority —

    minimum priority specifies whether to include the minimum priority in the results of the query.

  • cbool.png maximum results —

    maximum results specifies whether to include the maximum results in the results of the query.

  • cbool.png newfirst —

    return newest entries first specifies whether to return newest entries first in the results of the query.

  • cu16.png show... —

    show specifies whether this VI returns alarms, events, or both alarms and events.

  • ci32.png maximum results —

    maximum results specifies whether to include the maximum results in the results of the query.

  • cbool.png return newest entries first —

    return newest entries first specifies whether to return newest entries first in the results of the query.

  • cerrcodeclst.png error in (no error) —

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

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

  • cbool.png show status bar (T) —

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

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