This topic applies to the GN4 version 2.4 or newer.

In the AuditTable are saved many operations such as update of the config objects. These records are never deleted by a clean-up process, so the AuditTable will increase continuously.

Therefore, the cleanup process has been enhanced in the version 2.4 through additional features related to audit trail purging that are controlled by the ServerAuditConfig configuration file.

The configuration contains a Rules section with zero or more Rule elements providing fine control over the purging of specified object types. The format is the following:

  <ServerAuditConfig xmlns="http://www.teradp.com/schemas/GN4/1/ServerAuditConfig.xsd" 

    DefaultDeleteCount="500" DefaultTimeout="600">

    <Rules>

      <Rule ..... />

      <Rule ..... />

    </Rules>

  </ServerConfig>

Properties:

DefaultDeleteCount:

(integer) the default delete count that will be used by a purging rule. The default is 500.

DefaultTimeout:

(integer) the default timeout in seconds that will be used by a purging rule. The default is 300.

Rules section

The Rules section optionally contains one or more Rule elements, e.g.

  <Rules>

    <Rule ObjectTypeNames="object" Actions="Update AutoUpdate" RetentionCount="3"/>

    <Rule ObjectTypeNames="config" Action="Update AutoUpdate"  RetentionPeriod="2" />

A rule element has the following attributes:

ObjectTypeNames: (string) contains one or more object type name separated by a space that identify the object type name of the audit trail items to be purged.

IncludeDerivedObjectTypes: (boolean) indicates to include those object types derived from those specified in ObjectTypeNames. The default is true.

RetentionCount: (integer) if specified (is zero or more) indicates the number of audit trail items that match the ObjectTypeNames and Actions values that will be retained. Only one of RetentionCount and RetentionPeriod may be specified in a rule.

RetentionPeriod: (time span) if specified indicates the time span of audit trail items that match the ObjectTypeNames and Actions values that will be retained. Only one of RetentionCount and RetentionPeriod may be specified in a rule.

Actions: (string) contains one or more action separated by a space that are to be purged. The values can be any of the system actions apart from Create, i.e.: Login Logout Update Spike !Unspike AutoUpdate Startup Shutdown PartitionReset CopyTo Publish Unpublish Search Load CheckOut UncheckOut IncGlobalCounter IncCounter SpikeUpdate Print Open Close Variant Custom

DeleteCount: (integer) indicates the number of audit trail entries matching the rule that will be deleted at any one time. If not specified then the value used will be that generated by the value of DefaultDeleteCount in the ServerAuditConfig element.

Timeout: (integer) specifies the timeout in seconds used by the purging rules. If not specified then the value used will be that generated by the value of DefaultTimeout specified in the ServerAuditConfig element.