Web service Jitterbit variables in Design Studio

Introduction

This page covers Jitterbit variables that are available for web service methods, organized by informational variables that you read (Informational), and settings variables that you write (Settings).

Informational

`jitterbit.webservice.last_fault`

Data type

String

Description

The last XML-formatted SOAP fault response from a SOAP web service. If no SOAP faults are generated or if the faults are not derived from 5XX server errors, this variable will remain unset. This variable is supported when using agent versions 10.68 or later or 11.6 or later.

The XML string can be read directly or transformed using the schemas below:

SOAP Fault 1.1

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<root>
    <transaction>
        <soap:Fault xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
            <faultcode xmlns="">soap:Server</faultcode>
            <faultstring xmlns="">Fault</faultstring>
        </soap:Fault>
    </transaction>
</root>

SOAP Fault 1.2

<?xml version="1.0" encoding="utf-8"?>
<root>
    <transaction>
        <soap:Fault xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <soap:Code>
                <soap:Value>soap:Receiver</soap:Value>
            </soap:Code>
            <soap:Reason>
                <soap:Text xml:lang="en">Fault</soap:Text>
            </soap:Reason>
            <soap:Detail/>
        </soap:Fault>
    </transaction>
</root>

`jitterbit.web_service_call.status_code`

Data type

Integer

Description

The response status code returned from a web service when used in an operation. If no status code is returned, the reported value is -1.

Settings

`jitterbit.web_service_call.max_redirs`

Data type

Integer

Default value

0

Description

Maximum number of redirects to follow when calling a web service. Set to a negative number to follow any number of redirects. The default is 0 (zero); no redirects are followed.

`jitterbit.web_service_call.number_of_retries`

Data type

Integer

Description

If a call to a web service fails with any status code except 400 or 403, retry this many times. The default is to not try again.

`jitterbit.web_service_call.retry_wait_seconds`

Data type

Integer

Description

If a call to a web service fails and retries are enabled by setting $jitterbit.web_service_call.number_of_retries to a positive integer, wait this many seconds between retries.

`jitterbit.web_service_call.ssl_cert_id`

Data type

String

Description

An identifier for a configuration entry in the configuration file jitterbit.conf for the SSL certificate to use for web services. Also see Customizations > Client Certificates and Adding certificates to keystore for private agents.

`jitterbit.web_service_call.sync_response`

Data type

Boolean

Default value

true

Description

Set to false to skip a step in processing of web service responses. This step is necessary only when processing SOAP arrays and can be skipped in other cases. The default is true, meaning this step is always performed.

`jitterbit.web_service_call.time_out`

Data type

Integer

Description

Set the number of seconds after which web service calls will time out, or set to 0 (zero) to disable. The default transfer time-out for web service calls is one hour (3600 seconds).