The Archive Configuration Screen

To display the Archive Configuration screen, click the Edit button on the Data Stores page.

The Archive Configuration screen lets you read and modify the parameters of archives and data stores. In this screen, you can see the list of all archives of the selected data store.

To examine a particular archive, select the archive and then click the Edit button. The details of the archive are displayed in the Archive Details section.

Points To Remember

  • You may need to add an archive when the current archive is almost full and you have not enabled automatic creation of archives.
  • You may need to restore an archive when you start up after an unplanned shutdown or when you need to retrieve data from an old, inactive archive.
  • You may need to back up an archive before a planned Historian software product upgrade.
  • You may need to manually resynchronize archives when the archives in the mirrored environment are not synchronized.

Action Buttons

Click a button to perform the action indicated by the name. The following table describes these buttons.

ButtonAction
Add Archive Click this button to add a new archive to the data store.
Remove Archive Remove an archive. First click an archive name to select it, and then click Remove. Clicking OK removes the archive file from the list of archives for the system, and places it in the \Archives\Offline directory. This does not delete the archive file from the system. An archive must be closed before it can be removed.
Close Archive Manually close the current archive. An archive must be closed before it can be removed.
Backup Archive Back up a selected archive. Verify the file name and path and then click OK to save the file.
Restore Archive Restores an archive from backup.
UpdateApply all parameter changes that you have made in this screen. If you want to cancel changes and return to the original values or settings, open a different screen and then return to the Archive Configuration screen.
EditClick this to edit the Archive configuration details.

Statistics Section

Indicates the current status of the collector.
  • Running indicates that the collector is operating.
  • Stopped indicates that it is in pause mode and not collecting data.
  • Unknown indicates that status information about the collector is unavailable at present, perhaps as a result of a lost connection between collector and server.
Table 1. Configuration Tab
FieldDescription
Default Archive PathThe path name that will be used for any newly created archives. If you change the path, the change takes effect the next time a new archive is created.
Note: Do not use a period in the default archive path field. If a period is present in the default archive path, you will not be able to specify a default archive name.
Default Backup Path The location to which the backup file will be saved.
Archive Duration (Days/Hours)Specifies the duration of a newly created archive in days or hours. A new archive will be created after the selected number of days or hours.
Note: When the Archive Duration property is changed in a mirrored environment, the changes will take effect only after a time gap of 15 minutes.
Data is Read-only After (Hours) The number of hours, prior to now, for which data can be stored in a read/write archive. After the time expires, that portion of the archive file is automatically made read-only. Incoming data values with timestamps prior to this time are rejected.

A single archive file, therefore, may contain a read-only section, another read-write section containing recently written data, and unused free space.

Note: A read-only archive file cannot be moved using Windows Explorer. To move a read-only archive file, select the file and click the Remove button on the Details Tab of the Archive Maintenance screen. The Archiver then releases its locks, which permits you to move the file at will.
Base Archive NameA prefix that is automatically added to the file name of all created archives. To change the prefix, enter a new text string and click Update.
Free Space Required (MB) Indicates the remaining disk space required after a new archive is created. If the available space is less than the requirement, a new archive is not created. The default is 5000 MB.

The Free Space Required field does not apply to alarm and event archives. The alarm and event archiver will continue writing to the alarm and event archive until the drive is full. If this occurs, the alarm and event archiver will buffer incoming alarm and event data until the drive has free space. An error will also be written to the Historian message log.

Automatically Create Archives (Enable/Disable) Select the appropriate button to enable or disable this function. When enabled, the server automatically starts a new archive in the default path directory whenever the current archive fills up. If disabled, no new data will be written to the archives once the default size has been reached.
Note: To create multiple archives at the same time, Automatically Create Archives must be Disabled.
Overwrite Old Archives (Enable/Disable)Select the appropriate button to enable or disable this function. When enabled, the system replaces the oldest archived data with new data when the default size has been reached.
  • To create multiple archives at the same time, Overwrite Old Archives must be Disabled.
  • If you enable both Automatically Create Archives and Overwrite Old Archives, then you must set ihArchiveFreeSpaceHardLimit to TRUE using APIs.
CAUTION: Since this action deletes historical data, exercise caution in using this feature. Be sure that you have a backup of the archive so that you can restore it later.
SCADA Buffer Duration (Days)Indicates the maximum number of days the trend data can be stored. The maximum number of days is 200 days.

This field applies only to SCADA Buffer Data Stores.

Use Caching (Enabled/Disabled) When reading data from the archiver, some data is saved in the system memory and retrieved using caching. This results in faster retrieval as the data is already stored in the buffer. Enable the Use Caching option to retrieve data faster.

This option is not available for SCADA Buffer Data Stores.

Generate Message on Data Update (Enabled/Disabled)If this option is enabled, an audit log entry will be made any time the value of a previously archived data point in the Historian archive is overwritten. This log entry will contain both the original and new values.

To create multiple archives at the same time, Generate Message on Data Update must be Disabled.

This option is not available for SCADA Buffer Data Stores.

Store OPC Quality (Enabled/Disabled) Stores the OPC data quality.

To create multiple archives at the same time, Store OPC Quality must be Disabled.

Stale PeriodSpecifies the time period after which tags are considered stale for this data store. The value is defined in days. Valid values are:
  • 0 (zero): This default value means that tags are never considered stale. This effectively disables stale tag management.
  • 7 days (1 week) to 36500 days (100 years)
Stale Period CheckSpecifies the frequency with which the staleness of the tag is checked. The value is defined in days. Valid values are 1 day (the default) to 30 days.

Archives Section

The Archives section displays the list of archives available with the selected data store. To edit an archive, select the archive and click the Edit button. The details of the archive are displayed in the Archive Details section.
FieldDescription
NameThe name of the archive.
Start TimeThe time of the oldest sample in the archive.
End TimeThe time the archive is automatically or manually closed.

Archive Details Section

Archive Details section of the screen lets you read and modify all archiving parameters for the Historian system.
Table 2. Archiving Parameters
FieldDescription
StatusThe current operating state of the archive: Active, Current, Empty.
  • Current: Archive is actively accepting data.
  • Active: Archive contains data but is not currently accepting data.
  • Empty: Archive was created but has never accepted data.
Start TimeThe time of the oldest sample in the archive.
End Time The time the archive is automatically or manually closed.
Last Backup OnThe date and time the last backup was performed on this archive.
Backup ByUser name (at time of login to the Historian Administrator) of the person who performed the last backup of the archive.
File Location The path and name of the archive file.
File Size (MB)The size (in MB) of the archive file.
Note: Historian now supports a maximum Archive Size of 256 GB per archive.
File Attribute The attribute to set a closed archive to Read-only or Read/Write.
Note: If you plan to create multiple archives at the same time, then you must set File Attribute to Read/Write.