Defining Service Operation Version Information

When you first create a service operation definition, the definition that you initially define is the default version.

When the newly created service operation definition opens, the Default check box is enabled and is read-only.

You can subsequently define additional service operation versions and assign them as the default.

See Managing Service Operation Versions.

Defining General Version Information

To define the service operation default version:

  1. Access the Service Operations - General page (PeopleTools, and then Integration Broker, and then Integration Setup, and then Service Operation Definitions).

  2. In the Version field, enter a version identifier.

    The default is v1.

  3. (Optional.) In the Version Description field, enter a description for the operation version.

    If you enter no information, the description by default is the name of the service operation when you save the definition.

  4. (Optional.) In the Version Comments box, enter comments about the version.

  5. (Optional.) Select the Non-Repudiation check box to apply nonrepudiation to the message.

  6. (Optional.) Select the Runtime Schema Validation check box to enable service schema validation at runtime. You can set validation for the request message, response message, or both.

Continue to the next section to specify messages for service operations. You cannot save the service operation definition until you define messages for it.

Specifying Messages for Service Operations

You specify messages for service operations in the Message Information section of the Service Operations – General page.

The messages that you specify define the structure of the data that is contained in the service operation.

The service operation type determines the number of messages and message types (request or response) that you specify.

To specify messages for a service operation:

  1. Locate the Message Information section on the Service Operations – General page.

  2. Locate the Type field, and take note of the message type to define.

  3. In the Message.Version field, enter the message name followed by a dot and version, or click the Lookup button to search for one.

    After you select the message, you can click the View Message link to view the message.

  4. Specify the queue for the message.

    Note:

    If you are defining a message for a synchronous operation type, you do not need to define a queue.

    Your options are:

    • In the Queue Name field, enter the queue name.

    • Click the Lookup button to search for a queue.

    • Click the Add Queue link to open the Queue Definitions page and define a new queue for the message.

      See Adding Queue Definitions.

    • Click the Multi-Queues link to open the Queue List page and assign multiple queues to process the message.

      The Multi-Queue link appears only when you have enabled the multi-queue feature and when you are working with asynchronous service operations.

      See Assigning Multiple Queues to Process Service Operations.

  5. Repeat steps 1 through 4 for each message type that appears in the Message Information section.

  6. Click the Save button.

Specifying Fault Messages for Service Operations

You can specify fault messages for service operations for error handling.

Note the following about fault messages:

  • You cannot add fault messages to asynchronous service operations.

  • Fault messages must be nonrowset-based messages, container messages, or document messages. Fault messages cannot be rowset-based messages.

To specify a fault message:

  1. Locate the Default Service Operation Version section on the Service Operations – General tab.

  2. Click the Add Fault Type button.

    A new row appears in which to specify a message. Note that the Type field in the new row displays Fault.

  3. In the Message.Versionfield, enter the message name, or click the Lookup button to search for one.

    After you select the message, you can click the View Message link to view the message.

  4. Click the Save button.

To delete a fault message, in the Default Service Operation Version section, click the Delete Fault Type button. Then click the Save button.

Generating Local-to-Local and Any-to-Local Routing Definitions

Use the Service Operations-General page to initiate generating local-to-local and any-to-local routing definitions.

See Initiating System-Generated Routing Definitions.