Supported Web Services¶
The SOAP Connector supports SOAP Web services over “http” or “https” with optional pre-emptive basic authentication (user name and password).
Web service input and output values may be of any primitive type (for example, boolean, number types, strings, date and time types), one-dimensional arrays of these primitive types, and complex types containing these types.
Complex types are “flattened” for use in UA Office Link’s task infrastructure. For example, a complex type “Box” containing two numeric values “Num1” and “Num2” may be exposed as “Box.Num1” and “Box.Num2”. If only a single complex value is returned by a web service then names of values within the complex type may be shortened by ommitting the containing complex type name. For example, if “Box” was the only complex type in the web service response then value names are shortened to “Num1” and “Num2”.
If you have a use case that is not covered by supported features then we’d like to hear from you! Please contact firstname.lastname@example.org.
Add Web Services¶
Select “Web Services” under “SOAP”, then click the “Add” button in the toolbar to add a web service.
Provide details of the web service in the dialog that opens.
( 1 ) Enter the WSDL document location of the Web Service. The WSDL document (Web Service Description Language document) defines the structure of the Web Service. The WSDL entry may either be a URL to retrieve the document from a server on the network or you can open a document file by clicking on the button next to the entry field. Documents provided by a server must be publicly available and must not require authentication.
( 2 ) Define how to connect to the Web Service. With “Follow Redirections” ticked, the service may redirect service calls to a different computer. If the service requires authentication then tick the “Use Basic Authentication” option and enter credentials. Credentials may be stored in encrypted form for future use. If not stored, then UA Office Link will prompt for username and password as required.
( 3 ) Click on the “Connect” button to retrieve the WSDL document from a server. If the document is loaded from a file then this step is not required.
( 4 ) If the WSDL document is parsed successfully then available Web Service methods are shown. If unsuccessful then an error message will be displayed instead.
( 5 ) Click the “Add Web Service” button to add the web service.
The added Web Service will now be listed under “Web Services”.
Web Service Settings¶
You can change the name of the Web Service if required (for example, to distinguish services with the same name connecting to different servers). The “Binding Name” remains constant and identifies the service to be called.
Reassign Web Service¶
Use “Reassign” to change other settings of the web service. For example, if a service has moved to a different server then you can enter a new service URL, or, if you wanted to change credentials, then you can enter a different username and password. UA Office Link tasks that reference the current service will remain functional when “Reassign” is used.
Use “Reassign” only if the service is otherwise compatible, that is, it must support the same methods with the same arguments as the originally configured service. If the service has different methods then add the service as a new web service and reconfigure UA Office Link tasks.
To “Reassign”, right-click on the web service (in the example, “MathService”) and select “Reassign” from the popup menu. You can also click on “Web Services” under the SOAP connector node, select a web service in the content panel, and then click on the “Reassign” toolbar button.
Re-enter details of the web service in the dialog, including any credentials and authentication settings, then click on the “Reassign” button to commit new settings.
Remove Web Services¶
Remove web services by selecting “Web Services” in the navigation panel, then select one or more web services to remove in the content panel, and finally click on the “Remove” toolbar button to remove selected web services.
Note that service references are also removed from any task using the web service.