Table of Contents

Search

  1. Preface
  2. Starting Data Archive
  3. System Configuration
  4. Database Users and Privileges
  5. Source Connections
  6. Target Connections
  7. Archive Store Configuration
  8. Datatype Mapping
  9. Database Optimization
  10. SAP Application Retirement
  11. z/OS Source Data Retirement
  12. Seamless Data Access
  13. Data Discovery Portal
  14. Security
  15. SSL Communication with Data Vault
  16. LDAP User Authentication
  17. Auditing
  18. Running Jobs from External Applications
  19. Salesforce Archiving Administrator Tasks
  20. Upgrading Oracle History Data
  21. Upgrading PeopleSoft History Data
  22. Data Archive Maintenance
  23. Appendix A: Datetime and Numeric Formatting
  24. Appendix B: Data Archive Connectivity

Administrator Guide

Administrator Guide

Purge Expired Records Job

Purge Expired Records Job

The Purge Expired Records job purges records that are eligible for purge from the Data Vault. A record is eligible for purge when the retention policy associated with the record has expired and the record is not under legal hold. Create and assign retention policies before you run the Purge Expired Records job.
Run the Purge Expired Records job to perform one of the following tasks:
  • Generate the Retention Expiration report. The report shows the number of records that are eligible for purge in each table. When you schedule the purge expired records job, you can configure the job to generate the retention expiration report, but not purge the expired records.
  • Generate the Retention Expiration report and purge the expired records. When you schedule the purge expired records job, you can configure the job to pause after the report is generated. You can review the expiration report. Then, you can resume the job to purge the eligible records.
To determine the number of rows in each table that are eligible for purge, generate the detailed or summary version of the Retention Expiration report. To generate the report, specify a past or current date for Data Archive to base the report on. Data Archive generates a list of records that are eligible on that date. You can pause the job to review the report and then run the job again to purge the records.
You can choose to generate one of the following types of reports:
Retention Expiration Detail Report
Lists the tables in the archive folder or, if you specified an entity, the entity. Shows the total number of rows in each table, the number of records with an expired retention policy, the number of records on legal hold, and the name of the legal hold group. The report lists tables by retention policy.
Retention Expiration Summary Report
Lists the tables in the archive folder or, if you specified an entity, the entity. Shows the total number of rows in each table, the number of records with an expired retention policy, the number of records on legal hold, and the name of the legal hold group. The report does not categorize the list by retention policy.
To purge records, you must enable the purge step through the
SKIP_PURGE_STEP
parameter.
Before you purge records, use the
Search Within an Entity in Data Vault
search option to review the records that the job will purge. Records that have an expired retention policy and are not on legal hold are eligible for purge.
When you run the Purge Expired Records job to purge records, Data Archive reorganizes the database partitions in the Data Vault, exports the data that it retains from each partition, and rebuilds the partitions. Based on the number of records, this process can increase the amount of time it takes for the Purge Expired Records job to run. After the Purge Expired Records job completes, you can no longer access or restore the records that the job purged.
If you purge records, the Purge Expired Records job requires staging space in the Data Vault that is equal to the size of the largest table in the archive folder, or, if you specified an entity, the entity.
The following table describes the parameters for the Purge Expired Records job:
JSP Parameter Name
User Interface Parameter Name
Required or Optional
TARGET_REP_ID
Archive Store
Required.
Enter the name of the folder in the Data Vault that contains the records that you want to purge.
REPORT_TYPE
Report Type
Required.
Enter a value based on one of the following options:
  • To generate the Retention Expiration Detail report, enter:
    DETAIL
  • If you do not want a report with a list of expired records, enter:
    NONE
  • To generate the Retention Expiration Summary report, enter:
    SUMMARY
PAUSE_AFTER_REPORT
Pause After Report
Required.
Enter a value based on one of the following options:
  • To pause the job after Data Archive generates the report, enter:
    Y
    or
    Yes
  • To continue the job after Data Archive generates the report, enter:
    N
    or
    No
SKIP_PURGE_STEP
Purge Deleted Records
Required.
Enter a value based on one of the following options:
  • To logically delete records from the Data Vault, enter:
    N
    or
    No
  • To logically and physically delete records from the Data Vault, enter:
    Y
    or
    Yes
EAMIL_ID
Email ID for Report
Optional.
Enter the email address you want Data Archive to send the report to.
Use the following syntax to formulate the URL that calls the
JobHandler.jsp
.
To generate the Retention Expiration report:
Specify the name of the Data Vault archive folder and the type of report. Specify that the job pauses after it generates the report. Specify that the job skips the purge step. Optionally, enter an email address for Data Archive to send the report to. Use the following syntax for the URL:
http://<host>:<port>/jsp/JobHandler.jsp?&action=<job action>&ProcessName=PURGE_EXPIRED_RECORDS&TARGET_REP_ID=<name of the connection to the Data Vault>&REPORT_TYPE=<DETAIL or SUMMARY>&PAUSE_AFTER_REPORT=Y&SKIP_PURGE_STEP=N&EAMIL_ID=<email address>
To logically and physically delete eligible records from the Data Vault:
Specify the name of the Data Vault archive folder and the type of report. Specify that the job does not pause after it generates the report. Specify that the job performs the purge step. Optionally enter an email address for Data Archive to send the report to. Use the following syntax for the URL:
http://<host>:<port>/jsp/JobHandler.jsp?&action=<job action>&ProcessName=PURGE_EXPIRED_RECORDS&TARGET_REP_ID=<name of the connection to the Data Vault>&REPORT_TYPE=<NONE, DETAIL, or SUMMARY>&PAUSE_AFTER_REPORT=N&SKIP_PURGE_STEP=Y&EAMIL_ID=<email address>

0 COMMENTS

We’d like to hear from you!