Web Service Commands
App Portal 2020 R1
A web service action allows the connection to a web service. Each method can become its own action and its parameters supplied by App Portal Request variables. Web service actions execute just like the command actions.
The Commands and Actions > Web Service Commands view lists defined Web Service actions.
Commands and Actions > Web Service Commands View
To create a new web service action, click the New Web Service Command button. The New/Edit Web Service Action dialog box opens. The fields displayed on this dialog box varies depending on the selections you make.
| • | Create a new web service / not connected—If, under Web Service Action, you select Create a new web service, the following fields are displayed before you have specified a valid URL and connected to the service: |
New Web Service Action Dialog Box / Create a New Web Service / Not Connected
| • | Create a new web service / connected—Under Web Service Action, you select Create a new web service, the following fields are displayed after you have connected to the new web service: |
New Web Service Action Dialog Box / Create a New Web Service / Connected
| • | Use existing web service—Under Web Service Action, if you select Use existing web service and select a web service from the list, the following fields are displayed: |
New Web Service Action Dialog Box / Create a New Web Service / Connected
The New Web Service Action dialog box includes the following properties:
|
Category |
Description |
||||||
|
Enter a descriptive name |
Provide a unique name for this web service and method. |
||||||
|
Provide the URL to the web service |
Enter the path to the web service. Do not include ?WSDL as that is automatically appended to the request in order to read its schema. |
||||||
|
Select the authentication type |
Select one of the following options:
|
||||||
|
Select the web service type |
Some web services are complex and require a helper class to allow the customer to easily interact with them. We create or help you create special interfaces as required. |
||||||
|
Connect |
Click to connect to the specified web service. |
||||||
|
Select the desired method |
After connecting to the web service you can choose the method to invoke. The method will be examined and the parameters made available. |
||||||
|
Specify the parameters |
Each parameter and expected object type is listed. App Portal can pass string and integer values to web services. More complex objects like datasets and arrays are not currently supported. Enter static values or variables for the Parameter Value. Enter static values for the Default Value in the case where the value is not available (a blank office value for example). If the web service requires the value and no default is specified an error may occur and prevent processing of the request. Please be careful to add defaults whenever possible. |
App Portal / App Broker 2020 R1 Administration GuideAugust 2020 |