Skip to end of metadata
Go to start of metadata


A SOAP connection is configured using the SOAP connector to establish connectivity through a SOAP web service. Once a connection is established, you can configure one or more SOAP activities associated with that connection to use as a source or target within an operation.

Creating or Editing a SOAP Connection

From the design canvas, open the Connectivity tab of the design component palette:

To configure a new SOAP connection, within the Connectors filter, click the SOAP connector block:

To configure an existing SOAP connection, within the Endpoints filter, double-click the SOAP connection block:

This will open a configuration screen for the SOAP connection, covered next.

Configuring a SOAP Connection

Configuration of a SOAP connection includes these fields:

TIP: Fields with a variable icon support using global variablesproject variables, and Jitterbit variables. Begin typing an open square bracket [ into the field or click the variable icon to display existing variables to choose from.

  • Endpoint Name: Enter a name used to identify the SOAP connection. The name must be unique for each SOAP connection and must not contain forward slashes (/) or colons (:). As a specific connection and its activities are referred to as an endpoint, this name is also used to identify the SOAP endpoint.
  • Upload URL, Upload File, or Select Existing: Use the radio button to select the source of the WSDL (Web Services Description Language file) to upload or reuse. Files up to 5 MB in size can be uploaded.

    • Upload URL: Enter the URL into the text box, then click the Upload button.
    • Upload File: Use the Browse button to the right to browse to a WSDL, then click the Upload button.

      NOTE: Any schemaLocation must be resolved to a local file using a relative reference. This usually means that instead of supplying a tuple such as this:


      Instead, you would supply this:

      xsi:schemaLocation=' wsdlmime-2004-08-24.xsd'

      In the above example, the XSD file wsdlmime-2004-08-24.xsd is located either in the same directory or a path relative to the WSDL being loaded.

    • Select Existing: Use the dropdown to select from an existing WSDL that has previously been used in the current project.
  • Port: Use the dropdown to select the appropriate port.

  • Web Service URL: Enter a valid URL for the web service. By default, this field will populate with the URL from the WSDL.
  • Service & Binding: By default, these fields will autopopulate based on the provided WSDL and port and cannot be edited.
  • Optional Settings: Click to expand additional optional settings:

    • Enable content encoding: If selected, the "Accept-Encoding" header will be sent with the encoding supported by Jitterbit Harmony. Currently Gzip is supported. This option is off by default.

    • Enable chunked transfer encoding: If selected, the "Transfer-Encoding: chunked" header will be sent. Use this option if you are transferring large data sets. This option is off by default.

    • Send Expect: 100-continue: If selected, the "Expect: 100-continue" header will be sent. With this option no data will be sent until the HTTP server has validated the headers. Use this option if you are sending large amounts of data but don't want to use chunked transfer encoding. This option is off by default.

    • Allow weak ciphers: Select this checkbox to communicate with HTTP servers that use weak ciphers (DES/3DES and RC4). 

    • Set Accept-Encoding to GZip: Selected by default, this option tells the HTTP server that Jitterbit Harmony can accept a Gzip-compressed response. In return, Harmony will follow the RFC 1952 standard and automatically decompress Gzip HTTP responses. If the server does not use Gzip, Harmony will see that the response is not compressed and handle it as usual. 

    • SSL Version: Use the dropdown to select a specific SSL version if the HTTP server requires it. The default is “Negotiate.”

    • Request Headers: Any text entered in this box will be sent as an HTTP header. Specify each header on one line unless the header is wrapped according to the HTTP standard. This field also supports using global variablesproject variables, and Jitterbit variables by replacing variables in square brackets [ ] with their values.

  • Username & Password: If applicable, enter a username and password that will allow access to the WSDL. You can leave these fields blank if no username or password is required.

    By default, Jitterbit Harmony will negotiate with the endpoint to determine which authentication methods are supported, and use the provided credentials against one of the protocols. Jitterbit Harmony supports these HTTP authentication options:

    • HTTP Basic
    • HTTP Digest
    • HTTP Digest with authentication with an IE flavor
  • Certificate: Use the dropdown to select an available certificate to authenticate with the HTTP server.

    TIP: You can manage client-side SSL certificates from the Management Console under Customizations > Client Certificates.

  • Select Methods: Select the checkboxes for any methods that you want to be available to use as a source or target in the operation. 

  • Selected Activity & Display Name: As you select methods above, they will be added to the table below, showing each selected method that will be rendered as an activity block under the SOAP connection in the component palette. To edit the Display Name, click the edit icon  and enter the desired activity name.

  • Save Changes: Click this button to save and close the connection configuration.
  • Discard Changes: After making changes to a new or existing configuration, click Discard Changes to close the configuration without saving. A message will ask you to confirm that you want to discard changes.
  • Delete: After opening an existing connection configuration, click Delete to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal).

Next Steps

Depending on which methods were selected during configuration of the SOAP connection, you can configure one or more SOAP activities associated with that connection to use as a source or target within an operation. For more information, see SOAP Activities.

On This Page

Last updated:  Jun 25, 2020

  • No labels