Understanding the Vocera SOAP Subscriber Adapter Rules

This page describes the fields available to configure dataset rules for the Vocera SOAP Subscriber Adapter.

See the Vocera Platform Dataset Guide for information about working with rules. See Configuring a Vocera SOAP Subscriber Adapter for information about adapter settings.

The Vocera SOAP Subscriber Adapter retrieves information from an external system's WSDL and stores it in the Vocera Platform. Using this stored information, an administrator can configure rules in the Vocera Platform datasets that will send requests to and receive responses from the external SOAP Web Service, mapping the request and response elements to dataset entities.

Rules can associate a Web Service Operation and the relevant Elements with Dataset Attributes from the Vocera Platform. The Request Parameters and Response Parameters content will vary based upon the Web Service that is consumed.

In the Adapter Settings, configure the Rule Settings fields.

Setting Description
Operation The operation that will be used when communicating with the Web Service
Description The description of the Web Service Operation selected.
URL The URL of the Web Service.

Once an Operation is selected, Request and Response Parameters are listed in the form. The number of times that each parameter occurs within each Message, along with its corresponding data type, is displayed.

For the Request Parameters fields:

Request Parameter Description
Dataset/Value "#{}" should be used when specifying the Dataset Value for this element, unless a constant is specified. The attributes for this element are Name: request >>d, Data Type: string, Minimum Occurrences: 1, Maximum Occurrences; 1.

For the Response Parameters fields.:

Response Parameter Description
Dataset Action The action that will be performed on the specified dataset using the information returned from the Web Service. Select one option: Do not create or update any records; Create only new records; Update only existing records; or Create new records or Update existing records.
Dataset The starting dataset for the parameters returned from the Web Service. Required for the Create New or Update Existing Records selections in the Dataset Action field
id "#{}" must NOT be used when specifying the Dataset Value for this element. The attributes for this element are Name: response >>id, Data Type: integer, Minimum Occurrences: 0, Maximum Occurrences; 1.
error "#{}" must NOT be used when specifying the Dataset Value for this element. The attributes for this element are Name: response >>error, Data Type: string, Minimum Occurrences: 0, Maximum Occurrences; 1.