Settings Applicable to Data Purges
Settings Applicable to Data Purges
This section describes the settings that affect data purges. These settings are all specific to the namespace in which they are set. Users with appropriate permissions can modify these.
Where to modify this setting:
-
Purge Management Data page
-
Purge Data Settings page
-
Task Scheduler Wizard page (as BodiesToo)
Default: disabled
Specifies whether to purge message bodies in addition to message headers (which are always purged) during a purge operation.
If this setting is enabled, InterSystems IRIS purges message headers and their corresponding message bodies. If this setting is disabled, InterSystems IRIS purges only message headers and retains any corresponding message bodies.
The system verifies that body classes exist and are persistent before purging them.
If InterSystems IRIS purges only message headers, the system may accumulate large quantities of message bodies. You cannot delete the retained message bodies from the Management Portal. You can delete them only programmatically. Consequently, InterSystems recommends that you consider your disk space and workflow when you configure the Include message bodies or BodiesToo setting.
Additionally, when InterSystems IRIS purges a message body, it does not necessarily delete all the object-valued properties of the message body. The system deletes only objects that have a serial or child relationship to the message body. You must delete other objects manually by defining a delete trigger or implementing the %OnDelete() method in the message body class, as appropriate. For more information about object-valued properties, see Defining and Using Object-Valued Properties.
Where to modify this setting:
-
Purge Management Data page
-
Purge Data Settings page
-
Task Scheduler Wizard page (as KeepIntegrity)
Default: enabled
Specifies whether to skip messages that are part of incomplete sessions during the purge process.
If this setting is enabled, when InterSystems IRIS encounters a message that meets the age criterion for purging, but is in an incomplete session, the system does not purge the message header or body. An incomplete session corresponds to any session that includes a message with a status other than Complete, Error, Aborted, or Discarded.
If you enable the Purge only completed sessions or KeepIntegrity setting, InterSystems IRIS executes a query that reviews all the messages (including business process instances) in each relevant session to identify any incomplete sessions. Consequently, enabling this setting can increase the amount of time required to complete a purge operation.
Preserving session-level integrity supports long-running business processes. InterSystems recommends that you consider whether you need to support long-running business processes and whether your system contains insignificant old messages in incomplete sessions when you configure the Purge only completed sessions or KeepIntegrity setting.
Purge operations can include messages associated with long-running system processes, such as workflow processes. If you disable this setting, carefully review the Do not purge most recent value to ensure that you do not purge critical system data.
Where to modify this setting:
-
Purge Management Data page
Default: disabled
Specifies whether to also clean up the associated bitmap indices in the same namespace.
Where to modify this setting:
-
Purge Management Data page
-
Purge Data Settings page
This setting is shown in the same places as Include message bodies and Purge only completed sessions and is intended to explain those settings.
Default: "Include message bodies" is OFF because some Productions may use message objects that are part of a larger environment and not transitory. "Purge only completed sessions" is ON to preserve messages not yet completely processed.
Edit Description as needed, if you modify the two settings it describes.
Where to modify this setting:
-
Purge Management Data page
-
Purge Data Settings page
-
Task Scheduler Wizard page (as NumberOfDaysToKeep)
Default: 7
Specifies how many days’ worth of records to keep. The count of days includes today.
If you set the value to 0 (zero), InterSystems IRIS does not keep any records and purges all the entries that exist at the time of the purge operation. If you set the value to 1 , InterSystems IRIS retains only the messages generated on the current day, according to local server time.
Where to modify this setting:
-
Task Scheduler Wizard page
Default: Events
Specifies the types of records to purge.
