Building Message Schemas

This chapter provides an overview of the message Schema Builder and describes how to:

• Select and view data in the message Schema Builder.

• Build message schemas for rowset-based messages.

• Import message schemas for nonrowset-based messages.

• Modify message schemas.

• Delete message schemas.

Understanding the Message Schema Builder

The message Schema Builder enables you to build, import, modify and delete XML message schemas.

Note. The terms message schema, XML message schema, and schema are used interchangeably in this chapter.

To test message schemas during development, use the Schema Tester utility.

Use the Service Operations - General page to enable runtime validation for a service operation, or use the Service Schema Validation page to enable validation for several service operations at a time.

See Also

Using the Schema Tester Utility

Enabling Runtime Message Schema Validation

Message Schemas

An XML message schema describes a model for the arrangement of tags and text in a valid XML document. A schema provides a common vocabulary for a particular application that exchanges documents.

Building, Importing, Modifying and Deleting Message Schemas

You can use the Message Schema Builder to manage message schemas for rowset-based messages in the application database.

Note. You can also use the pages of the Message Builder component to manage rowset-based and nonrowset-based schemas. However, the Message Builder enables you to work with only one message schema at a time, whereas , the Message Schema Builder enables you to perform actions, such as building and deleting message schemas, on multiple messages at a time.

Note. You cannot use the Message Schema Builder to build schemas for message parts or container messages. You must use the Message Builder component to build schemas for these message types.

Rowset-Based Message Schemas

Use the Message Schema Builder to generate, regenerate, view or delete rowset-based message schemas.

You cannot regenerate or delete a rowset-based message schema that is a message part. Part and container schemas are automatically generated at save time so there's no need to explicitly regenerate or delete them.

Nonrowset-Based Message Schemas

Use the Message Schema Builder to import new nonrowset-based schemas into the database, modify existing nonrowset-based message schemas, or delete them.

Schemas for nonrowset-based message parts can be deleted or modified, but message parts should never be without a schema. After deleting a nonrowset-based message part, you should always import or enter a new schema for the message.

Selecting and Viewing Data in the Message Schema Builder

This section discusses how to:

• Select data in the Message Schema Builder.

• View message schema data details.

• View XML message schema code.

Selecting Data in the Message Schema Builder

When you access the Message Schema Builder component (IB_SCHEMABUILD) the Schema Builder page (IB_SCHEMABUILD) displays a search engine to use to search for messages and message schema data with which to work and view.

To access the Schema Builder page, select PeopleTools, Integration Broker, Service Utilities, Message Schema Builder.

The Schema Builder page provides the following options for searching for data with which to work and view in the application database.

Viewing Message Schema Details

When you search for data in the Schema Builder, message detail results appear in the Message Schemas grid.

Message	Message name returned from the search of the application database.
Message Version	Version of the message returned from the search of the application database.
Rowset-based	Indicates the structure of the message. The valid values are: Yes. Indicates that the message is a rowset-based message. No. Indicates that the message is a nonrowset-based message.
Exists	Indicates whether a schema has been built for the message. The valid values are: Yes. A schema has been built for the message. No. A schema has not been built for the message.
Updated On	Timestamp of the last update of the record. A new timestamp displays when a schema is generated or deleted for a message.
Build Results	Displays the results of actions performed on a schema.
Build Selected Schemas	Click the button to build schemas for the selected messages.
Delete Selected Schemas	Click the button to delete schemas that exist for the selected messages.

Viewing XML Message Schema

If a message schema exists for a message, click the message name in the Message Schema grid to view the schema details in the Schema Viewer page (IB_SCHEMABUILD_SEC).

Note. For easier viewing, highlight the data with your cursor.

Message schemas for rowset-based messages are read-only. You can edit message schemas for nonrowset-based messages.

Building Message Schemas for Rowset-Based Messages

This section discusses how to build message schemas for rowset-based messages.

Building a Message Schema for a Rowset-Based Message

To build a message schema for a rowset-based message:

1. Access the Schema Builder page (PeopleTools, Integration Broker, Service Utilities, Message Schema Builder).

