Archive Service

What is Archive Service?

The Archive Service is automatically installed on servers that host any Virtual Hold Technology component. The purpose of the service is to compress and store log files generated by the system for use in troubleshooting and system maintenance. The archive service continually monitors your system to collect, compress and archive logs. Virtual Hold Technology recommends retaining archive log files for seven days.

A file can be archived when it meets the following requirements:

  • The log file is older than the time specified in the FileAgeToProcess registry setting.

  • The log file is not open for writing.

The Archive Service performs the following tasks each time it runs:

  1. Reads the registry settings to determine parameters.

  2. Searches the directory specified in the MainLogFilePath registry setting.

  3. Compares the file age to the age entered in the FileAgeToProcess registry setting.
    • If the file is less than the registry value, it is ignored.

    • If the file is greater than or equal to the registry value, it proceeds to the next step.

  4. Determines if the log file is for the Management API and/or Notification Server component.
    • If yes, renames the file in the following format: component_name_yyyyMMdd_hhmmss_error.log, compreses it and adds it to the archive.

    • If no, compresss the file and adds it to the archive.

  5. Deletes files older than the number of days in the ArchiveAgeToDelete registry setting.

  6. Repeats the process based on the value in the ScanInterval registry setting.

After installation, registry settings are used to configure the following

Configuring Archive Service

Archive Service can be configured via a series of registry subkeys, including:

  • When the Archive Service runs
  • Where the archived files are located
  • Which logs are included in the archive
  • When archives are deleted
  • The method of file compression (.7z or .zip)