The Universal Messaging SOAP Plugin utilises the advanced HTTP/HTTPS stack capabilities of the Universal Messaging server to provide an implementation of a SOAP 1.2 based client API. Any SOAP toolkit can use the provided WSDL to generate client stubs for any SOAP compliant language. This way Universal Messaging functionality is offered to programming languages that were previously unsupported and all this without the need for any additional infrastructure component (SOAP server, web server etc).

The plugin can be configured to expose complete Universal Messaging namespaces or subsets, support username/password authentication, control web service listing and other options further explained in the section below.

Once you have created the SOAP plugin on the interface you require it on, you can then select it from the plugins panel for the selected interface and enter values as you wish for the configuration parameters.

The SOAP plugin requires configuration details regarding the entry point in the namespace for the channels you wish to make available to vend to the clients, as well as web-services specific configuration. Below is a table that shows each configuration parameter and describes what it is used for.

Once you have completed setting up your SOAP plugin, you can verify it works by opening a browser to the NHP interface in the mount URL path. For example for an NHP interface running on port 80 on localhost and having the plugin mounted on /soap, open a browser to http://localhost/soap/ and you should see something like:

The image below shows the enterprise manager interface panel with an nhp interface running on port 80. This interface has a SOAP Plugin configured with its URL path as /soap. The default ChannelRoot setting is /, which is the root of the namespace, i.e. all channels. Once the plugin is created, you can hit the apply button which will restart the interface and enable the new SOAP plugin.

From a browser, it is now possible to enter the url 'http://localhost:8080/soap/' which shows the available services exposed via SOAP as well as links to the WSDL documents required to generate client stubs. The image below demonstrates the browser view from a Realm that has a SOAP plugin on an nhp interface on port 80.

The Universal Messaging installation includes a few samples for perl src/soap directory. The applications use the SOAP::Lite Perl module and were tested under cygwin for windows. Please note that all the samples included assume that you have an NHP interface running on port 80 on the local machine and having a SOAP plugin configured under /soap. Furthermore the getEvent.pl sample requires you to have a channel called test with at least 1 event inside.

For example to execute getChannelDetails.pl, open a cygwin (or other) shell and type: