Content Manager Validation Utilities

Abstract

This document describes the two Content Manager validation utilities: The Resource Manager/Library Server validation utility and the Resource Manager volume validation utility.

Contents


Content Manager validation utilities are used to analyze discrepancies between three components: The Library Server, the Resource Manager, and the storage system(s) used by the Resource Manager through its defined device managers. Any of these components can fail and require a restoration via a backup that may be out of synchronization with the other two components. Because there is no direct link between the Library Server and the storage system (an example of a storage system is VideoCharger or Tivoli Storage Manager), differences must be reported between the Library Server and the Resource Manager, and the Resource Manager and the storage system, using the following utilities:
  • The Resource Manager/Library Server validation utility (icmrmlsval.sh or icmrmlsval.bat) generates reports that describe discrepancies between the Library Server and the Resource Manager.
  • The Resource Manager volume validation utility (icmrmvolval.sh or icmrmvolval.bat) generates reports on discrepancies between the Resource Manager and the storage system.
The reports are in XML. You can use commonly available XML tool or browser to view or manipulate the utility output files. Content Manager installs the XML DTD required by the validation utility output files.

You can modify the two utility files with information specific to your Content Manager system. The validation utilities are located in the bin directory in the Resource Manager installation directory.

The validation utility creates and drops a temporary DB2 table. The environment script requires the resource database name, user ID, password, schema, Web application path, and DB2 instance. To set the environment for both validation utilities, type setenvproc.bat or setenvproc.sh.

By default, the validation utilities log to a file named icmrm.validator.log in the WebSphere logs directory. You can modify the level of information logged and the location of the output in the icmrm_validator_logging.xml file. Be sure that the user ID that you use to run the utility has read permission to the XML file, and write permission to whatever log file that you configure for use.

The icmrm_validator_logging.xml file is installed with the Resource Manager code in the WebSphere Application Server installedApps path.
  • On AIX, the default path to the file is:
    /usr/WebSphere/AppServer/installedApps/icmrm.ear/icmrm.war/icmrm_validator_logging.xml
  • On Solaris, the default path is:
    /opt/WebSphere/AppServer/installedApps/icmrm.ear/icmrm.war/icmrm_validator_logging.xml
  • On Windows, the default path is:
    x:\WebSphere\AppServer\installedApps\icmrm.ear\icmrm.war\icmrm_validator_logging.xml

Resource Manager/Library Server validation utility
The Resource Manager/Library Server validation utility queries the Library Server for all of the objects created or updated in a specified time period. It then searches the Resource Manager database and detects any discrepancies. The utility runs on the Resource Manager server and requires connectivity to the Library Server database. To start the utility, navigate to the Resource Manager bin directory and type icmrmlsval.sh or icmrmlsval.bat.

The utility requires input parameters, which are described in the following table. Both dashes (-) and forward slashes (/) are handled as the parameter separator. The parameter tags are supported in both lower and upper case.


Parameter

Description

-B YYYY-MM-DD-HH.MM.SS

The beginning time and date of the objects to examine. Use this parameter with the -E parameter to restrict the number of objects that the utility must examine. This parameter is optional. If it is not present, all of the objects prior to the -E date are returned, or all of the objects are returned if -E is also not defined.

-E YYYY-MM-DD-HH.MM.SS

The ending time and date of the objects to synchronize. Use this parameter with the -B parameter to restrict the number of objects that the utility must examine. This parameter is optional. If it is not present, all of the objects after the -B date are returned, or all of the objects are returned if -B is also not defined.

-F output-path

The absolute path to be used for the output files. The utility creates the UTF-8 XML files in this directory. This parameter is required.

-H

This parameter displays help information about how to invoke the utility. All of the other parameters are ignored and no processing occurs.

The utility creates a temporary table, RMLSITEMS, used to accumulate object statistics for the validation. At the end of the validation, this table is normally dropped. If the utility determines that the table is present, it presumes another version of the utility is operating, and exits. If the table is left behind due to an aborted run, you need to drop this table. Connect to the Resource Manager database and drop the table with the following command:
    db2 drop table RMLSITEMS

The following line shows an example of how to invoke the Resource Manager/Library Server utility on an AIX server:
    ./icmrmlsval.sh -F /reportsdirectory -B 2002-08-30-00.00.00 -E 2002-09-01-00.00.00

The base file names of the reports are "icmrmlsval YYMMDDHHMMSS _"+Report Type string +".xml". The report type string identifies the type of discrepancies a report contains. The description of the different report types are detailed in this section. The timestamp allows the administrator to run the utility multiple times without overwriting the output files. Examples of default names with the default report type are:
  • cmrmlsval20020531123456_ORPHAN.xml
  • cmrmlsval20020531123456_NOTINRM.xml
  • cmrmlsval20020531123456_SIZEMISMATCH.xml
  • cmrmlsval20020531123456_COLLECTIONMISMATCH.xml
  • icmrmlsval20020531123456_DATEMISMATCH.xml

