Install SOAP connector and dependencies ​

Refer to the following sections to install the SOAP connector and its dependencies:

• Set up an on-prem agent (OPA)
• Install the OPA extension
• Install the SOAP connector

After you install these dependencies, you can set up the connection.

Set up an on-prem agent (OPA) ​

Set up an on-prem agent (OPA). You can use either a cloud profile or connection profile. Both options require the ability to manually edit the config.yml file on the machine where the OPA is installed.

Install the OPA extension ​

Complete the following steps to install the OPA extension:

• Locate the on-prem agent
• Install the Java Development Kit (JDK)
• Download the SOAP extension package
• Configure the OPA and the extension
• Restart the OPA

Locate the on-prem agent ​

Locate the OPA directory on your filesystem. Typical locations are:

• Unix-like operating systems: /opt/workato
• Windows: C:\Program Files\Workato Agent
• macOS: Location varies.

$ ls /opt/workato
bin  conf  jre  lib  lib_ext

The rest of this guide refers to this path as $OPA.

Install the Java Development Kit (JDK) ​

Ensure version 17 or higher of the Java SDK is installed if you're using an OPA version lower than 23.0. The following are the default JDK installation locations:

• Linux: /usr/lib/java
• Ubuntu: /usr/share/java/
• Windows: C:\Program Files\Java\jdk-<release>
• macOS: Location varies based on distribution. Example: /Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home

$ ls /usr/lib/java
bin  conf  include  jmods  legal  lib  release

Ensure that the JDK installation is actually a JDK and not just a JRE, as this is required by Apache CXF. You can confirm this by checking for the javac binary:

$ ls /usr/lib/java/bin/java*
bin/java  bin/javac  bin/javadoc  bin/javap

If version 17+ of the JDK is not already installed, pick one of the many JDK distributions and follow the installation instructions.

After installing the JDK, confirm the installation by listing the JDK folder:

$ ls /path/to/jdk
bin  conf  include  jmods  legal  lib  release

Download the SOAP extension package ​

The SOAP extension consists of two JAR files, packaged up and available for download at this URL:

https://workato-opa-extensions.s3.amazonaws.com/soap-extensions/soap-extension-latest.zip

The following commands download and extract the package, moving the JAR files into the $OPA/ext folder. Note that $OPA represents the directory where the on-prem agent is installed.

$ curl -o soap-extension.zip https://workato-opa-extensions.s3.amazonaws.com/soap-extensions/soap-extension-latest.zip
$ unzip soap-extension.zip -d $OPA/ext

Confirm that both of the SOAP extension files are present in $OPA/ext:

$ ls $OPA/ext | grep soap_extension
soap_extension.jar
soap_extension_client.jar

Configure the OPA and the extension ​

The OPA configuration file is $OPA/conf/config.yml. To use the SOAP extension, you must update the configuration file according to the following instructions. This step applies whether the OPA is configured using a cloud profile or a connection profile.

server:
   classpath: /opt/workato/ext

extensions:
   soap:
      controllerClass: com.workato.extension.soap.ExtensionController

extensions:
   soap:
      controllerClass: com.workato.extension.soap.ExtensionController
      jdkHome: /path/to/jdk

Restart the OPA ​

Follow the instructions in the OPA documentation on how to stop and restart the OPA.

Install the SOAP connector ​

After you set up the OPA and SOAP extension, you can install the SOAP connector: