Configure a SOAP web service delivery endpoint

To configure a web service delivery endpoint and add a SOAP web service subscriber to your notification rule, follow this procedure.

1. Add a web service delivery endpoint using the PI System Explorer Contacts plug-in.

   1. Go to the Contacts plug-in of the PI System Explorer.

   2. Right-click the Delivery Endpoints folder.

   3. Select New Delivery Endpoint.

   4. Optional. Retry interval. Select the time interval at which PI Notifications Service will contact the web service. The web service will be contacted as frequently as the system allows if zero is entered.

   5. Optional. Maximum Retries. Select the number of times PI Notifications Service will try to connect to the web service. Entering zero means there will be no retries.

   6. Select WebService as the Delivery channel.

   7. Select SOAP.

   8. Enter the web service address, the URL of your web service.

   You can validate the connection using the Get Web Services button.

   1. Enter the name of the web service to be used for notification in the Web Service field.

   2. Default Web Method: select the default web method to be used for the notification.

   This menu displays all of the parameters defined in the web service.

   1. Select Authentication Option.

      • Windows: the default option. PI Notifications Service will pass the network credentials of its service account to the web service

      • Anonymous: no credentials will be provided to the web service

      • Basic: enter a username and password the service will provide to the web service

   2. Check in the changes.

   See Create a delivery endpoint such as a stand-alone email or a web service row in Manage contacts and List of options for the notifications web service delivery channel for more information. See also Configure authentication for a web service connection for authentication of web service.

2. Add the configured web service delivery endpoint to your notification rule as a subscriber.

   1. Go to the Notification Rules tab of the element you want to add the web service as the delivery endpoint.

   2. Click View/Edit subscriptions in the Subscriptions pane of the notification rule.

   3. From the Contacts pane on the right, expand Delivery Endpoints and drag and drop the configured web service to the Subscriptions pane on the left.

   4. Configure the SOAP web service.

      SOAP can call the web service methods. Click the "wrench" icon to configure the SOAP API method. The "Information" icon gives you information about the parameters (path and value) that must be configured for this method, and their complexity. Enter the path and value on each row (the path depends on how the web service server is configured); clicking on a row brings up a drop-down list of expected values for that path. The interface also automatically validates the parameters that you enter on each row. You can validate the method using the Test Send button.

      You have the option to cancel or retry a connection that is taking a long time to complete; this may happen if you have a high latency (commonly called "laggy") connection where the WSDL information is not quickly retrieved.

      Note: Complex data may be required by the method. To enter the correct information, refer to the Web Service Definition Language (WSDL) documentation for the API method.