There are several types of Resource Manager/Library Server reports, as described in the following table.


Report type

Description

Orphan

Entries are added to the ORPHAN report if an object is on the Resource Manager, but the Library Server does not have a reference to the object. The report contains information about the object from the Resource Manager database.

Not in RM

Entries are added to the NOTINRM report if the Library Server has a reference to an object, but the object is not on the Resource Manager. The report contains information about the object from the Library Server database.

Size mismatch

Entries are added to the SIZEMISMATCH report if the size of an object on the Library Server does not match the size of an object on the Resource Manager. The report contains information about the object from the Resource Manager and Library Server databases.

Collection mismatch

Entries are added to the COLLECTION report if the collection of an object on the Library Server does not match the collection of an object on the Resource Manager. The report contains information about the object from the Resource Manager and Library Server databases.

Date mismatch

Entries are added to the DATEMISMATCH report if the object update date on the Library Server does not match the object update date on the Resource Manager. Under normal circumstances, if there is any synchronization problem between the Library Server and the Resource Manager, the object update date does not match. In order to reduce redundant entries in the different reports, entries are not added to the DATEMISMATCH report if they have been added to the collection mismatch or size mismatch reports. The report contains information about the object from the Resource Manager and Library Server databases.

Resource Manager volume validation utility
The Resource Manager volume validation utility checks each object in its database that was added or changed in a specified date range. It queries the device manager for the attributes of that object and generates reports for each object whose information in the database is different than reported by the device manager. You may want to use the utility if you have to restore data on a volume after a volume crash. The utility helps you to verify that the data is restored correctly. The Resource Manager must be running when you use the utility.

Tip: Use the Resource Manager volume validation utility during times of low traffic on the Resource Manager.

The validation utility does not search the storage system for orphaned objects (objects not referenced by the Resource Manager). Because there are a wide variety of storage systems that are often used for storing files other than those managed by Content Manager, the scanning for orphaned files can be extremely time consuming and may produce a large quantity of false positives.

The Resource Manager volume validation utility runs on the Resource Manager server and only requires access to its own database and the device managers responsible for the volumes that are being checked.

The Resource Manager volume validation utility is icmrmvolval.sh or icmrmvolval.bat. To start the utility, navigate to the bin directory in the Resource Manager home directory. The utility requires input parameters, which are described in the following table. Both dashes (-) and forward slashes (/) are handled as the parameter separator. The parameter tags are supported in both lower and upper case.


Parameter

Description

-B YYYY-MM-DD-HH.MM.SS

The beginning time and date of the objects to examine. Use this parameter with the -E parameter to restrict the number of objects that the utility must examine. This parameter is optional. If it is not present, all of the objects prior to the -E date are returned, or all of the objects are returned if -E is also not defined.

-E YYYY-MM-DD-HH.MM.SS

The ending time and date of the objects to synchronize. Use this parameter with the -B parameter to restrict the number of objects that the utility must examine. This parameter is optional. If it is not present, all of the objects after the -B date are returned, or all of the objects are returned if -B is also not defined.

-F output-path

The absolute path to be used for the output files. The utility creates the UTF-8 XML files in this directory. This parameter is required. If the files currently exist, they are overwritten.

-H

This parameter causes the program to display help information about how to invoke the utility. All of the other parameters are ignored and no processing occurs.

-V volume-name

The logical volume name on which you want to perform the validation. Use this parameter to limit the number of storage systems to one volume. This parameter is optional. If not used, all storage systems are searched.

The base file names of the discrepancy reports are “icmrmvolvalYYMMDDHHMMSS_” + Report Type string +".xml". The report type string identifies the type of discrepancies a report contains. The description of the different report types are detailed later in this section. The timestamp allows the administrator to run the utility multiple times without overwriting the output files. Examples of default names with the default report type are:
  • cmrmvolval20020531123456_FILENOTFOUND.xml
  • cmrmvolval20020531123456_SIZEMISMATCH.xml

There are two default discrepancy reports, as described in the following table.


Report type

Description

File not found

Entries are added to the FILENOTFOUND report if an object is in the Resource Manager database, but it is not found on the volume recorded in the database. A file is considered “not found” if the volumes device manager either reports that the file does not exist, or reports that the file has a file size of zero when the size in the database is non-zero. The report contains the object information from the Resource Manager database.

Size mismatch

Entries are added to the SIZEMISMATCH report if the size of an object in the Resource Manager database does not match the size reported by the device manager. The report contains the object information from the Resource Manager database and the size reported by the device manager.

Special Notices

This material has not been submitted to any formal IBM test and is published AS IS. It has not been the subject of rigorous review. IBM assumes no responsibility for its accuracy or completeness. The use of this information or the implementation of any of these techniques is a client responsibility and depends upon the client's ability to evaluate and integrate them into the client's operational environment.

Profile

Publish Date
22 December 2003


Rating: Not yet rated


Author(s)

IBM Form Number
TIPS0351