wm.tn.delivery:deliver
Delivers a document to a partner in the trading network.
Input Parameters
serviceName | String The name associated with the delivery service to use to deliver the document. (This is not the fully-qualified name of the service. It is the name that was associated with the delivery service when it was registered.) |
bizdoc | Document The document you want to deliver. If invoking from a Java program, the document must be an instance of com.wm.app.tn.doc.BizDocEnvelope. Otherwise, bizdoc must be in the structure of
wm.tn.rec:BizDocEnvelope. |
ttw | String (optional) If the delivery fails, the number of milliseconds you want the task engine to wait before making its first attempt to redeliver the document. (The task engine uses ttw along with retryFactor to calculate how long to wait for subsequent retry attempts.) |
retryLimit | String (optional) If the first attempt to deliver the document fails, the number of additional attempts to retry delivering the document. |
retryFactor | String (optional) The factor you want task engine to use when determining how long to wait before making the second and subsequent attempts to redeliver the document. The task engine calculates the time to wait by multiplying the last wait time by retryFactor. Specify a whole number greater than zero for retryFactor. |
username | String (optional) The user name to use when connecting to a partner's server to delivery the bizdoc. If you do not specify username, this service uses the user name specified in the partner's profile. |
password | String (optional) The password (which is associated with username) to use when connecting to a partner's server to delivery the bizdoc. If you do not specify username, this service uses the user name specified in the partner's profile. |
Output Parameters
deliveryID | String Deprecated. A unique ID that the task engine generates for the delivery task. This output parameter has been deprecated. Use taskId instead. |
taskId | String A unique ID that the task engine generates for the delivery task. |
serviceOutput | Document (optional) The output that the delivery service returned. The document contains the following keys:  status - String The outcome of the delivery, either success or fail. statusMessage - String The status message from the last attempt to deliver the document. For example, if the document is being delivered using HTTP, the status message may be 200 OK. output - Document The output that the delivery service returned. transportTime - String Total time for transporting the document by the delivery service. The transportTime is specified in milliseconds. |
Usage Notes
This service uses the profile of the receiving partner identified in the bizdoc to determine
ttw, retryLimit, and
retryFactor. If you supply these values in the service input, the values you provide override settings specified in the receiving partner's profile.
If the document is
not saved to the
Trading Networks database, the task engine is bypassed and
Delivery Folder attempts to deliver the document only a single time. In this situation, the
ttw and
retryLimit values are not used. The output value
serviceOutput contains the output of the single attempt to deliver the document. Otherwise, the service returns no output; instead use
wm.tn.task:getTaskOutput.
For backwards compatibility, the output for this service variable
deliveryId contains the unique ID for the delivery task; that is, the same value that is returned in the
taskId variable.