Transport

HTTP

Configures the communication method used to connect to the Web Service. Select either HTTP or HTTPS.

Note

This option is only supported in the WinHTTP implementation. The HTTP Only implementation ignores this setting and always uses HTTP. For more information on the WinHTTP and HTTP Only, refer to the setting XMLWebImplementation.

HostName

Empty

Required. The hostname or IP number of the HTTP server. For example: myserver.com.

Port

80

The port on which the Web Service is listening.

Note

The WinHTTP implementation uses port 0 to indicate autoselect. Based on the Transport setting it will connnect to the HTTP (80) or HTTPS (443) port.

Timeout

30000

The timeout (in milliseconds) to be used for transmission of data.

URI

Empty

The Universal Resource Identifier (URI) for the request. For example: /invoke/service.

AutoLogin

Profile

Determines when an automatic attempt is made to authenticate.

Supported values:

• Always; always attempt to automatically authenticate.
• Intranet Only; only attempt to authenticate on servers which are in the local intranet zone.
• Never; never attempt to automatically authenticate.
• Profile; use the Security Level setting configured in the ITP/Server's account's profile.

Automatic authentication is done using the ITP/Server's account's credentials. If the authentication is disabled or the credentials are rejected a second attempt is made using the UserId and Password settings below.

Note

This option is only supported in the WinHTTP implementation.

UserId

Empty

The user id that must be used for this connection.

HTTP Only implementation
If both the UserId and Password are specified, each request will automatically include Basic Access Authentication information as described in RFC 2617 of the HTTP specifications. Basic Access Authentication does not encrypt the password.

WinHTTP implementation
The UserId and Password are included in a request whenever the server requests credentials. The appropriate authentication scheme is negotiated with the server and the password will always be encrypted.
Basic Access Authentication is only supported for HTTPS connections.

Note

These security restrictions can be lowered using the AllowPlainTextLogin setting described below.

Password

Empty

The password that must be used for this connection.

See the remarks on the UserId setting.

Header-Template

Empty

The file name of the header template. Needs only to be specified if special/custom HTTP headers are needed or a standard header that is not yet fully supported.

Content-Type

Empty

The content type of the HTTP header. Required if a Content-Template has been specified.

Content-Template

Empty

Required unless the request can be specified by means of the HTTP header alone. It specifies the file name of the content template used to construct the body of the HTTP message.

Method

POST

The http method for requesting information.

ResultPath

Empty

An XML path to the requested XML data. This path is prepended to the one defined in the DID.

ErrorTag

Empty

If this setting is specified and the returned XML file contains an element with this tag, the XML WebServices Connection will not return a normal result, but instead it will return the contents of this element as an error message. The element must be located in the RESULT_PATH of the entry.

ReuseConnections

Y

Allows the client to reuse an established connection to send multiple requests. This option reduces the overhead of connection and authentication.
If this setting is disabled ITP will disconnect from the Web Service after every request.

Note

This option is only supported in the WinHTTP implementation.

ResetConnectionsAfterModel

N

If you set ResetConnectionsAfterModel, the DataManager will not be stopped. ITP will completely rebuilt the connection for each model, thus allowing you to change for example the Userid, Password setting for the next model. This setting can only be used on DID level.

SupportCookies

Y

Keeps cookies between requests if the connection is reused for multiple requests. This requires the ReuseConnections setting to be enabled.

Note

This option is only supported in the WinHTTP implementation.

DisableRedirects

Y

Disable automatic redirection. If this option is disabled the XML WebServices Connection will follow 3xx Redirection responses returned by the Web Service.

Redirects from a secure HTTPS URL to an insecure HTTP URL are always disabled.

Note

This option is only supported in the WinHTTP implementation.

SSL.ValidateName

Y

Validate that the name in the SSL certificate used by the Web Service matches the name in the URI.
Disable this setting to allow the server to use any certificate.

Note

This option is only supported in the WinHTTP implementation.

SSL.ValidateAuthority

Y

Validate the Certificate Authority that signed the SSL certificate used by the Web Service. Any known Certificate Authority certificates installed on the server are accepted.
Disable this setting to allow the server to use certificates used by unknown Certificate Authorities and self-signed certificates.

Note

This option is only supported in the WinHTTP implementation.

SSL.ValidateDate

Y

Validate the validity of the SSL certificate used by the Web Service. Disable this setting to accept expired and not yet valid certificates.

Note

This option is only supported in the WinHTTP implementation.

SSL.ValidateUsage

Y

Validate that the SSL certificate used by the Web Service is issued as a server certificate. Disable this setting to allow the server to use non-server (client) certificates.

Note

This option is only supported in the WinHTTP implementation.

SSL.AllowSSL2

N

Enable this setting to allow the XML WebServices Connection to negotiate the SSL2 protocol when establishing an HTTPS connection.

Note

The SSL2 protocol is obsolete and should not be used. This option is available for backward compatibility with older Web Services.This option is only supported in the WinHTTP implementation.

Certificate.Hash

Empty

This setting specifies the SHA1 hash (the Finger print field) of the client certificate that the XML WebServices Connection must use if the Web Service requires a client certificate.

Note

This option is only supported in the WinHTTP implementation.

Certificate.Text

Empty

This settings specifies the name (the Subject field) of the client certificate that the XML WebServices Connection must use if the Web Service requires a client certificate. The first certificate that contains a case-insensitive substring that matches this parameter will be used.
This setting is ignored if the Certificate.Hash setting is used.

Note

This option is only supported in the WinHTTP implementation.

UserAgent

Empty

Specifies a custom UserAgent setting. This setting can be used to simulate another client application.

Note

This option is only supported in the WinHTTP implementation.

AllowPlainTextLogin

N

Allows the XML WebServices Connection to use Basic Access Authentication over an HTTP connection if the Web Service does not support any alternative authentication methods.

Enabling this option can cause the XML WebServices Connection to send the password unencrypted over the network connection.

Note

This option is only supported in the WinHTTP implementation.

AllowMissingFields

N

When you set this key to Y or y ITP will give no errors for missing fields in an entry. These fields will be filled with the default value for the corresponding type.

Encoding.Default

UTF-8

Allows a different encoding to be specified. In this way files without a prologue can use an encoding different than UTF-8. Supported encodings are: UTF-8, ISO-8859-1 (or one of its aliases, see below), ISO-8859-15 (or one of its aliases, see below) and ASCII.

LOCALE

ENG

With this setting you determine the style of the thousand separator and the decimal point. See the table below for the possible language codes.

LOCALE:LC_NUMERIC:thousands_sep

Special.

With this setting you can overwrite the default style of the thousands separator (see the table below).

LOCALE:LC_NUMERIC:decimal_point

Special.

With this setting you can overwrite the default style of the decimal point (see the table below).

DES

dot

comma

DEU

dot

comma

ENG

comma

dot

ENU

comma

dot

FRA

dot

comma

FRB

dot

comma

FRS

dot

comma

ITS

dot

comma

NLB

dot

comma

NLD

dot

comma

DAN

dot

comma

ESP

dot

comma

PTG

dot

comma

SVE

space

comma

windows-1252

IBM819

windows latin 1

CP819

ISO_8859-1

ISO8859-1

latin1

ISO 8859-1

windows-1252

latin9

windows latin 1

ISO_8859-15

ISO_8859-15

ISO8859-15

latin1

ISO 8859-15