Request Message Configuration Tab

Prerequisites

You have selected a service operation.

Context

You create the request message on this tab. Then, in the request message, you assign variables or fixed values to the fields that are provided by the service operation. You can assign fixed values directly to the fields. The current values of the variables are assigned to the relevant fields before the Web service is called.

The Request Message Configuration table is displayed in the right screen area. It contains the fields of the selected operation. The list of variables is displayed in the right screen area. The variables are displayed here as soon as you have marked a field as a variable.

Procedure

  1. Choose the Create Request Message pushbutton.

    The system displays the Request Message Configuration table for the selected service operation.

    Column

    Description

    Required Parameter

    The asterisk * indicates that an entry is required in this row in the Value field.

    If there is no asterisk, the entry is optional.

    Parameter Name

    Specifies the name of the service operation parameter, such as:

    • Message Header

    • SiteRef

    • Site

    Parameter Type

    Specifies the type provided by the Web Service, for example:

    • StartRequestMessage_sync

    • String

    • SiteRef

    Value

    In this column, you can either enter a fixed value or specify a variable for the service operation field. You can assign these variables later to the subscription items of the agent instance and fill the Web service with the values of the data source.

    The following functions are provided as pushbuttons:

    • Create Object

      If you choose this pushbutton, the selected object is created in the request message. In the table, PCo shows further objects for this higher-level object.

    • Delete Object

      If you choose this pushbutton, you can delete an object in the request message. The object is then removed from the table.

    • Create Array

      If you choose this pushbutton, you can create an array for an object. (See: Creating Arrays.)

    Input Variable

    If you have selected the Input Variable checkbox for a row, the contents of your entry in the Value field are interpreted as a variable. The variable is then shown in the list of input variables.

    You can assign this variable to a subscription item in the notification object that you define for integration with a third-party system. You perform this mapping on the Destinations tab for the notification.

    (See also: Integration with Third-Party Systems Using Web Services (WSD).)

    If you do not select the checkbox, the value entered is interpreted as a fixed value.
  2. Enter the required data as described in the example.
  3. Now you can test the Web service call by choosing the Test Request Message pushbutton. Even if you want to define a response message, you need to choose the Test Request Message pushbutton.

    The Set Variables dialog box appears.

  4. Enter the values for the variables and click OK.

    If the Web service call was successful, a response is generated. PCo now displays the Response Message Configuration tab with the response message fields. All the response message fields are displayed with current values.

    You can now assign variables to the response message fields that you can use in a notification enhancement. For more information, see Response Message Configuration Tab.