Web Service Run

Kalipso - Form - Actions - Actions Description - Group Communications - Web Service Run

Executes a HTTP Request to a HTTP Server.

Action available for the following operating systems:

Parameters

General

• Run From - Kalipso allows you to execute a Web Service directly from the mobile device, if you have connectivity, choosing "Locally" option. If you don't have access to the Web Server but you can reach MIS Communicator, choose "Remotely" option, who will send the request to MIS Communicator who will run it and return the answer to the Mobile Device. If the user chooses option "Remotely", is necessary define the following parameters:

  • Communication Profile - Name of the communication profile used to execute the remote HTTP Server.

  • Hidden - This parameter allows user to define if he wants to run the remote HTTP Request in hidden mode or not.

  • Timeout - The timeout defined for connection. The value 0 is system default. The timeout value is in milliseconds.

• XML <string> - The Control or Variable where to save the Web Service answer XML.

• Target Answer Header <string> - The Control or Variable where to save the Web Service answer Header.

• Target Status Code <numeric> - The control or variable to save the result of the status code.

• Target Status Text <string> - The control or variable to save the result of the status text.

• Fail if status code isn't 2xx - Defines whether fails if status code isn't 2xx.

Web Service

• Web Service <string> - Web Service to run.

• Type - Operation Type to run. This parameter has the following possible options:

  • SOAP

  • HTTP GET

  • HTTP POST

• Operation <numeric> - Web Service's Operation to run.

• Address <string> - The Address where the web service is available. This parameter is automatically defined when you choose the Operation but it can be overwritten.

• Port <numeric> - The Port where the Web Service is available. This value is inherited from the Web Service Properties but it can be overwritten.

• Encoding <string> - The encoding schema used for the communication. The possible options for this parameter are:

  • utf-8

  • utf-7

  • ansi

  • unicode

• Request Header <string> - Defines a additional request header for the HTTP Request.

Inputs

• Parameter <string> - Name of the input parameter for the Web Service call.

• Type - Type of Source expression.

• Source <string> - Value of the Parameter.

Outputs

• Parameter string - Name of the output parameter for the Web Service call.

• Type - Type of the Target. The Control or Variable will be set to this type.

• Target <string> - Control or Variable where the output value is written.

• Element Not Found Value <numeric> - On the "Outputs" tab a list of targets is defined for the response. If one element defined for a target is not found, the value of this parameter is set in that target.

Security

• User <string> - The name of the user for the HTTP Request. If there is no defined user for the web service call, just put "" on this parameter.

• Password <string> - The password of the user of the HTTP Request. If there is no user and password, just put "" on this parameter.

• Certificate File <string> - Path of the client certificate file.

• Certificate File Password <string> - Client certificate File Password.

These last two parameters are not supported on Windows 10 Clients

• Ignore Invalid Certificates - Defines whether ignores or not Invalid Certificates.

• Certificate Fingerprint List <string> - List of Public Key SHA256 Hash for certificate pinning, separated by CR.

• Public Key Fingerprint List <string> - List of Public Key SHA256 Hash for certificate pinning, separated by CR.

These last two parameters are not supported on Windows Mobile/CE.

Request Body

• Request Body <string> - The XML code representing the body of the Web Service request.

When using Self-signed Certificates, you should set the parameter Ignore Invalid Certificates to Yes, and add the certificate fingerprint in the Certificate Fingerprint List or the Public Key Fingerprint to the Public Key Fingerprint List.

In order to use this action, you must have configured (in this case the associated and imported service) the corresponding web service. For this purpose, access the menu option Project > Web Services to configure. Learn more here.