Configuring a Vocera SOAP Publisher Adapter

Access the Vocera Platform Web Console and navigate to the adapters.

See Navigating the Vocera Platform Adapters for instructions.

Select New Adapter in the Action menu, or select an adapter you wish to configure and then select Edit, to display the configuration fields. The configuration fields are the same for new and existing adapters.

Navigate to the New Adapter option, or navigate to an existing adapter to edit. See Creating a New Adapter and Editing an Adapter for instruction as needed.

The configuration fields are the same for new and existing adapters.

Complete the configuration fields as described in the table.

Configuration Field	Description
Component Name	Click the Component Name field to display a list of the systems and devices that the Vocera Platform currently supports. Select the name of the adapter to create.
Reference Name	Enter a short descriptive name in the Reference Name field to uniquely identify an adapter instance. It may demonstrate the adapter function or other information; for example, Production adapter may differentiate a live adapter from a development or "sandbox" adapter.
Enabled	Select the Enabled checkbox to allow the Vocera Platform to use the new adapter. The Vocera Platform ignores the adapter if this option is disabled.

Complete the Authorization configuration fields as described in the table.

Authorization Configuration Field	Description
Authorization Required	If authorization should be required, check the Authorization Required box and the Username and Password fields will display below to enter the login credentials for authorization. If no authorization should be required, do not check the Authorization Required box.
Username	Enter the username for this authorization configuration.
Password	Enter the password for this authorization configuration.

Authorization Configuration Field

Description

Authorization Required

If authorization should be required, check the Authorization Required box and the Username and Password fields will display below to enter the login credentials for authorization.

If no authorization should be required, do not check the Authorization Required box.

Username

Enter the username for this authorization configuration.

Password

Enter the password for this authorization configuration.

Complete the Operations configuration fields as described in the table.

In this section you can add, clone, and remove operations for this configuration as needed. Using the configuration settings in this section, the adapter constructs a WSDL document describing the published web services. An external system can use this WSDL to generate a request to the Vocera Platform and parse the response returned by the Vocera Platform.

You can define multiple enabled configurations for the Vocera SOAP Publisher Adapter . Each configuration can require authentication from the external system(s) making a SOAP request. Each configuration can specify a different authentication. Each configuration can have multiple operations. Each operation has a starting dataset or dataset view, depending on the type of operation. Each operation also has a request and response mapping section to configure attribute and element, depending on the chosen type.

Each attribute or element mapping defines how an attribute expression maps to a SOAP request or response element in the XML. Each operation can have multiple attribute and element definitions in the request and response mappings.

Operations Configuration Field	Description
Name	Enter a descriptive name for the new operation.
Type	Select the type of operation from the dropdown menu. Available options are Create, Update, Create or Update, Read, Count. This selection determines whether Starting Dataset or Starting Dataset View displays in the next field. Create, Update, Create or Update operations require a Starting Dataset, while the Read and Count operations require a Starting Dataset View be selected.

Operations Configuration Field

Description

Name

Enter a descriptive name for the new operation.

Type

Select the type of operation from the dropdown menu. Available options are Create, Update, Create or Update, Read, Count.

This selection determines whether Starting Dataset or Starting Dataset View displays in the next field.

Create, Update, Create or Update operations require a Starting Dataset, while the Read and Count operations require a Starting Dataset View be selected.

Complete the Request Mappings configuration fields as described in the table.

In this section you can add and remove mappings for this configuration as needed.

The Request Mappings combination box displays the Attribute Expressions field for the Update, Create, and Create or Update types. Select Read or Count type to display the Filter Expression field here.

All attribute expressions are evaluated in relation to the starting dataset, or dataset view, for the selected operation. For each WSDL element specified in the attribute/element mapping for the operation, the Publisher adapter extracts the value in the element and uses that value in the attribute expression given in the mapping.

Operations Configuration Field	Description
Starting Dataset	Select the starting dataset from the dropdown menu for Update, Create, and Create or Update operation types. All attribute expressions are evaluated in relation to this dataset for the selected data modification operation.
Attribute Expression	Enter the attribute expression in which the data in the corresponding SOAP element will be stored. All attribute expressions are evaluated in relation to the selected dataset for the operation.
SOAP Element	Enter the name of the element in the SOAP Request from which to extract the values for the Attribute (or Filter) Expression.

Complete the Response Mappings configuration fields as described in the table.

Selecting the Read type displays the Response Mappings combination box. In this section you can add and remove mappings for this configuration as needed.

All attribute expressions are evaluated in relation to the selected dataset view for the operation. For each attribute expression specified in the mapping for the operation, the Vocera SOAP Publisher Adapter evaluates the expression and inserts the resulting value in the SOAP response with the element name given in the mapping.

Operations Configuration Field	Description
Starting Dataset View	Select the starting dataset view from the dropdown menu for Read and Count operation types. All attribute expressions are evaluated in relation to this dataset view for the selected operation.
Filter Expression	Enter the attribute expression which will be used to limit the query results based on the value in the corresponding SOAP element. Selecting the Read or Count type displays the Filter Expression field in the Request Mappings combination box. All attribute expressions are evaluated in relation to the selected dataset for the operation.
Attribute Expression	Enter the Attribute Expression to select objects and specify which attributes to return in the SOAP Response. All attribute expressions are evaluated in relation to the selected dataset view for the operation. The SOAP Element specifies the name of the element in the SOAP Response in which to place the attribute value. The Read type request specifies the objects out of the starting dataset to read for the operation applying the request attribute/element mappings as a filter. The Count type request specifies a count of the number of objects in the starting dataset for the operation applying the request attribute/element mappings as a filter.
SOAP Element	Enter the name of the element in the SOAP Request from which to extract the values for the Attribute (or Filter) Expression.

Select one of the available options to exit the adapter configuration page. See Saving an Adapter for details.