The following example provides a sampling of steps to utilize a web service.
A Form Service web service was previously registered with eCASE, and has a web method called multiply, that multiplies the inputs firstInput and secondInput, and returns the result as multiplyResult.
Web methods for a web service can be viewed through the App Designer by navigating to App Designer > Web Services. The multiply web method is shown below:
To use this web service in a form:
1. A form is created with some decorative text, two number inputs, a button, and a label to display the output. The number inputs are named leftHandSide and rightHandSide. The label is given a data type of number, default value of 0, and is named multiplicationOutput.
2. Now, an action rule is created for the button, so that the button will call the web service. The rule is given a statement, and the statement type is changed to “Call Web Service”. The Statement Editor dialog appears similar to this:
3. Here, in the Service menu, all the Web Services registered with eCASE are listed. When the selection in the Service menu changes, the options in the Operation menu change to display the methods in the selected service that was selected.
4. The service Form Service is selected in the Service menu. In the Operation menu, the method multiply is selected.
5. Below these menus is the Input section (1 and 2), and the Output section (3). This is how the Web Method from eCASE (See the App Designer section for more) appears in UI Designer:
6. The Expression Editor button on the right hand side of the inputs will open the Expression Editor. The Expression Editor allows you to define an expression as the input for the Web Service. Here the expressions are kept simple, and are just the input fields’ names.
7. In the Outputs section below the Inputs section, the result(s) that the web service returns are displayed in the Element column on the left. If there is more than one output, the left dropdown can be used to select different outputs.
8. In the right side of the Outputs section is the Field column. Available fields in your form are listed in the drop down. The field multiplicationOutput is selected here. Now the multiplicationOutput label will display the result when the web method is called.
9. Now, when the button is clicked in the case folder, the web method is called with the input fields as input, and will set the web method’s output to the output field.
NOTE: Before using web services in the UI Designer, make sure to register the web services and web methods in the App Designer.