IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

Local environment overrides for the SOAPRequest node

You can dynamically override values in the local environment in the same way as setting values in other elements of a message.

Other local environment overrides are available for WS-Addressing. See WS-Addressing with the SOAPRequest node.

You can set the following properties in the SOAPRequest node under LocalEnvironment.Destination.SOAP.Request. These local environment overrides also apply to the SOAPAsyncRequest node.
Setting Description
Operation Overrides the Operation property on the node. For example: 
SET OutputLocalEnvironment.Destination.SOAP.Request.Operation = 'myOperation';
TransportType Overrides the Transport property on the node to switch transport. For example, if the node is configured to use the JMS transport, use the following to switch to HTTP transport:
SET OutputLocalEnvironment.Destination.SOAP.Request.TransportType = 'http';
To switch to JMS transport:
SET OutputLocalEnvironment.Destination.SOAP.Request.TransportType = 'jms';
This overrides the request and response transport for this message.
UserContext You can store BLOB context data in the following location in the local environment. The SOAPAsyncResponse node can later retrieve this data.
SET OutputLocalEnvironment.Destination.SOAP.Request.UserContext = x'aabbccddeeff11223344556677889900';
Data stored in the UserContext must be in BLOB format. This field is included in the message bitstream, and therefore increases the message size.

This setting applies only to the SOAPAsyncRequest node and is ignored by a SOAPRequest node.

LocalEnvironment overrides for HTTP transport

You can set the following HTTP properties in the SOAPRequest node under LocalEnvironment.Destination.SOAP.Request.Transport.HTTP. These properties apply only when using HTTP transport. You can switch between HTTP and JMS transport using the TransportType override, or the WS-Addressing To field; see WS-Addressing information in the local environment.
Setting Description
Compression Overrides the Use compression property on the node. For example: 
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.Compression = 'gzip';
To set a minimum size (in bytes) at which compression is applied, use the following override: 
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.MinimumCompressionSize = 1048576;
Enable CRL checking Overrides the Enable Certificate Revocation List checking property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.EnableCRLCheck = 'true';
HTTPVersion Overrides the HTTPVersion. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.HTTPVersion = 
'HTTP/1.1';
Method Overrides the Method. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.Method = 'GET';
ProxyConnectHeaders Specifies additional headers that are used if the outbound request is an SSL connection through a proxy. These additional headers are sent with the initial CONNECT request to the proxy. For example, you can send proxy authentication information to a proxy server when you are using SSL. You can send multiple headers but each one must be separated by a carriage return and a line feed (ASCII 0x0D 0x0A), in accordance with RFC2616; for example:
DECLARE CRLF CHAR CAST(X'0D0A' AS CHAR CCSID 1208);     
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.ProxyConnectHeaders =
'Proxy-Authorization: Basic Zm5lcmJsZTpwYXNzd29yZA==' || CRLF || 
'Proxy-Connection: Keep-Alive' || CRLF;
This setting is used only if the request is an SSL request through a proxy server. To send proxy authentication information for a non-SSL request, specify the individual headers in the HTTPRequestHeader folder, as shown in the following example:
SET OutputRoot.HTTPRequestHeader."Proxy-Authorization" = 'Basic Zm5lcmJsZTpwYXNzd29yZA==';
SET OutputRoot.HTTPRequestHeader."Proxy-Connection" = 'Keep-Alive';
ProxyURL Overrides the HTTP(S) proxy location property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.ProxyURL = 
'my.proxy';
RequestURI Overrides the RequestURI, which is the path after the URL and port. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.RequestURI = 
'/abc/def?x=y&g=h';
SSL authentication alias Overrides the SSL authentication alias for the client-side of a SOAP connection on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.KeyAlias = 'Key1Alias';
SSLCiphers Overrides the Allowed SSL Ciphers (if using SSL) property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.SSLCiphers = 
'SSL_RSA_FIPS_WITH_3DES_EDE_CBC_SHA';
SSLProtocol Overrides the SSLProtocol property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.SSLProtocol = 
'TLS';

Valid values are: SSL, SSLv3, TLS, TLSv1, TLSv1.1, TLSv1.2, SSL_TLS, and SSL_TLSv2
Timeout Overrides the Request timeout (in seconds) property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.Timeout = 42;
TimeoutMillis Overrides the Request timeout (in seconds) property on the node. For example: 
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.TimeoutMillis = 5000;
This property defines the timeout in milliseconds. The value of TimeoutMillis overrides the value for Timeout if both values are set.
WebServiceURL Overrides the Web service URL property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.WebServiceURL = 
'http://ibm.com/abc/';
Start of changeServicePrincipalNameEnd of change Start of changeSpecifies the Service Principal Name (SPN) to use when the broker negotiates the Kerberos security protocol. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.HTTP.ServicePrincipalName = 
'HTTP/iib.iibservice2.com:7800';
End of change

LocalEnvironment overrides for JMS transport

