Welcome to Kofax RPA > Management Console > Management Console Configuration and User Interface > Repository > Robots > SOAP

SOAP

Robots can initiate SOAP requests to communicate with programs installed on other computers, pass necessary information, and return a response.

In the Repository > Robots section, from the context menu for a robot, click SOAP to access a window for editing and testing your SOAP request.

Input format

"Normal" or "flat" refers to the structure of a SOAP request message. For example, if a robot myRobot expects input variables var1 and var2, both of a type that has attributes attr1 and attr2, then "normal" would expect a SOAP message that looks similar to the following. 

  <myRobot>
     <var1>
       <attr1>Some value</attr1>
       <attr2>Another value</attr2>
     </var1>
     <var2>
       <attr1>More input</attr1>
       <attr2>and some more</attr2>
     </var2>
   </myRobot>

The "flat" structure would require the SOAP message to look as follows: 

 <myRobot>
     <var1__attr1>Some value</var1__attr1>
     <var1__attr2>Another value</var1__attr2>
     <var2__attr1>More input</var2__attr1>
     <var2__attr2>and some more</var2__attr2>
   </myRobot>

The flat structure was introduced for compatibility reasons.

WSDL URL

The URL for the WSDL of the project that this robot belongs to. Note that this URL is identical for all robots of the same project.

Request URL

When running a robot, an HTTP POST request should be sent to this URL.

SOAP action

When running a robot, a HTTP header called SOAPAction should be present with the value shown.

Request

This field is pre-filled with an example SOAP message. All input attributes have default/test values. It can be edited before clicking Test service.

Response

A non-editable field which contains output from a robot run.

If there are errors in the input parameters or errors during the robot run, a SOAP Fault message is shown (containing a reason and some details for the error).

Important notes
  • Project names can contain characters that are not allowed in WSDL; therefore, project names might be different in WSDL/SOAP messages. More specifically, all characters that are not alphanumeric (a-z, A-Z, 0-9) will be replaced by _.
  • Similarly, robot names may appear different. They are converted similarly to project names, but when a robot name is changed, a special suffix (such as _1234) is also added.
  • Currently, SOAP 1.1 is supported.