Once the retention period has ended, the recorded data is either exported or deleted from the One Identity Manager database depending on which archiving method has been chosen. A longer retention period should be selected for sections whose records will be exported than for those that will be deleted.
The recordings are not exported until the retention period for all sections has expired and no other active processes for the process group (GenProcID) exist in the DBQueue, process history, or as scheduled operation.
NOTE: If you do not specify a retention period, the records in this section will be deleted daily from the DBQueue Processor database within the daily One Identity Manager maintenance tasks.
You use configuration parameters to define the data retention periods for the individual sections. Modify the configuration parameter in the Designer.
Table 3: Configuration parameter for retention periods
Common | ProcessState | PropertyLog | LifeTime |
This configuration parameter specifies the maximum retention period in the database for log entries from change tracking. |
Common | ProcessState | ProgressView | LifeTime |
This configuration parameter specifies the maximum length of time that log data from process information can be kept in the database. |
Common | ProcessState | JobHistory | LifeTime |
This configuration parameter specifies the maximum retention period in the database for log entries from process history. |
Example 1:
Records are transferred directly to the One Identity Manager History Database. The following configurations are selected for each section:
Export data |
No |
No |
Yes |
Retention period |
3 days |
4 days |
5 days |
This results in the following sequence:
Day 3 |
Data is deleted from the One Identity Manager database |
No action |
No action |
Day 4 |
- |
Data is deleted from the One Identity Manager database |
No action |
Day 5 |
- |
- |
Data is transferred to the One Identity Manager History Database and then deleted from the One Identity Manager database |
Example 2:
Records are transferred directly to the One Identity Manager History Database. The following configurations are selected for each section:
Export data |
Yes |
No |
Yes |
Retention period |
3 days |
4 days |
5 days |
This results in the following sequence:
Day 3 |
No action because the retention period has not ended for all sections. |
No action |
No action |
Day 4 |
No action because the retention period has not ended for all sections. |
Data is deleted from the One Identity Manager database |
No action |
Day 5 |
Data is exported and then deleted |
- |
Data is transferred to the One Identity Manager History Database and then deleted from the One Identity Manager database |
Data can be transferred directly from the One Identity Manager database into a One Identity Manager History Database. This is the default procedure for data archiving.
To use this procedure, make the following configuration settings in the One Identity Manager database:
-
Enable the Common | ProcessState | ExportPolicy configuration parameter in the Designer and enter the value HDB.
-
Configure the sections for export and define a retention period.
-
In the Designer, check the value of the Common | ProcessState | PackageSizeHDB configuration parameter. This parameter specifies the maximum number of progress groups that can be transferred to the One Identity Manager History Database. The default value is 10000.
-
Ensure that the Transport to history database schedule is enabled.
The schedule ensures the transfer of data from the One Identity Manager database to the One Identity Manager History Database. The schedule is run by default every 6 hours. In the Designer, adjust the interval as required.
Related topics
If records from separate sections are kept in the One Identity Manager database for a certain amount of time but are not archived later, you have the following options:
-
To exclude a certain section from archiving, do not configure it for export, just specify a retention period.
-
To delete all sections without archiving, specify a retention period. In the Designer, set the Common | ProcessState | ExportPolicy configuration parameter and enter the value NONE.
The records are deleted from the One Identity Manager database by DBQueue Processor when the retention period has ended. In addition, all entries for triggered actions are deleted if they have no corresponding records in those sections.
NOTE: If you do not specify a retention period, the records from that section are deleted from the One Identity Manager database during daily DBQueue Processor maintenance tasks.
Related topics
If there is a large amount of data, you can specify the number of objects to delete per DBQueue Processor operation and run in order to improve performance. You use configuration parameters to make the choice for each section.
Table 4: Configuration parameters for deleting logged data changes
Common | ProcessState | PropertyLog | Delete |
Allows configuration of deletion behavior for logged data changes. |
Common | ProcessState | PropertyLog | Delete | BulkCount |
Number of entries to be deleted in any operation. The default value is 200. |
Common | ProcessState | PropertyLog | Delete | TotalCount |
Total number of entries to be deleted in any processing run. The default value is 10000. |
Table 5: Configuration parameters for deleting process information
Common | ProcessState | ProgressView | Delete |
Allows configuration of deletion behavior for process information. |
Common | ProcessState | ProgressView | Delete | BulkCount |
Number of entries to be deleted in any operation. The default value is 200. |
Common | ProcessState | ProgressView | Delete | TotalCount |
Total number of entries to be deleted in any processing run. The default value is 10000. |
Table 6: Configuration parameters for deleting process history
Common | ProcessState | JobHistory | Delete |
Allows configuration of deletion behavior for the process history. |
Common | ProcessState | JobHistory | Delete | BulkCount |
Number of entries to be deleted in any operation. The default value is 200. |
Common | ProcessState | JobHistory | Delete | TotalCount |
Total number of entries to be deleted in any processing run. The default value is 10000. |
Table 7: Configuration parameters for deleting process status entries
Common | ProcessState | Delete |
Allows configuration of deletion behavior for process status entries. |
Common | ProcessState | Delete | BulkCount |
Number of entries to be deleted in any operation. The default value is 500. |
Common | ProcessState | Delete | TotalCount |
Total number of entries to be deleted in any processing run. The default value is 10000. |