Document store maintenance
The document store maintenance reports are available to report, delete, and archive files in the Document Store. Reports are created using Product Master Scripts and can be scheduled to run on an appropriate maintenance window using the Product Master scheduler.
There are two reports for document store maintenance:
- IBM® MDMPIM DocStore Volume Report
- This report provides the number of files in each of the root directories in the Document Store and also the number of files in the sub-directories of three high volume directories.
- IBM MDMPIM DocStore Maintenance Report
- This report deletes or archives files in the Document Store directories that are based on the information that is provided in a Lookup table.
These two reports have the following dependent Product Master objects:
| Product Master Object Name | Product Master Object Type | Usage |
|---|---|---|
| IBM MDMPIM DocStore Volume Script | Script file in DocStore directory /scripts/reports/ | Script file that is used by IBM MDMPIM DocStore Volume Report |
| IBM MDMPIM DocStore Maintenance Script | Script file in DocStore directory /scripts/reports/ | Script file that is used by IBM MDMPIM DocStore Maintenance Report |
| DB_Queries | Script file in DocStore directory /scripts/IBM MDMPIM Data Maintenance/ | Script file that is used by IBM MDMPIM DocStore Maintenance Report |
| IBM_MDMDocStore_Maintenance_Lookup | Lookup Table | Input parameters that are used by IBM MDMPIM DocStore Maintenance Report |
| IBM_MDMDocStore_Maintenance_Lookup_Spec | Lookup Table Spec | Lookup Table Spec for IBM_MDMDocStore_Maintenance_Lookup lookup table |
| IBM MDMPIM Data Maintenance Distribution | Distribution | A dummy email distribution that is used by reports. Modify the distribution with appropriate distribution method. |
Attributes definition for IBM_MDMDocStore_Maintenance_Lookup
table
| Lookup attribute | Comment |
|---|---|
| Key | Lookup Key |
| Directory_Name | DocStore directory name to be archived or purged. Value should be a valid DocStore directory name that starts with "/". |
| Action_on_Directory_files | Action to be performed on the DocStore directory. Valid values are "purge" or "archive". |
| Days_to_keep | Number of days before current date, the DocStore directory files are preserved. Action is performed on the DocStore directory files older than given the number of days. This value should be a positive integer or zero. |
Default values in the IBM_MDMDocStore_Maintenance_Lookup table
and the default action by the IBM MDMPIM DocStore
Maintenance Report.
Modify these Lookup table values or add new values per your
environment before you run the maintenance report job.
| Directory_Name | Action_on_Directory_file | Days_to_keep | Action that is performed by the IBM MDMPIM DocStore Maintenance Report |
|---|---|---|---|
| /reports/ | purge | 30 | Files in the /reports/ DocStore directory older than 30 days are deleted. |
| /job_summary/ | purge | 30 | Files in the /job_summary/ DocStore directory older than 30 days are deleted. |
| /archives/ | archive | 30 | Files in the /archives/ DocStore directory older than 30 days are archived to a compressed file then deleted. |
| /entryprocessor/ | purge | 30 | Files in the /entryprocessor/ DocStore directory older than 30 days are deleted. |
| /feed_files/ | purge | 365 | Files in the /archives/ DocStore directory older than 365 days are deleted. |
Sample IBM MDMPIM DocStore Volume Report output
DocStore Volume Report for ibm Company
Files in Top-Level Directories
| Directory name | Number of files |
|---|---|
| /job_summary | 31 |
| /reports | 31 |
| /scripts | 10 |
| /params | 2 |
| /schedule_logs | 2 |
Files in Subdirectories of /job_summary
No Subdirectories
Files in Subdirectories of /reports
| Directory name | Number of files |
|---|---|
| /reports/03-MAR-2010 14:41:42 | 1 |
| /reports/03-MAR-2010 14:54:42 | 10 |
| /reports/03-MAR-2010 15:05:26 | 12 |
| /reports/03-MAR-2010 16:54:46 | 8 |
Files in Subdirectories of /scripts
End of DocStore Volume Report
| Directory name | Number of files |
|---|---|
| /scripts/triggers | 4 |
| /scripts/reports | 2 |
| /scripts/ldap_usr_fetch | 1 |
| /scripts/login | 1 |
| /scripts/logout | 1 |
| /scripts/report | 1 |
Sample IBM MDMPIM DocStore Maintenance Report output
DocStore Maintenance Report for ibm Company
DocStore Maintenance completed successfully
| Directory name | Action completed | Files deleted | Cut off date | Archived compressed file |
|---|---|---|---|---|
| /reports/ | purge | 30 | 2010-02-23 00:05:55 | none |
| /job_summary/ | purge | 30 | 2010-02-23 00:05:55 | none |
| /archives/ | archive | 30 | 2010-02-23 00:05:55 | /IBM_MDMDocStore_Maintenance/Archives/2010-03-25 00:05:55/archives.zip |
| /entryprocessor/ | purge | 30 | 2010-02-23 00:05:55 | none |
| /feed_files/ | purge | 365 | 2009-03-25 00:05:55 | none |