Web Service Settings Tab

Context

On this tab, you specify the connection settings for the service to which you want to send notification messages. (See also: Universal Web Service Destination System.)

Procedure

  1. Choose the Add Destination System pushbutton. Then select the destination system type Universal Web Service Destination System and enter the name of the destination system.

    The Web Service Settings tab appears.

  2. Enter the following data:

    Field

    Description

    Description Type

    You specify here which type of service you want to configure. You can choose one of the following options:

    • No Service Description

      Choose this option if you want to configure a RESTful Web service.

    • WSDL

      Choose this option if you want to configure a Web service.

    • OData

      Choose this option if you want to configure an OData service.

    Description (URI)

    Here you enter the URI of the service that you want. This is only required for Web services and OData services. You do not need to enter anything here for RESTful Web services.

    You can use a file instead of the URI. If you choose Load Service Description from File, you can load the service locally from a file. In this case, the path for the selected file is displayed automatically.

    Endpoint URI

    Specifies the endpoint URI for a service operation. The URI is displayed automatically as soon as you have selected an operation of the WSDL service or OData service in the explorer (see step 4).

    This field can only be changed for RESTful services. For RESTful services, you can enter an endpoint URI as a constant value or as a template here. (See also: Configuring the Endpoint URI for RESTful Services.)

    Timeout

    Indicates the response time in milliseconds that must not be exceeded. If it is exceeded, the connection to the Web service is terminated.

    Detailed HTTP Logging

    		Detailed HTTP logging is used for troubleshooting. If you select this checkbox, all HTTP requests and responses with the status Raw are logged in a file in the Logs/UniWsDestination directory. The log directory is on the same level as the PCo system directory. The log directories are stored with the name <Agent Instance Name>.log. <Agent Instance Name> is the name of the agent instance. The log contains up to five files for the same agent instance with a maximum file size of 4 MB. As soon as all files are filled up, the oldest file is deleted.
  3. Choose Open in Service Explorer to display the service operations provided by the service.

    The system displays the various service operations in the Service Explorer screen area.

    The service explorer offers a tree view. The data model of the service is displayed in the form of a tree structure.

    For a WSDL Web service, the root element is a specific service. The ports are one level below this. The individual service operations are at the lowest level.

    In the case of the OData service, the following two types of tree view nodes are offered:

    • Entity

    • Operations of an entity

  4. Click on the entity or operation that you want. If you click on the entity node, the Read all operation is selected automatically for an OData service.

    The selected operation is displayed at the bottom in the Operation field. At the same time, the URI of the selected endpoint is displayed in the Endpoint URI field.

  5. If the connection to the server is temporarily unavailable, or you have persisted a file, you can also load the data model of the service from a file by choosing the Load Service Description from File pushbutton. You can search for the corresponding file. (See also: Load Service Description from File.)
  6. By choosing Save Service Description to File, you can save the data model of the selected service locally so that you can also call up the service locally (as described under step 5).
  7. Choose ENTER.

    The Operation Configuration tab appears.

Next Steps

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