SOAP Connector Options

You can set the default SOAP connector options using the USYS$SOP_PARAMS setting in the [DRIVER_SETTINGS] section of the assignment file. They can be overridden for specific components in the [SERVICES_EXEC] section. and they can be set dynamically using the $signatureproperties ProcScript function.

USYS$SOP_PARAMS {=} {puser=ProxyServerUserID} %\
    {ppass=ProxyServerPassword} %\
    {euser=WebServerUserID} %\
    {epass=WebServerPassword} %\
    {scheme=AuthScheme} %\
    {proxy=ProxySpec} %\
    {cto=ConnectionTimeOut} %\
    {rto=RequestTimeOut} %\
    {ign=IgnoredVerificationMethod}  %\
    {callback=CallbackServices} %\
    {wsdl=Location} %\
    {svc=EndpointURI}

Note:  For readability, the line continuation marker (%\) has been used to put options on separate lines. In the assignment file, the USYS$SOP_PARAMS setting and its options can be put on a single line, or split using %\.

Options

SOAP Connector Options
Connector Option Description SOP U1.0 SOP U2.0
puser User name for the proxy server. X X
ppass Password for the proxy server. X X
euser User name for end-point authentication by the web server. X X
epass Password for end-point authentication by the web server. X X
cto Connection time-out, in milliseconds. This is used to configure the connection timeout when:
  • Reading the WSDL file prior to sending a SOAP request.
  • Connecting to the web service.

The default is 30,000 milliseconds.

X X
rto

Request time-out, in milliseconds. This option applies only after the server is connected.

The value is used to configure the transfer timeout when:

  • Reading the WSDL file prior to sending a SOAP request.
  • Sending a SOAP request to the web service.

The default is 30,000 milliseconds.

X

X

proxy Proxy to be used (see Proxy Specifications for SOAP Connectors ). X X
scheme Authentication scheme; valid values are B (Basic), D (Digest), L (NTLM), and N (Negotiable).

For SOP U1.0, the default is LN (NTLM and Negotiate), which are strong authentication protocols. For more information about authentication schemes, refer to Building Secure Web Services with Microsoft SOAP Toolkit 2.0.

For SOP U2.0, the default is to use the most secure authentication protocol available, excluding Basic.

X X
wsdl Location of the WSDL file; can be a URL or a local path and file name. The location specified here overrides the location recorded in the SOAP signature created by a WSDL import. See Overriding the Location of Web Service and WSDL File. X X
callback Comma-separated list of components that implement SOAP callback operations for call-out. For more information, see SOAP Callback Operations for Web Services Call-Out.   X
ign Turn off host or peer (server) verification if the WDSL specifies the HTTPS protocol; valid values are H (do not perform host verification) and P (do not perform peer server verification); both can be specified.

By default, if the HTTPS protocol is specified, both host and peer verification are performed as part of setting up a secure connection. For peer verification, the local certificate store file ca-bundle.crt should be present in the usys directory. For more information, see HTTPS Protocol.

  X
svc Endpoint URL of the web service. It corresponds to the location attribute of the address element, as specified by http://schemas.xmlsoap.org/wsdl/soap/ in the WSDL file. See Overriding the Location of Web Service and WSDL File.   X
 

Description

Use the USYS$SOP_PARAMS setting in the [DRIVER_SETTINGS] section of the assignment file to specify the default signature properties of the SOAP connector.

Settings in the [SERVICES_EXEC] section override the corresponding connector options specified in the [DRIVER_SETTINGS] section. The connector options in USYS$SOP_PARAMS cannot be nullified; they can only be overridden with another value.

It is also possible to set connector options in ProcScript using $signatureproperties, overriding the values set for these options in the assignment file. All defined connector options are merged, whether they are set in ProcScript, in the [SERVICES_EXEC] section, or by the USYS$SOP_PARAMS setting. Thus, if you want the freedom to add and remove properties dynamically, do not define them in the assignment file. For more information, see $signatureproperties.

If endpoint authentication is required by the web server, you must provide the user ID and password when you import the WSDL file using the /sti command line switch.

Proxy Specifications for SOAP Connectors
Specification Meaning
SOP U1.0 SOP U2.0
<NONE> A proxy will not be used A proxy will not be used
<CURRENT_USER> Use the current user’s Internet Explorer settings; the default specification. No effect. To use a proxy server, specify it explicitly.
<LOCAL_MACHINE> Use the local machine’s settings No effect. To use a proxy server, specify it explicitly.
Host{:Port} Use Host as the HTTP proxy server. If the optional Port is not specified, the default is port 80. Use Host as the HTTP proxy server. If the optional Port is not specified, the default is port 1080.

Overriding the Location of Web Service and WSDL File

The wsdl and svc options allow you to change the location of the WSDL file and web service. These options are not intended to specify a different service, but to allow more flexibility in the deployment of the service.

Important: When you change the location of the endpoint URL of a web service or the location of the WSDL file, you depart from the contract as specified in the WSDL. It is your responsibility to understand the impact of such changes and ensure they are correct.

For Uniface call-in, we recommend that you do not change the name of the service. At the moment of call-in, Uniface checks that the name of the specified service is the same as in the SOAP envelope.

Uniface does not check the locations specified by wsdl and svc, nor service name at the moment it specified in the $signatureproperties. It just stores the information, and when the SOAP connector creates an instance of the web service, the options are retrieved and used. They are only defined in the local application and are not transported to the service, if it is redirected with [SERVICES_EXEC].

It is not necessary for the service name in the URL specified by svc to be the same as in the SOAP envelope because the SOAP envelope can be changed in SOAP callback operations. For more information, see Calling Sequence.

If the $SOAP_CALLIN_CB assignment setting specifies [self], the URL of the web service is used to instantiate the web service for call back operations. However, these operations may change the SOAP envelope, and it is the SOAP envelope that determines the component that is activated for call-in request.

[DRIVER_SETTINGS]
SOP U2.0
USYS$SOP_PARAMS = proxy=www-proxy:1080 puser=user1 ppass=password1 scheme=B wsdl=D:\u9\uniface\wsdl\soapdlw.wsdl

Related Topics