Managing Nonrowset-Based Message Definitions

After you create a nonrowset-based message definition, you do not need to complete any additional configuration steps for the definition, however you need to supply the schema.

You may add or replace message schemas that are referenced by nonrowset-based messages in runtime tables. However, once you change a message schema for a nonrowset-based message, you must adjust the message for a successful integration.

Note: You cannot regenerate message schemas for messages that are defined as part of a restricted service.

To add the schema for the nonrowset-based message:

  1. Select PeopleTools > Integration Broker > Integration Setup > Message Definitions.

  2. Select the nonrowset-based definition to which you want to add the schema.

  3. Click the Schema tab.

  4. Click the Add Schema button.

    This example illustrates the Schema page for a nonrowset message definition.

     Nonrowset message Schema page

  5. Select the format type, either XML or JSON.

  6. You can add the schema to the message in two ways:

    • Click the Upload Schema From File button to browse for and upload a schema that you have already saved to a file.

    • Enter the XML or JSON schema in the Schema text box that is provided.

  7. Click the Save button.

If you define the message as a message part, you must supply a schema to save the message. All message parts require a schema at save time.

After the message schema is added to a nonrowset-based message, you can edit the schema using the Schema page.

Note: You cannot regenerate message schemas for messages that are defined as part of a restricted service.

To edit nonrowset-based message schemas:

  1. Select PeopleTools > Integration Broker > Integration Setup > Message Definitions.

  2. Select the nonrowset-based definition that contains the schema that you want to edit.

  3. Click the Schema tab.

    This example illustrates the Schema page for a JSON message.

     Schema page for Nonrowset-based message

  4. Click the Edit Schema button.

    This example illustrates the Schema page open for editing.

     Edit Schema page

  5. In the Schema text box, make your changes and additions to the schema.

  6. Click the Save button.

You can delete individual nonrowset messages or delete schemas in bulk.

Deleting Individual Nonrowset-Based Message Schemas

Use the Messages-Schema page (IB_MESSAGE_BUILD2) to delete individual nonrowset-based XML message schema.

To delete an individual nonrowset-based message schema:

  1. Select PeopleTools > Integration Broker > Integration Setup > Message Definitions.

  2. Click the Schema tab.

  3. Click the Delete Schema button.

Deleting Nonrowset-Based XML Message Schemas in Bulk

To delete one or more nonrowset-based XML message schemas, use the Message Schemas page (IB_HOME_PAGE6) in the Service Administration component (IB_HOME_PAGE).

This example illustrates the Service Administration – Message Schemas page.

 Service Administration - Message Schema page

To delete nonrowset-based XML message schemas in bulk:

  1. Select PeopleTools > Integration Broker > Service Utilities > Integration Broker Admin.

  2. Click the Message Schemas tab.

  3. Choose the schema or schemas to delete.

    To delete an individual schema, in the Message Name field enter the name of the message that contains the schema to delete.

    To delete more than one schema, click the Search button to display all nonrowset-based message in the system than contain schema.

    The message or messages appear in the Messages with Schema grid.

  4. In the Select column, select the check box next to each message name that contain schema you want to delete.

    If deleting multiple schemas, use the forward and backward arrows and/or the Last and First links to page through the results and select schemas to delete.

  5. Click the Delete button.