Document Optional. Specifies the transport-level and message-level credentials to include in the request.

Integration Server uses the information provided in auth to create the HTTP request and the SOAP request.

Document Optional. Specifies the transport-level credentials to include in the HTTP request. Integration Server uses the information specified in the transport variable to populate the Authorization header in the HTTP request.

You only need to provide credentials in transport if the endpoint URL specifies HTTPS and you want to overwrite the credentials specified in the consumer web service endpoint alias assigned to the binder.

String Optional. Specifies the type of authentication required by the host.

String Optional. User name used to authenticate the consumer at the HTTP or HTTPS transport level on the host server.

String Optional. Password used to authenticate the consumer on the host server.

Document Optional. The message signer’s private key and certificate chain.

Document Optional. Specifies the message-level credentials to include in the WS-Security SOAP headers included in the SOAP request.

For information about specifying message-level credentials in a web service connector, see Passing Message-Level Security Information to a Web Service Connector.

String Optional. User name used to authenticate the consumer at the message level.

Specify a value for user if the SOAP message request requires credentials for a UsernameToken.

String Optional. Password used to authenticate the consumer at the message level.

Specify a value for pass if the SOAP message request requires credentials for a UsernameToken.

Document Optional. The message signer’s private key and certificate chain.

Object Optional. The partner’s complete certificate chain, where element 0 in the list contains the message signer’s certificate and element 1 contains the CA’s certificate.

Document Optional. Kerberos-related details that will be used to provide Kerberos authentication for web service requests.

String Optional. Time (measured in milliseconds) to wait for a response from the server hosting the web service before timing out and terminating the request.

If timeout is not specified or specifies a value < 0, Integration Server uses one of the following values:

For more information about server configuration properties, see webMethods Integration Server Administrator’s Guide.

A timeout value of 0 means Integration Server waits for a response indefinitely. If the connection to the host or JMS provider ends before Integration Server receives a response, the web service connector ends with an exception and a status code of 408.

Integration Server ignores timeout if the name/value pair jms.async= true is passed in to transportHeaders.

String Optional. Specifies the port that Integration Server uses to invoke the operation represented by the web service connector. You only need to specify a value for _port when the portType in the WSDL is associated with multiple bindings. Reference the WSDL document to determine the names of the ports associated with the bindings for a given portType.

If you do not specify a value for _port, Integration Server uses the first port defined in the WSDL for the web service.

String Optional. The URL to use as the endpoint URL for the web service. If supplied, the value of _url overwrites the endpoint URL in the original WSDL.

If a consumer web service endpoint alias is assigned to the binder used by the web service connector, the host and/or port in the consumer web service endpoint alias overwrite the host and/or port specified in _url. For more information about how Integration Server constructs the endpoint URL, see How Integration Server Builds the Consumer Endpoint URL.

String Optional. The endpoint alias to use as the endpoint alias for the web service. If supplied, the value of endpointAlias overwrites the endpoint alias in the original WSDL.

To invoke the operations represented by the web service connector, you must have the credentials and user group membership permission to execute this endpoint alias as specified in its Execute ACL property.

Document Optional. Transport-specific header fields that you want to explicitly set in the request issued by the web service connector. Specify a key in transportHeaders for each header field that you want to set, where the key’s name represents the name of the header field and the key’s value represents the value of that header field.

The names and values supplied to transportHeaders must be of type String. For information about using transportHeaders with HTTP/S requests including a description of the default Integration Server behavior, see Setting Transport Headers for HTTP/S.

For information about using transportHeaders with JMS requests including a description of the default Integration Server behavior, see Setting Transport Headers for JMS.

Document Optional. WS-Addressing-specific header fields that you want to explicitly set in the request issued by the web service connector. Integration Server uses this information to specify addressing information for a SOAP message, such as the message’s destination or where to reply to the message, without relying on transport-specific headers.

For more information about WS-Addressing, see Web Services Addressing (WS-Addressing).

String Optional. Unique identifier of the SOAP message. If no message ID is specified, Integration Server generates a unique ID.

Document Optional. The endpoint reference to which you are sending the SOAP message.

Address of the intended receiver of the message and it attributes, which includes namespaceName, localname, and their values.

Parameters that correspond to <wsa:ReferenceParameters> properties of the endpoint reference to which the message is addressed.

