Validating Document References to Object Metadata

This chapter provides an overview of validating document references to object metadata and discusses how to:

• Access the Document/Metadata Validation utility.

• Validate document metadata references.

• Validate document message type references.

• Validate relational document record and field maps.

Understanding Validating Document References to Metadata

PeopleSoft provides a Document/Metadata Validation utility that enables you to identify documents that are not properly coupled to other metadata objects and data. Typically, this situation occurs:

• After the Project Copy process, when related metadata objects are not included in a project.

• During development, when other developers modify metadata, such as records and fields.

After you identify the invalid references, you can either manually correct or create the necessary metadata in the database, or you can use the utility option to clear the invalid reference.

The Document/Metadata Validation utility features Documents, Messages, and Relational tabs that enable you to validate metadata references as described in the following table:

Accessing the Document/Metadata Validation Utility

The Document/Metadata Validation utility (IB_DOCUMENT_VALIDT) is located in the IB_DOCUMENT_VALIDT component.

To access the page, select PeopleTools, Documents, Document Utilities, Document/Metadata Validation. The following example shows the page:

Validating Document Metadata References

Use the Documents page (IB_DOCUMENT_VALIDT) of the Document/Metadata Validation utility to identify any documents that reference metadata not in the database.

To validate document metadata references:

1. Access the Document/Metadata Validation - Documents page (PeopleTools, Documents, Document Utilities, Document/Metadata Validation).

2. Click the Search button.

   Any documents in the database that reference metadata not in the database appear in the Documents grid.

3. Manage the results by performing any of the following actions:

   • Clear the metadata reference.

     Select the Select check box next to each document for which to clear the invalid or missing reference, and then click the Update button.

   • Examine the document definition and import or create the missing metadata.

Validate Document Message Type References

Documents can be defined as a message type in PeopleSoft Integration Broker. Use the Document/Metadata Validation - Messages page (IB_DOCUMENT_VDMSG) to resolve issues with the documents or messages used in this message type.

The following example shows the page:

Identifying and Resolving Message Definitions that have Missing References to Documents

A message definition can have a missing reference to a document when the following situation occurs:

• You define a document as a message type in System A. You then copy only the message to System B because System B already has a copy of the document in the database.

• You define a document as a message type in System A. You then copy the message and document to System B in stages, first copying the message definition and then copying the document.

In either case, the message-document link gets broken, and the link needs to be reestablished. Use the upper grid on the Document/Metadata Validation - Messages page to identify and resolve this inconsistency.

To identify and resolve message definitions that have missing references to documents:

1. Access the Document/Metadata Validation - Document page (PeopleTools, Documents, Document Utilities, Document/Metadata Validation).

2. Click the Messages tab.

   The Document/Metadata Validation - Messages page appears.

3. Above the Documents grid, click the Search button to display all documents in the system that have missing references to message definitions.

   The results appear in the Documents grid.

4. Select the Select check box next to each document you want to update.

5. Click the Update button.

Identifying Messages that Reference Documents Not in the Current Database

Use the bottom grid on the Document/Metadata Validation - Messages page to identify messages in the system that reference documents that are not currently defined in the database.

This situation can occur when you define a document as a message type in PeopleSoft Integration Broker in a database, and then copy the message to a new database and do not include the document in the project copy process.

To identify messages with invalid references to documents:

1. Access the Document/Metadata Validation- Documents page (PeopleTools, Documents, Document Utilities, Document/Metadata Validation).

2. Click the Messages tab.

   The Document/Metadata Validation - Messages page appears.

3. Just above the Messages grid at the bottom of the page, click the Search button.

   Any messages in the database that reference documents not in the database appear in the Messages grid.

To resolve the invalid references, go to the source database and copy the documents to the current database or create new documents in the current database.

Validating Relational Document Record and Field Maps

For documents that have relational maps defined to PeopleSoft records and fields, other database users may be able to modify the records or fields. When changes are made to records and fields, PeopleSoft Application Designer does not perform any validation against document metadata.

Use the Document/Metadata Validation - Relational page (IB_DOCUMENT_VDREC) to run an application engine program to validate all documents in the database that have relational maps defined.

To access the Document/Metadata Validation - Relational page, select PeopleTools, Documents, Document Utilities, Document/Metadata Validation and click the Relational tab. The following example shows the page:

If the application engine program was run previously on the database, the date and time it was run appear in Last Run On field.

To validate relational document record and field maps:

1. Access the Document/Metadata Validation - Relational page (PeopleTools, Documents, Document Utilities, Document/Metadata Validation).

2. Click the Run Now button.

Documents that have invalid relational maps appear in the Documents grid. Open each document and correct the relational map.