Purging system data using maintenance requests
A large amount of data is generated within Landmark, including action requests, database session debug logs, message queues, and effective dated group processing. Because preserving all of this data is typically unnecessary, schedulable actions are available to purge this data.
You can view the current list of the delivered framework purge actions on the Recurring Requests tab of the Async Framework. This tab shows the business class to which the data belongs and the specific action that is performed.
Many of these schedulable actions are delivered in an enabled state, and with settings for the scheduling frequency and data retention duration. Others may be delivered in a disabled state. You can select to enable all purge actions at once or enable the disabled ones individually. You can modify the delivered settings. For example, on the initial running of a purge action, if you know that a large amount of data is purged and you need to avoid a long-running process, you can adjust the setting for how far back to maintain data. You can start by preserving data from two years ago and onward, and then rerun the action with a setting that preserves data from one year ago and onward.
One important action that is delivered in an enabled state is a Purge action that removes AuditLogEntry records. This action prevents the potential large accumulation of these records. AuditLogEntry records are purged weekly based on these details:
- Records that have a FrameworkType set are purged if they are older than 180 days.
- Records that do not have a FrameworkType set are purged if they are older than 30 days.
You can purge archived AuditLogEntry records regardless of the date by selecting the Include Archived Framework Type Records and Include Archived Non Framework Type Records check boxes on the Purge Entries form.
To archive any of the data that is to be purged, set up data replication for the business classes that the purge actions apply to, and run the data replication before the purge action runs. Some actions already have queues and mappings set up, and for others, a System Purge queue is used.
- In the Async Administrator, select Setup and then click the Recurring Requests tab.
- Enable the maintenance request actions:
- To enable all actions at once, click Enable or Disable Request and select the Enable option. Click Submit.
- To enable a single action, select the action and select Yes in the Pending Scheduling option. Click Save.
Note: We do not recommend disabling maintenance request actions. - Optionally, modify the purge schedule and the data retention period:
- Select the action to modify and click Update.
- To make changes to the frequency settings, modify values in the Scheduling section.
- To make changes to the data retention period, click Parameters and modify the Thru Date or the Offset Days field.
This table shows the maintenance request actions that you can run:
Category Business class Action Description and rationale Pre-delivered schedule Applies to Async ActionResult PurgeCommandResults Purges result messages that are generated by certain types of jobs, such as jobs or job streams. These results are not generally needed long term. You can run this action using the ThruDate or Offset Days record selection rule.
60 days offset Weekly
All Async AsyncActionInvocation PurgeByDateRangeForAllUsers Purges async records that retain in static Java environments after the original records are deleted. This data is not generally needed long term. You can run this action based on a specified BeginDate, combined with ThruDate or Offset Days.
60 days offset Weekly
All Async AsyncActionTrigger DeleteFinishedTriggers Deletes records of background action instances that are recorded as Finished. This data is not necessary to keep, and excess data can slow performance. You can run this action using the ThruDate or Offset Days record selection rule.
60 days offset Weekly
All Async AsyncAuditEntry Purge Purges async audit records. These records are not intended for long-term storage, and you can replicate the records if needed. You can run this action using the ThruDate or Offset Days record selection rule.
30 days offset Weekly
All Async AsyncForecastSlice PurgeOldForecasts This action is part of the async schedule forecast feature and is used to purge all generated forecast slices or forecast data at specific times based on async schedules. Schedules and calendars change over time, so keeping these records permanently is not useful. You can always regenerate these records from the current schedules and calendars. You can run this action using the ThruDate or Offset Days record selection rule.
30 days offset Monthly
All Async AsyncSynchronizedGroup PurgeEmptyGroups Purges empty async synchronized groups. All Weekly
All Async EffectiveDatedGroup RemoveCompletedGroups Purges completed EffectiveDatedGroup records, which store updates that are scheduled for future processing. These records are temporary and not meant for long-term storage. You can run this action using the ThruDate or Offset Days record selection rule.
7 days offset Weekly
All Async WSMessageGroup PurgeWSTransactions Purges logs of async web service callouts, including WSI and non-Datalake ActionEventMessage calls. The activity and execution logs are captured in each WSMessage, and these messages are grouped under a WSMessageGroup. 7 days offset Weekly
All Audit AuditLogEntry Purge Purges audit log entries, selected application actions, or views of records within the Landmark system using these record selection rules: - FrameworkTypeThroughSystemDate
- FrameworkTypePurgeOffsetDays
- IncludeArchivedFrameworkTypeRecords
- NonFrameworkTypeThroughSystemDate
- NonFrameworkTypePurgeOffsetDays
- IncludeArchivedNonFrameworkTypeRecords
These audit records can grow significantly over time. These records are used mainly for short-term audit or triage purposes, and you can replicate the records if needed.
180 days offset days for framework records 30 days offset for non-framework records
All Audit AuditLogEntry ResetColumnarReplicationSetBC Resets audit log entries, selected application actions, or records views within the Landmark system and to reset the columnar replication set for AuditLogEntry. Monthly All Audit HistoricalChangeLogEntry PurgeEntries Purges change log entries, keeping the most recent records. Monthly HRT only Integration BOD PurgeBODRecords Purges Business Object Document (BOD) records that are recorded as Sent, Handled, or Excluded. These records are not necessarily needed long term. You can run this action using the ThruDate or Offset Days record selection rule.
3 months offset Daily
All Integration EmailMessageQueue PurgeSentEMails Purges records of emails that are generated through the application that are recorded as Completed, including the deleted records. These records exist only to confirm that emails are generated and sent, not for long-term archiving. Email servers are the appropriate location for long-term storage. You can run this action using the ThruDate or Offset Days record selection rule.
7 days offset Weekly
All Integration EmployeeExport PurgeEmployeeExportAndRelatedRecords Purges employee export records. Transaction records in holding files are created in the EmployeeExport to support data transfers to external applications. These records can include both the primary employee export and other employee-related export records. You can run this action using the ThruDate or Offset Days record selection rule.
None HRT only Integration FileCreationSetup PurgeFileCreationRecordOrFile Purges file creation records for a HROrganization and one or more FileCreationSetups, with IgnoreGenericRecordStatus and KeepLatestExportPerEmployee enabled. 3 months offset Daily
HRT only Integration IDMLog PurgeSet Purges logs of the IDM transactions. IDMLogs are used only for debugging and are not generally needed long term. 30 days offset Daily
HRT only Integration IDMPrintJob PurgePrintJobs Purges records created in the IDMPrintJob when a saved document in IDM is submitted for printing. These records are only accessed at the end state of a PrintJob. 30 days offset Daily
HRT only Integration IDMTextSearch PurgeTextSearch Purges saved text search results within IDM business classes. These records are captured from IDMDocument BL itself and are not generally needed, because you can perform new text searches at any time. 30 days offset Daily
HRT only Integration IMSReceiver Purge Purges processed and received BOD records from the IMS, including records with Complete, Failed, Failed Confirm Only, or Deleted statuses. These records are not necessarily needed long term. 14 days offset Weekly
All Integration IONOutboxQueue Purge Purges records of ION outbox activity with a Processed status. These records are not necessarily needed long term.
You can run this action using the ThruDate or Offset Days record selection rule.
7 days offset Weekly
All Integration LawsonClassicMessageGroup PurgeClassicTransactions Purges completed LSF or S3 classic transactions from Landmark that are managed within LawsonClassicMessageGroup, including deleted records. These records are not necessarily needed long term. 7 days offset Weekly
All Integration M3MessageGroup PurgeM3Transactions Purges completed M3 interactions from Landmark that are managed within M3MessageGroup, including deleted records. These records are not necessarily needed long term. 7 days offset Weekly
All Integration RepSetBCValidationResult PurgeOldValidationResults Purges result records that are generated during replication set validation runs. These records are not necessarily needed long term. You can run this action using the ThruDate or Offset Days record selection rule.
30 days offset Monthly
All Reports ReportData PurgeData Purges output data that are generated by static java type programs, which is used only for generating PDF, CSV, and Excel static java reports. These records are needed only if any PDF, CSV, Excel report is lost and needs regeneration. You can run this action using the ThruDate or Offset Days record selection rule, and set Include Report Document field to false.
180 days offset Weekly
All Reports UserReport PurgeReports Purges records of user-generated document exports or reports. You can run this action using the ThruDate or Offset Days record selection rule, with IncludeFolders and AlwaysApplyDateOrOffset options enabled.
180 days offset Weekly
All Security DBSessionDebug DeleteDebugLogs Deletes debug log records, which are typically created to triage issues with support. These records are not necessarily needed long term, and you can regenerate them if needed. You can run this action using the ThruDate or Offset Days record selection rule.
7 days offset Weekly
All Security SecuritySessionDebug PurgeSessionDebugLogs Purges security session debug logs that are generated during authentication or authorization triage. These records are not necessarily needed long term, and you can regenerate them if needed. You can run this action using the time-based record selection rule.
7 days offset Weekly
All Security SessionAudit PurgeSessionAudit Purges audit and debug logs that are related to security session information. You can run this action using the time-based record selection rule.
7 days offset Weekly
All Workflow ActionRequest PurgeWithDeletedRecords Purges records of RequestAction type actions that are recorded as completed or rejected, including deleted records. These records are not necessarily needed long term. When an action request is completed, the requested changes are added to the business class tables with audit log entries. You can run this action using the ThruDate or Offset Days record selection rule.
60 days offset Weekly
All Workflow PfiFileStorage ScheduleFileDeletion Purges file storage records that are managed by IPA in a multi-tenant environment, which replaces direct access to the file system. These records are temporary files created by a flow execution or user-uploaded files used in one or more flows. PfiFileStorage contains large file data that can grow in size. These files are temporary and are created during the execution of work units. These files are not necessarily needed long term. You can run this action to purge files that are older than 90 days.
90 days offset Weekly
All Workflow PfiWorkunit ScheduleNonUAWorkUnitDeletion Purges non-UA work units from PfiWorkunit. A work unit is the data structure for a process flow invocation, containing runtime metadata such as the actor, start and end times, restart counts, and links to optional runtime logs. Child classes store related information, including activities such as approvals, error messages, and variables. This purge action is applied only to:- Work units with a Completed or Cancelled status
- Work units that are not of the ActionRequest type
- Work units with no associated PfiQueueTask
These records are transactional. When a work unit is completed, these records typically have no further review value. You can run this action to purge files that are older than 90 days.
90 days offset Weekly
All Workflow ProcessFlowQueue PurgeCompleteFlows Purges process flow records from ProcessFlowQueue. In single-tenant or on-premises environment, ProcessFlowQueue is used to queue and manage work units requiring processing, including execution order and status. In multi-tenant environment, this business class is used to take action on work items in the Inbasket and to cancel work items through AsyncActionRequest. These records are transient and not purged with PfiWorkunit.
90 days offset Weekly
All Workflow UserNotification PurgeNotificationsWithDeleted Purges read and unread notification records from the Inbasket or application, including deleted records. You can run this action to purge files that are older than 90 days.
90 days offset Weekly
All