Document Optional. The endpoint reference that specifies the source of the SOAP message. The from input parameter includes:

Document Conditional. The endpoint reference that specifies the destination address of the response (reply) message. The replyTo input parameter includes:

Document Conditional. The endpoint reference that specifies the address to which the SOAP fault messages are routed. The faultTo input parameter includes:

String Optional. Specifies whether the recipients (the actor or role to which the header is targeted) are required to process the WS-Addressing headers. Recipients that cannot process a mandatory WS-Addressing header reject the message and return a SOAP fault.

Indicates that processing the WS-Addressing headers is required by the recipients (the actor or role to which the header is targeted).If you specify True for mustUnderstand and the SOAP node receives a header that it does not understand or cannot process, it returns a fault.

Indicates that processing the WS_Addressing headers is optional. This is the default.

String Optional. Target of the WS-Addressing headers in the SOAP message. soapRole determines the value of the role attribute of the WS-Addressing headers. The actor or role attribute specifies a URI for the recipient of WS-Addressing header entries. soapRole can be any valid URI that you specify or any of the following predefined roles.

Indicates that the recipient is the ultimate destination of the SOAP message. This is the default.

Specifies the following URI for the role attribute:

Specifies http://www.w3.org/2003/05/soap-envelope/role/none for the role attribute.

Document Optional. WS-ReliableMessaging-specific header fields that you want to explicitly set in the request issued by the web service connector. Integration Server uses this information to specify reliable messaging information for a SOAP message. For more information about WS-ReliableMessaging, see Web Services Reliable Messaging (WS-ReliableMessaging).

String Optional. Unique identifier of the SOAP message sequence.

A reliable messaging client associates a sequence key to a message sequence based on the endpoint URL to which the message sequence is directed. In cases where there are several message sequences directed to the same endpoint URL, you can specify a custom sequence key to identify each sequence. Each sequence is then uniquely identified by the endpoint URL and the user-specified sequence key.

You use the pub.soap.wsrm:createSequence service to create a new message sequence. You can specify the sequence key as the input of this service.

String Optional. Whether the message issued by the web service connector is the last message in the specified sequence key.

Specifies that the message is not the last message in the sequence. This is the default. This is the default.

Specifies that the message is the last message in the sequence.

String Optional. Specifies the message number in the message sequence. In cases where there are several message numbers in the message sequence, you can specify a custom message number.

Document Optional. Consumer response endpoint address to which the reliable message destination must send the acknowledgement. To specify the consumer response endpoint address, use the Response endpoint address template binder property of the consumer web service descriptor for which the reliable message sequence is to be created, as the address template and replace the placeholders <server> and <port> with appropriate values.

If no address is specified as acksTo, the acknowledgement messages are sent back to the replyTo address. If no address is specified as replyTo, the acknowledgement messages are sent back to the requester.

Document Document that contains the address to which the acknowledgement message is to be sent.

Document Conditional. Headers from response and request messages.

The contents of the transportInfo vary depending on the actual transport (HTTP, HTTPS or JMS) used by the connector.

transportInfo contains the following keys:

Document Conditional. Header fields from the request message. The contents of the requestHeaders document are not identical to transportHeaders used as input to the web service connector. The transport can add, remove, or alter specific headers while processing the request.

Whether or not the web service connector returns the requestHeaders parameter depends on the success or failure of the connector. In the case of failure, the point at which the failure occurs determines the presence of the requestHeaders parameter. For more information, see About Transport and Fault Information Returned by a Web Service Connector.

Document Conditional. Header fields from the response. Each key in responseHeaders represents a field (line) of the response header. Key names represent the names of header fields. The keys' values are Strings containing the values of the fields.

Whether or not the web service connector returns the responseHeaders parameter depends on the success or failure of the connector. In the case of failure, the point at which the failure occurs determines the presence of the responseHeaders parameter. For more information, see About Transport and Fault Information Returned by a Web Service Connector.

String Conditional. Status code from the request, returned by the underlying transport.

For more information about status codes and status messages returned by a web service connector, see About Transport and Fault Information Returned by a Web Service Connector.

String Conditional. Description of the status code returned by the transport.

For more information about status codes and status messages returned by a web service connector, see About Transport and Fault Information Returned by a Web Service Connector.