2. Search the application database for the message or messages for which to build schemas.

   See Selecting Data in the Message Schema Builder.

3. Check the box next to the message or messages for which to build schemas.

4. Click the Build Selected Schemas button.

When the schema is built successfully, a timestamp appears in the Updated On field and the Build Results field displays Successful Schema Insert.

Importing Message Schemas for Nonrowset-Based Messages

This section discusses how to import message schemas for nonrowset-based messages.

Importing a Message Schema for a Nonrowset-Based Message

To import schemas for nonrowset-based messages:

1. Access the Schema Builder page (PeopleTools, Integration Broker, Service Utilities, Message Schema Builder).

2. Use the Message Schema Builder search engine to locate the message for which you want to import a schema.

   See Selecting Data in the Message Schema Builder.

3. In the Message Schema grid, click the message name link for the message for which you want to import a schema.

4. Import the schema.

   • Import a schema from a file.

     You can import a schema from a file by using the Upload Schema from File button and selecting the file to import. After you import the file, the contents displays in the Schema text box.

     Note. If you receive the error, “Error retrieving the file from database,” verify that one of the variables PS_FILEDIR or PS_SERVDIR is defined in the system variables on your machine.

   • Direct data entry.

     You can also enter the schema directly in the Schema text box.

5. Click the Save button.

   The Schema Builder page appears.

A timestamp appears in the Updated On field and the Build Results field displays Successful Schema Insert.

Modifying Message Schemas

This section discusses how to modify message schemas.

Note. You can modify the content of message schemas built for nonrowset-based messages only.

To modify a schema, you can edit it directly in the Message Schema Builder, or you can export to make changes.

Modifying a Message Schema

To modify a message schema:

1. Select PeopleTools, Integration Broker, Service Utilities, Message Schema Builder.

   The Schema Builder search page appears.

2. Locate the message with which you want to work.

   See Selecting Data in the Message Schema Builder.

3. In the Message Schema grid, click the message name link.

   A new page displays with the message schema populated in a text box.

4. Modify the schema as needed.

   • Modify the schema directly in the text box, or

   • Modify the schema in the editor of your choice.

     Use your cursor to highlight the contents of the text box and use the keyboard command CTRL + C to copy the contents of the text box. Paste the contents into your editor using the keyboard command CTRL + V. Modify the content as needed. Import the content back into the Message Schema Builder using the instructions described previously in this chapter for importing message schemas for nonrowset-based messages.

     See Importing Message Schemas for Nonrowset-Based Messages.

5. Click the Save button.

The Schema Builder page displays and the Updated On field displays the date and time of the modification, and the Build Results field displays the results of the new schema build.

Deleting Message Schemas

This section discusses how to delete message schemas.

Understanding Deleting Message Schemas

You can delete message schemas using the Message Schema Builder page in the Message Schema Builder component (IB_SCHEMABUILD) or using the Message Schemas page in the Service Administration component (IB_HOME_PAGE).

Note. The Message Schema Builder page provides more comprehensive capabilities for searching for message schema.

You cannot delete a message schema when the message on which the schema is based is:

• Referenced in a service operation.

• Referenced as a message part in a container message.

• A rowset-based message part.

• A container message.

• Referenced in a provided WSDL document.

Using the Message Schema Builder Page to Delete Message Schemas

When deleting a schema using the Message Schema Builder page use only the Delete Selected Schemas button. Do not attempt to delete message schemas by deleting content in the Schema text box in the schema details view; if you save the changes, PeopleSoft Integration Broker will attempt to validate the blank schema at runtime and the validation will fail.

You cannot delete message schemas when the service system status is set to Production.

The service system status that is set on the Service Configuration page.

See Understanding Configuring PeopleSoft Integration Broker for Handling Services.

To delete a message schema:

1. Access the Message Schema Builder page (PeopleTools, Integration Broker, Service Utilities, Message Schema Builder).

   The Schema Builder search page appears.

2. Locate the message with which you want to work.

   See Selecting Data in the Message Schema Builder.

   The Schema Builder page appears.

3. In the Message Schema section, check the boxes next to the message names that contain schemas you want to delete.

4. Click the Delete Selected Schemas button.