Request Message Configuration Tab (OData and Web Service)

Prerequisites

On the Web Service Settings tab, you have selected the service and the operation.

Context

This document describes the procedure for creating the request message configuration for the operation of an OData service or Web service.

The Request Message Configuration tab contains the table with the parameters for the request message and the list of input variables.

The parameters of the request message can be fixed values or variables. Each parameter has a name, a type, a value, and the indicator showing whether it is a variable.

Procedure

PCo has determined the available request parameters for the selected operation and displays them in the Request Message Configuration table.

Field	Description
Required Parameter	If the checkbox is selected, this is a required parameter. An entry is required in the Value field in this row. The checkbox for required parameters is selected automatically and cannot be changed. If the checkbox is not selected, the entry is optional.
Parameter Name	Specifies the name of the parameter that is provided by the service (cannot be changed)
Parameter Type	Specifies the type of the parameter that is provided by the service (cannot be changed)
Value	This field contains the value 0 at first. You can either enter a fixed value or specify a variable for the operation field here. Note Ideally you choose and then the system proposes a variable name. Note The variable names must not begin with a digit, must not contain any spaces, and must not be any C# key words. If the value entered is not a correct variable or is not the correct literal for the given type, a small red icon appears at the beginning of the row. If you move the mouse over it, PCo displays a tooltip with the error description.
Input Variable	Checkbox with which you specify that the selected parameter is a variable. The checkbox is not selected. If you do not select the checkbox, the value entered is interpreted as a fixed value.

Select a row and choose .

The system checks if the parameter is a variable. If it is, the system proposes a variable name (with the prefix in) and selects the Input Variable checkbox. In addition, the icon is displayed in front of the parameter.
All parameters that you have marked as variables are displayed in the list of input variables. The entry in the Value field is used as the variable name.

Note

Later you can map this variable to a subscription item in the notification object. You perform this mapping on the Destinations tab for the notification and thereby fill the service with the values from the data source.
You can use the Import Data Types into Data Type Repository button to import structured data types, array data types and enumeration data types from SOAP Web services and OData services. This simplifies data entry considerably, since only one variable then needs to be selected from the data type repository. (See also: Import Data Types into the Data Type Repository.)
By choosing , you can convert a variable back into a fixed value.

Example

Example: Create a Universal Web Service Destination System (OData)