Document Conditional. Message addressing headers from response and request messages.

The messageAddressingInfo parameter contains the following keys:

Document Conditional. Message addressing header fields from the request message. The value of this parameter can be the values you provide while executing the web service connector, the values specified in the associated endpoint alias, or the values that Integration Server generates (for example, messageID and action).

String Conditional. Unique identifier of the SOAP message.

String Conditional. WS-Addressing action specified in the message addressing property of the SOAP message.

Document Conditional. The endpoint reference that specifies the address of the intended receiver of the SOAP message. The to endpoint reference includes:

Document Conditional. The endpoint reference that specifies the source of the SOAP message. The from endpoint reference includes:

Document Conditional. The endpoint reference that specifies the destination address of the response (reply) message. The replyTo endpoint reference includes:

Document Conditional. The endpoint reference that specifies the address to which the SOAP fault messages are routed. The faultTo endpoint reference includes:

Document Conditional. Header fields from the response.

String Conditional. Unique identifier of the SOAP message.

Document List Conditional. Contains the relation ship information to another SOAP message.

String Message ID of the related message.

String Conditional. The relationship type.

String Conditional. WS-Addressing action specified in the message addressing property of the SOAP message.

Document Conditional. The endpoint reference that specifies the address of the intended receiver of the SOAP message. The to endpoint reference includes:

Document Conditional. The endpoint reference that specifies the source of the SOAP message. The from endpoint reference includes:

Document Conditional. The endpoint reference that specifies the destination address of the response (reply) message. The replyTo endpoint reference includes:

Document Conditional. The endpoint reference that specifies the address to which the SOAP fault messages are routed. The faultTo endpoint reference includes:

Document Conditional. Reliable messaging headers from response and request messages.

The reliableMessagingInfo parameter contains the following keys:

Document Header fields from the response.

String Unique identifier of the SOAP message sequence.

Document Conditional. The retrieved fault block. The web service connector returns fault when:

Document Contains the fault code and possible subcodes.

Descriptions

String Conditional. For a SOAP fault, namespace name for the SOAP fault code. For an exception in the client side connector, namespaceName will not be returned.

String For a SOAP fault, a code that identifies the fault. For an exception in the client side connector, localName is set to Exception.

Document List Conditional. Subcodes that provide further detail. Each Document in the subCodes Document List contains:

Document List Reasons for the fault. Each Document in the Document List contains a human readable explanation of the cause of the fault.

Descriptions

String Text explaining the cause of the fault.

String Conditional. Language for the human readable description.

String URI to the SOAP node where the fault occurred.

String Conditional. Role in which the node was operating at the point the fault occurred.

Document Conditional. Application-specific details about the fault.

Document Conditional. Document containing the SOAP fault returned by the web service. A SOAP fault is returned when an error occurs during invocation of the web service operation.

String Specifies the SOAP protocol used to send messages to and receive messages from the web service host.

Messages were sent using SOAP 1.1 protocol.

Messages were sent using the SOAP 1.2 protocol.

Document Conditional. Fault information. Fault_1_1 and its child variables are populated only when a SOAP fault is returned to the web service connector and soapProtocol is SOAP 1.1 Protocol.

String Conditional. A code that identifies the fault. This field corresponds to the faultcode element in SOAP 1.1.

String Conditional. A human readable explanation of the fault. This field corresponds to the faultstring element in SOAP 1.1.

String Conditional. Information about the cause of the fault. This field corresponds to the faultactor element in SOAP 1.1.

Document Conditional. Application-specific details about the SOAP fault. This field corresponds to the detail element in SOAP 1.1.

Document Conditional. Fault information. Fault_1_2 and its child variables are populated only when a SOAP fault is returned to the web service connector and soapProtocol is SOAP 1.2 Protocol.

Document Conditional. Contains the fault code.

Document Conditional. Document containing the reason for the SOAP fault. This corresponds to the Reason element in SOAP 1.2.

String Conditional. URI to the SOAP node where the fault occurred. This field corresponds to the Node element in SOAP 1.2.

String Conditional. Role in which the node was operating at the point the fault occurred. This field corresponds to the Role element in SOAP 1.2.

Document Conditional. Application-specific details about the SOAP fault. This field corresponds to the Detail element in SOAP 1.2.