Skip to main content

Articles in this section

Print

Archive Change History rule

  • Updated

Archive Change History rule

Rule description

This rule archives and cleans up Change History based on the defined age. Use this rule in standalone and classic replication deployments of Cayosoft Administrator. Refer to the following article to learn more about Change History and data it contains: Auditing Cayosoft Administrator with Change History and Execution History.

Using the rule

IMPORTANT: Before you run the rule, specify the SQL Server settings for the Change History archive database in Configuration > Settings > Change History. and schedule this rule to run daily.

Use the rule to archive the Change History to a dedicated database. Cayosoft Administrator prompts the following alert message when the Change History size exceeds 1 GB, 2 GB or 5 GB, and the rule is not configured and/or scheduled:

Change history database size exceeds 1GB. Change history is not being archived.
Please configure and schedule the Archive

Rule settings

Query section

Setting name Description

SQL instance

Specify the name of the SQL Instance where the database with archived Change History will be stored. Use SERVER\INSTANCENAME.

SQL credentials

Specify the SQL Server credentials.

IMPORTANT: The specified account must use the SQL Server authentication.

Database name

Specify the database name where archived Change History data will be stored.

Table name

The table name is mandatory.

Specify the table name. The table will be created if it doesn't exist.

The Default Archive SQL Table value is taken from the Table setting in the Change History settings.

Action section

Setting name Description

Cleanup action

Specify the cleanup action:

  1. Archive to SQL instance and then delete: all old records will be moved to MS SQL instance first and then removed from local storage. You need to have valid SQL settings in the Query section.
  2. Delete without archiving: all old records will be removed without moving them to the archive database. In this case, you don't need to specify SQL settings in the Query section.

Delete records older than

This is the Change History record retention value specified in months. The number of months specifies how long the Change History will remain available in the Web Portal before it is archived and/or deleted.

Output section

This section defines the output format of this rule.

To get more information about this section, please see the Rule Output section article.

Enforce/Schedule section

This section defines the schedule for how often to run the rule.

To get more information about this section, please see the Rule Enforce/Schedule section article.

Additional information

  • The rule is supported only by standalone and classic replication deployments of Cayosoft Administrator. When you run the rule in a centralized DB replication environment, the following error is prompted:

    The rule is not supported by the centralized DB replication scheme.

    To resolve the issue, set up and run the Change History Details from Archive (Centralized DB Replication) rule.

  • The rule requires you to define the SQL Server connection settings in Configuration > Settings > Change History. The settings are missing if you encounter the following error in the execution report:

    Instance name not specified. Please specify the instance name for archiving change history.

Version history

Version Changes
13.1 The rule description has been updated.

© Copyright 2013-2026 Cayosoft Inc. All rights reserved.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request
Return to top

Related articles

Comments

0 comments

Please sign in to leave a comment.