protocol | String Name of protocol about which transportInfo contains information. Will be one of the following values | ||
A value of... | Indicates that... | ||
email | SMTP was used to invoke the service. Detailed information is contained in the email parameter. | ||
filePolling | File polling protocol was used to invoke this service. Detailed information is contained in the filePolling parameter. | ||
ftp | FTP was used to invoke the service. Detailed information is contained in the ftp parameter. | ||
http | HTTP was used to invoke the service. Detailed information is contained in the http parameter. | ||
jms | JMS was used to invoke the service. When a standard JMS trigger or a SOAP-JMS trigger invokes a service, the protocol is JMS. Detailed information is contained in the jms parameter. | ||
messaging | webMethods messaging was used to invoke the service. Specifically, a webMethods messaging trigger invoked the service. Detailed information is contained in the messaging parameter. | ||
subprotocol | String. Conditional. Subprotocol used to invoke the service. | ||
A value of... | Indicates that... | ||
broker | The service was invoked by a webMethods messaging trigger that received a document from the Broker or a locally published document. This subprotocol can only occur if protocol is messaging. | ||
HTTP | The service was invoked through HTTP. This subprotocol can only occur if protocol is http. | ||
HTTPS | The service was invoked through HTTPS. This subprotocol can only occur if protocol is http. | ||
jndi | Integration Server uses JNDI to connect to the JMS provider. The JMS connection alias assigned to the JMS trigger specifies how Integration Server connects to the JMS provider. A value of jndi also indicates that the jms/destinationName value is a lookup name. This subprotocol can only occur if protocol is jms. | ||
native | Integration Server uses the native webMethods API to connect to the webMethods Broker being used as the JMS provider directly. The JMS connection alias assigned to the JMS trigger specifies how Integration Server connects to the JMS provider. A value of native also indicates that the jms/destinationName value is the name of the actual destination. This subprotocol can only occur if protocol is jms. | ||
um | The service was invoked by a webMethods messaging trigger that received a document from the Universal Messaging. This subprotocol can only occur if protocol is messaging. | ||
The subprotocol parameter is returned only when the returned protocol is http, jms, or messaging. | |||
email | Document. Conditional. Information about the SMTP transport. This parameter is returned only if the service was invoked via SMTP. | ||
Key | Description | ||
to | String List E-mail addresses for the recipients of the e-mail. | ||
from | String List E-mail addresses for the senders of the e-mail. | ||
cc | String List. Conditional. E-mail addresses receiving a copy of the e-mail. | ||
bcc | String List. Conditional. E-mail addresses receiving a blind copy of the e-mail. | ||
replyto | String List. Conditional. E-mail address to which replies of this e-mail should be sent | ||
subject | String Subject of the e-mail. | ||
filename | String. Conditional. Name of the attached file. | ||
contenttype | String. Conditional. Content-Type of the attached file. | ||
content | java.io.InputStream. Conditional. Contents of the attached file. | ||
recvdate | String. Conditional. Date the e-mail was received in String format. recvdate may be passed as parameter for the java.util.Date constructor. | ||
sentdate | String. Conditional. Date the e-mail was sent in String format. sentdate may be passed as parameter for the java.util.Date constructor. | ||
http | Document. Conditional. Information about the http transport. This parameter is returned only if the service was invoked via http. | ||
Key | Description | ||
requestUrl | String URL used by the client to invoke the service. | ||
query | String. Conditional. Query portion of request URL. | ||
method | String HTTP method used by the client to request the top-level service. Possible values are GET, PUT, POST, PATCH, and DELETE. | ||
requestHdrs | Document Fields in the request header, where key names represent header field names and values represent the header field values. | ||
ipInfo | Document Information about the http socket connection. Contains the following information: | ||
Key | Description | ||
clientIp | String. Optional. IP address of the client connecting to this socket. If null, clientIP is not included in the output. | ||
clientPort | String. Optional. Port number used by the client connecting to this socket. If null, clientPort is not included in the output. | ||
localIp | String Local IP address for this socket connection to client. | ||
localPort | String Local port number for this socket connection to client. | ||
remoteIp | String Remote IP address for this socket connection to client. | ||
remotePort | String Remote port number for this socket connection to client. | ||
ftp | Document. Conditional. Information about the ftp transport. This parameter is returned only if the ftp transport invoked the service. | ||
Key | Description | ||
filename | String Name of file that was put into the service directory. | ||
mimetype | String. Conditional. Content type of the file (for example, text/xml, text/plain, or image/jpeg). The server determines content type based on the extension of the file and the extension's corresponding content type defined in Integration Server_directory \instances\instance_name\lib\mime.types. | ||
ipInfo | Document Information about the FTP socket connection. Contains the following information: | ||
Key | Description | ||
localIp | String Local IP address for this socket connection to client. | ||
localPort | String Local port number for this socket connection to client. | ||
remoteIp | String Remote IP address for this socket connection to client. | ||
remotePort | String Remote port number for this socket connection to client. | ||
filePolling | Document. Conditional. Information about the file polling transport. Returned only if the file polling transport invoked the service. | ||
Key | Description | ||
filename | String Fully qualified name of the file submitted to the file polling listener. | ||
originalFilename | String Name of the file when it was submitted to the file polling listener. | ||
contenttype | String. Conditional. Content type of the file (for example, text/xml, text/plain, or image/jpeg). The server determines content type based on the extension of the file and the extension's corresponding content type defined in Integration Server_directory \instances\instance_name\lib\mime.types. | ||
length | String The original file length in bytes. | ||
lastModified | java.util.Date Java date object indicating when the original file was last modified. | ||
jms | Document. Conditional. Information about the JMS transport. This parameter is returned only if the JMS transport invoked the service. | ||
Key | Description | ||
connectionAliasName | String Name of the JMS connection alias used by the JMS trigger to retrieve the message. | ||
triggerName | String Fully qualified name of the JMS trigger that retrieved the JMS message that resulted in invocation of the service. | ||
destinationName | String Name or lookup name of the destination from which the message that invoke the service was received. When the subprotocol is jndi, the destinationName value is the lookup name of the destination on the JNDI provider. When the subprotocol is native, the destinationName value is the name of the destination at the webMethods Broker. | ||
destinationType | String Type of destination from which the JMS trigger received the message. The destination type for the JMS trigger specified in triggerName subscribes determines the destinationType value. destinationType will be one of the following: QUEUE indicates the destination is a queue. TOPIC indicates the destination is a topic. | ||
requestHdrs | Document Fields in the request header of the JMS message, where key names represent header field names and values represent header field values. The requestHdrs includes all of the JMS message headers and JMS message properties. When a SOAP-JMS trigger receives a message, Integration Server passes the body of the message to the web services stack for processing. The body of the JMS message is the SOAP message. Integration Server does not pass the JMS headers on to the web services stack. If you want to review the contents of the JMS request header, you must use pub.flow:getTransportInfo to obtain the headers. For a standard JMS trigger, Integration Server passes the entire JMS message, including request headers, on to the trigger service for processing. | ||
messaging | Document. Conditional. Information about the messaging transport. This parameter is returned only if the messaging transport invoked the service. | ||
connectionAliasName | String Name of the webMethodsmessaging connection alias used by the webMethods messaging trigger to retrieve the document. If the webMethods messaging trigger received a locally published document and the publishable document type is not associated with a messaging connection alias, the connectionAliasName field is blank. | ||
triggerName | String Fully qualified name of the webMethods messaging triggerthat retrieved the document that resulted in invocation of the service. | ||
documentTypeName | String Fully qualified name of the publishable document type for which the received document is an instance. If the trigger services executes because an AND join condition in the webMethods messaging trigger was satisfied, the documentTypeName contains the name of the publishable document type that completed the AND join. For example, suppose that an AND join condition specifies folder.subfolder:documentA and folder.subfolder:documentB. If the trigger receives an instance of documentB first and then an instance of documentA, the documentTypeName parameter contains folder.subfolder:documentA. | ||
redeliveryCount | String Number of times the messaging provider has redelivered the document to the trigger. | ||
A value of... | Indicates... | ||
-1 | The transport used to send the document does not maintain a document redelivery count. For example, a document received from a webMethods Broker version 6.0.1 has a redelivery count of -1. (webMethods Brokers that are version 6.0.1 or earlier do not maintain document redelivery counts.) Integration Server may or may not have received the document before. | ||
0 | The document has been received only once. | ||
> 0 | The number of times document has been redelivered. |