Managing Your Database › Archive and Purge Rules › Archive and Purge Rule Definitions › Create an Archive and Purge Rule › Archive and Purge Rule Fields

Archive and Purge Rule Fields

You can use the fields on the Archive and Purge Rule pages to define and edit rule definitions.

Rule Name

(Required) Specifies a unique identifier for the rule. Can be up to 30 alphanumeric characters.

Status

(Required) Indicates whether this rule is Active or Inactive.

Schedule

Specifies a workshift in which the rule should be in effect. Workshifts are defined by the Administrator.

Recurrence Interval

Specifies how often this rule is run, in the format hours:minutes:seconds (HH:MM:SS).

Archive File Name

Specifies the name of the file where you want the out-dated records stored. Its location is controlled by the NX_RULE_ARCHIVE_PATH variable stored in the NX.env file. Archive data files can be restored to the database using the PDM_LOAD utility.

Operation Type

Specifies one of the following types of operation that the rule should execute:

Archive/Purge

Purges outdated records from the database that are written to the file specified in the Archive File Name field.

Purge Only

Purges outdated records from the database, but they are not written to the archive file.

Archive Only (Test Run)

Writes outdated records to the archive file without purging them from the database. Use this option to test a newly created or edited archive and purge rule.

Config. Object Name

Specifies the name of the database object this rule can archive and purge.

Object Name

(Read-only) Populates your selection in the Config. Object Name field automatically.

Days Inactive

Specifies the number of days a record is inactive to be eligible for archive and purge from the database.

Additional Query

Archives and purges specific inactive records among the existing inactive records. Use this field when you want to create different rules for archiving and purging the subsets of expired records for the same object. Use the same syntax as you use for stored queries.

Examples: Specify Additional Queries

The following query archives and purges only assigned inactive request records with a priority of 1:

priority = 1 AND (assignee IS NOT NULL OR group IS NOT NULL) and active = 0

The following query format archives and purges records based on time-span:

close_date < EndAtTime(\'LAST_YEAR\')