You are here:
Order Management Standard: Settings for Automatic Purging of Orchestration Data
Administrators in OM Standard can schedule routines in Order Management to automatically purge old orchestration data from the records. This overview discusses the settings that you will configure when scheduling purges.
For instructions on how to configure the scheduled purges, see Order Management Standard: Automatic Purging of Orchestration Data.
The following data is purged when the purge job runs:
-
Orchestration items
-
Orchestration Item Source objects (that is, links between orders and their related orchestration items)
-
Orchestration item dependencies
-
Orchestration plans
The following settings (in XOM Custom Settings) control the purge job:
-
DataPurgeJobFrequencyHours: The frequency that the purge job runs, in hours. For example, if you want the purge job to run daily, then you set the value to 24. The default is 0 (that is, the purge job does not run at all by default).
-
DataPurgeRetentionPeriodDays: The age in days of the data to be purged. For example, if you want to purge only data that is older than one year, then you set the value to 365. The default is 1825 (5 years).
-
DataPurgeMaxRuntimeMins: The maximum number of minutes that the purge job runs each time that it runs. For example, if you want the job to stop running after two hours, then you set the value to 120. The default is 240.
This setting keeps the job from running longer than you want. The job stops purging after the set number of minutes has passed, and any unpurged data will be in the queue to purge the next time that the job runs.
-
DataPurgeJobBatchSize: This setting determines the number of records that can be picked for deletion in a batch. The default value is 2000 records per batch.
- Check the Status of the Purge Job
Check the status of a purge job from the Vlocity XOM Administration panel. You can also stop all purge jobs or schedule purge jobs, though first you have to set theDataPurgeJobFrequencyHourson the Custom Settings page.
