Here you can find a description of the configuration options for SOAP connections in the priint:comet Illustrator plugins

A general description of SOAP can be found here

SOAP connections support SSL. As of v4.1 R23456, TLSv1.2 is also supported. Please note the following restrictions for TLS:

Under Mac OS X TLSv1.2 can only be supported starting with InDesign® CC2017 and at least Mac OS X 10.11 Yosemite. For TLSv1.2 the CoreServie plugin requires the two system libraries /usr/lib/libssl.35.dylib and /usr/lib/libcrypto.35.dylib, which are only part of the operating system from Mac OS X 10.11 on.

For CC 2017 and Mac OS X 10.10 the libraries can be installed later. Admin rights are required for the installation:

- Extract from libssl35.zip
- Then in the terminal
    cd Unpacked folder
   sudo mv libssl.35.dylib /usr/lib
   sudo mv libcrypto.35.dylib /usr/lib

Special properties of the SOAP connection can be stored in a configuration file called soapflags.ini . This file must be located in the installation directory of Werk II PlugIns. A commented example of this file can be found here. The configuration settings of soapflags.ini are usually not required to connect to a SOAP service, but allow customizations to the respective IT infrastructure or certain SOAP implementations.

The following settings can be made:

Group Option Values Availability
Proxy Options for connection via HTTP proxy
  proxy_host IP Adress or Name of the HTTP Proxy. If empty or undefined, no proxy will be used. SOAP/PubServer
  proxy_user User name for the proxy server. If empty or undefined, no credentials will be used when connecting to the proxy.
  proxy_passwd Password for the proxy server. If empty or undefined, no credentials will be used when connecting to the proxy.
SOAP SOAP Version Support
  soap-version 1.1 or 1.2 (default) SOAP/PubServer
keep-alive

yes (default) or no [since v4.0.5 R19503]

Attention :  The value no use usefull in connections with very long transfer times and newer Windows OS on server side only. In this case, the internal TCP connection is re-established for every package to transfer. This leads to a more stable SOAP connection, but this connection is up to six times slower than a normal connection.

use-ie-options

no (default) or yes [since v4.1 R23232]

The setting is only meaningful under Windows and is ignored using Mac OS X or Linux. Here's the description from the author Robert van Engelen:

The WinInet plugin for gSOAP enables client applications (not servers) to communicate through Microsoft's WinInet API on Windows. This offers all of the advantages of WinInet-managed internet access through the Internet Options control panel of Windows, such as HTTP (proxy) authentication, TLS/SSL, and HTTP compression. Therefore, "if IE works, gSOAP works. since these options are shared by IE".

For more details see https://www.genivia.com/doc/wininet/html/index.html.

Timeouts Connection and Request timeout
  login-timeout

Timeout for connection establishment and login in seconds, default 5 seconds

Timeout for connection establishment, default 3 seconds

The setting is also used for Web Images when a HTTP or AEM connection is active. If a different value was set with prefs::set_urllink_timeout, this time is used as a timeout for the connection setup.

SOAP/PubServer
HTTP
AEM
  request-timeout

Request timeout in seconds, defaults to deactivated on Mac, to 3600 on Windoews. In Windows InDesign® Server environments, it may make sense to set a higher value, if very complicated generation schemes with runtime > 1h are used.

It is not possible to completely deactivate request timeouts on Windows, which is why the default value is set so high.

The setting is also used for Web Images when a HTTP or AEM connection is active.

Protocol Data transfer protocol for CURL calls
ip-resolve

Allows an application to select what kind of IP addresses to use when resolving host names. This is only interesting when using host names that resolve addresses using more than one version of IP. The allowed values are:

  • ipv4, ip4, 4
  • ipv6, ip6, 6

The setting is also used by Web Images if an HTTP or AEM connection is active and the adress of image (URL) points to this data source.

HHTP
AEM
update-protocol

Which protocol should be used for uploads? This specification replaces the protocol name of the URL for uploads, e.g. ftp://www.hi13.de/aaa.jpg instead of http://www.hi13.de/aaa.jpg. Valid values are:

  • ftp
  • http, https
HTTP
Header Fine control of SOAP headers (required for some .Net Service Implementations)
  http-multipart-type

SOAP 1.1: application/xop+xml; charset=utf-8

SOAP 1.2: application/soap+xml; charset=utf-8

SOAP/PubServer
  http-multipart-start-info

SOAP 1.1: text/xml; charset=utf-8

SOAP 1.2: application/soap+xml; charset=utf-8

  soap-multipart-type

SOAP 1.1: application/xop+xml; text/xml; charset=utf-8

SOAP 1.2: application/xop+xml; charset=utf-8; type="application/soap+xml"

  http-type

SOAP 1.1: text/xml; charset=utf-8

SOAP 1.2: application/soap+xml; charset=utf-8

  soap-type

SOAP 1.1: text/xml; charset=utf-8

SOAP 1.2: application/soap+xml; charset=utf-8

SSL Settings for SSL connection validation
  ca-file

Path to a PEM encoded certificate file. Certificates imported into the system are not supported by the OpenSSL implementation integrated with our SOAP library, so some certificates can be imported with the ca-file option. If this option is empty or undefined, the server certificate is not verified.

Certificates are commonly DER encoded, to convert, you can use the OpenSSL terminal, e.g.

openssl x509 \
    -in ~/Desktop/mycerts.crt \
    -inform der \
    -outform pem \
    -out ~/Desktop/mycerts.pem

A certificate file may contain multiple certificates, where each one begins with -----BEGIN CERTIFICATE----- and ends with -----END CERTIFICATE-----.

The path may use the placeholders defined for the file object ($DESKTOP, $PLUGINS etc.).

Warning: the SSL environment is initialized once for each application, so you have to restart InDesign/InDesign Server after changing the ca-file specification. However, the certificates are read on each connection - every time. This means that changing the certificate file takes effect on reconnection, without restarting InDesign®.

If no certificate file is specified, it is automatically attempted to load the werkii/certs.pem file of the current user's preferences folder ($PREFS).

SOAP/PubServer

The entire data traffic of a SOAP connection can be recorded. Information about this can be found here.