You can set the following JMS properties in the SOAPRequest node under LocalEnvironment.Destination.SOAP.Request.Transport.JMS. These properties apply only when using JMS transport. You can switch between HTTP and JMS transport using the TransportType override, or the WS-Addressing To field; see WS-Addressing information in the local environment.

Some JMS local environment overrides for the SOAPRequest node have equivalent properties in the JMSTransport header. If you specify a local environment override, it takes precedence over any equivalent property set in the JMSTransport header.

Setting Description
BindingsLocation Overrides the JNDI URL bindings location property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.BindingsLocation = 
'file:/C:/mqsi6/Webservices/SOAP/JMS/JNDI';
ConnectionFactoryName Overrides the Connection factory name property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.ConnectionFactoryName = 
'QCF';
ContextParameters Specify JNDI context parameters in addition to the JNDI context parameters defined on the node. You can define specific JNDI context parameters, for example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.ContextParameters.property1 = 
'value1';
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.ContextParameters.property2 = 
'value2';
CorrelationID Sets the request message CorrelID. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.CorrelationID  = 
'myCorrelID';
CorrelationPattern Sets the request message correlation pattern. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.CorrelationPattern  = 
1;
The allowed values are the integers 1 and 2:
  • 1 indicates that the messages should be automatically correlated by the CorrelID if one is present. Otherwise, the messages are correlated by the message ID. This is the default behavior.
  • 2 forces the messages to be correlated by the message ID, even if a CorrelID is present.
DeliveryMode Overrides the DeliveryMode property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.DeliveryMode = 
'NON_PERSISTENT';
Allowed values for this property are PERSISTENT and NON_PERSISTENT. If the UriFormat is ibm, 1 and 0 are additional allowed values for DeliveryMode.
Destination Overrides the Destination property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.Destination = 
'REPLYTOQ2';
DestinationURI You can override multiple JMS properties at the same time in the local environment using the DestinationURI setting. Properties that you set in this way can be overridden by setting local environment overrides for individual JMS properties as shown in the following tables.
SET OutputLocalEnvironment.Destination.SOAP.Reply.Transport.JMS.DestinationURI = 
	'jms:jndi:INPUTQ1?jndiConnectionFactoryName=QCF&
	replyToName=REPLYTOQ2&
	jndiInitialContextFactory=com.sun.jndi.fscontext.RefFSContextFactory&
	jndiURL=file:/C:/Webservices/SOAP/JMS/JNDI&
	userParam1=value1&
	userParam2=value2&
	timeToLive=30000';
This local environment override can be set with either a W3C-style or IBM-style URI format. For more information, see WSDL URI formats for JMS.
Expiration Overrides the Expiration property on the node. This property is specified in milliseconds. For example, to set an expiration of 100 milliseconds:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.Expiration = 
'100';
InitialContextFactory Overrides the Initial context factory property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.InitialContextFactory = 
'com.sun.jndi.fscontext.RefFSContextFactory';
MessagePriority Overrides the MessagePriority property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.MessagePriority = 
'7';
MessageType Overrides the MessageType property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.MessageType = 
'text';
Allowed values for this property are textand bytes.
ProviderName Overrides the JMS provider name property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.ProviderName = 
'WebSphere MQ';
ReplyToDestination Overrides the ReplyToDestination property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.ReplyToDestination = 
'REPLYTOQ3';
TargetService Overrides the TargetService property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.TargetService = 
'testService';
Timeout Overrides the Timeout property on the node. This value is specified in seconds. For example, to set a timeout value of 30 seconds:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.Timeout = 
'30';
TransactionMode Overrides the Transaction mode property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.TransactionMode = 'Yes';
Allowable values for this property are Yes, No and ForceLocal.
  • No means that no transaction takes place, and is equivalent to None.
  • Yes means that a local transaction takes place if the flow's Coordinated Transaction is not selected, or an XA coordinated transaction takes place if the flow's Coordinated Transaction property is selected.
  • ForceLocal means that a local transaction is always used, even if the flow's Coordinated Transaction property is selected.
UriFormat Overrides the UriFormat property on the node. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.UriFormat  = 
'w3c';
Allowable values for this property are w3c and ibm.
UserProperties Specify user context parameters in addition to the user context parameters defined on the node. You can define specific user context parameters, for example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.UserProperties.property1 = 
'value1';
SET OutputLocalEnvironment.Destination.SOAP.Request.Transport.JMS.JNDI.UserProperties.property2 = 
'value2';
Setting Description
OneWay In gateway mode, instructs the node that the outbound message is a one-way message and that no reply message is expected. For example:
SET OutputLocalEnvironment.Destination.SOAP.Request.Gateway.OneWay = True

If the message is sent over the HTTP transport, the node waits for an acknowledgment HTTP 202 response message from the remote server. If the message is sent over the JMS transport, no response is expected, the outbound message has no Reply-To queue, and the node does not wait for a response.

For more information, see One-way messages in Gateway mode.
ac56192_.htm | Last updated Friday, 21 July 2017