Login
Home CMS Documentation Home CMS 10 Administration System Options CMS Settings Archiving

Archiving Configuration

Use Archiving Configuration to back up log files within Ingeniux CMS. The system sources the log entries from the CMS instance's Raven Database (RavenDB).

Administrators can configure archiving settings for the following log types:

  • Audit trail
  • Publish logs
  • Replication logs
  • Workflow logs
Use the settings to archive entries for each log type based on a schedule or based on an entry count. To archive logs outside of scheduling periods, administrators can execute the Force Archive action to immediately initiate the archiving process of current CMS logs.

This topic includes:

Configure Archiving Settings

Configure archiving settings for different log entry types.
To configure archiving settings:
  1. Navigate to Administration > System Options > CMS > Archiving.

    Archiving Configuration Settings

  2. Select one of the following log type options in the Type of log to archive drop-down list:
    OptionDescription
    Audit TrailTracks log entries for basic operations (e.g., create, edit, delete) executed within the CMS.
    Publish LogsTracks log entries for publishing operations executed within the CMS.
    Replication LogsTracks log entries for replication operations executed within the CMS.
    Workflow LogsTracks log entries for workflow operations executed within the CMS.
    The archiving settings for the log type display in the Archiving Configuration area.
  3. Select the Enable archiving for log type: [name-of-log-type] checkbox. This option activates archiving settings and operations for the selected log type.
  4. Configure the following settings:
    FieldDescription
    Archive by drop-down listSelect one of the following options:
    • Time (days). If selected, the system archives log entries based on a day schedule.
      Note
      This option requires values for the Max Number of Entries before Archiving and the Archiving Period fields. If the log reaches the maximum entry count before the system is scheduled to archive, then the system will archive those entries outside of the schedule.
    • Entry Count. If selected, the system archives log entries based on an entry count.
    Max Number of Entries before Archiving

    This field applies if you select either option in the Archive by in the drop-down list.

    Manually type in or use the number picker arrows to enter the maximum number of entries a log can contain before the system initiates archiving. When the log reaches this number, the system triggers and executes the archiving process.

    For example, if you enter the value 500 in this field, then the system will initiate archiving per every 500 entries for the selected log type.

    Archiving Period (Only Effective when Archived by Time)This field only applies if you select the By Time (days) option in the Archive by drop-down list.

    Manually type in or use the number picker arrows to enter the number of days that can pass before the system initiates archiving. For each time this number of days passes, the system triggers and executes the archiving process.

    For example, if you enter the value 30 in this field, then the system will initiate archiving every 30 days for the selected log type.

  5. Click the Save button to commit the changes.

    Archiving Configuration Settings

    Note
    The system stores the archived log files with the .ravendump file extension in [Drive]:[path-to-CMS-root-folder]\App_Data\Archives. System administrators require access to the CMS instance's RavenDB content store to open these files.

Force Archive

If administrators want to bypass the configured archiving settings, they can click the Force Archive button to immediately start the archiving process.
To force archive existing log entries:
  1. Navigate to Administration > System Options > CMS > Archiving.
  2. Select one of the following log type options in the Type of log to archive drop-down list:
    OptionDescription
    Audit TrailTracks log entries related to basic operations (e.g., create, edit, delete) executed within the CMS.
    Publish LogsTracks log entries related to publishing operations executed with the CMS.
    Replication LogsTracks log entries related to replication operations executed with the CMS.
    Workflow LogsTracks log entries related to workflow operations executed with the CMS.
    The archiving settings for the selected log type display in the Archiving Configuration area.

    Archiving Configuration Settings

  3. Click Force Archive to initiate the archiving process for the selected log type.
    The confirmation dialog displays.

    Archiving Configuration Settings

  4. Click Yes.
    The CMS message Archive Complete displays when the archiving process finishes. The CMS stores the archived log files in the CMS file system.
    Note
    The system stores the archived log files with the .ravendump file extension in [Drive]:[path-to-CMS-root-folder]\App_Data\Archives. System administrators require access to the CMS instance's RavenDB content store to open these files.