SendProtocolMessage Parameters and Valid Execution Modes
The valid execution mode for SendProtocolMessage is SYNCHR or ASYNCHR.
The parameters of SendProtocolMessage are as follows:
| Name | Semantics | Type | Valid Values | Multi– plicity |
|---|---|---|---|---|
| Direction: In | ||||
| Address (Optional) | Receiver GLN. | arraylist | 0..1 | |
| BizProtocol (Mandatory) | The business protocol to be used for communication. | string | JMS: for communicating with backend systems, EAI products and between multiple TIBCO MDM instances. INTERNAL_TRANSPORT: For communicating between two enterprises in the same instance of TIBCO MDM. |
1 |
| Channel Credential (Optional) | Receiver GLN. | string | 0..1 | |
| Channel Organization Name (Optional) | Name of the Receiver Organization. | string | 0..1 | |
| Conversation Key (Optional) | Conversation ID. | string | 0..1 | |
| ExpiryDate (Optional) | Relative or absolute time within which the response to this message needs to be received. If not received, this step will cause a timeout event which can be handled in the workflow as in the outgoing transitions of this activity to do any exception processing. | string | See ExpiryType. | 0..1 |
| ExpiryType (Optional) | The type of expiry date. | string | RELATIVE or ABSOLUTE. In the first case, time is specified as ‘DD:hh:mm:ss’, and in the second as ‘MM:DD:hh:mm:ss’ where MM is month, DD is day, hh is hour, mm is minute, and ss is second. | 0..1 |
| InDocument | See Common Parameters. | |||
| InDocument2 | The MLXML document on which the InDocument was formed. | document | 0..1 | |
| MessageID# (Optional) | MessageID for the outgoing message. MessageID is required if you want the application to suspend after the send. Replace # with an integer, for example, MessageID1, MessageID2. | string | 0..1 | |
| PayloadPackagingScheme (Optional) | Determines the type of packaging to be used around the payload. The value is not used by code, but maps to a marshaling pipeline that packages the payload using the configured marshalers. | string | String. Currently only one value is supported: STANDARD_INTEGRATIONThis packages the payload into an ebXML/SOAP envelope. |
0..1 |
| ReceiverCredential (Optional) | The receiver GLN the activity uses while sending the document. | string | Valid credentials. | 0..1 |
| Receiver Organization Name (Optional) | Name of the Receiver organization as given in the ‘marketplace profiles’. For example, ‘1SyncTest’. Required if Channel Credential is not supplied. | string | 0..1 | |
| SenderCredential (Optional) | The sender GLN the activity uses while sending the document. | string | Valid credentials. | 0..1 |
| TrackMessage Response (Optional) | Flag to tell the activity if it should track the outgoing message. This allows you to set time-outs on message processing/receiving responses. | boolean | True (Default) False |
0..1 |
| Generate
CommEvent
(Optional) (applicable since version 7.1) |
Flag to indicate whether to generate an internal communication event. If not specified (default is false), no communication event will be generated. If specified as True, a communication event will be generated. | boolean | True False (Default) |
0..1 |
| DefaultDomain (Optional) | Specifies the domain the credentials belong to. | string | Valid domain | |
| SaveCached Document (Optional) | Useful only when document caching is enabled. Persists documents to disk by default (when set to true). | boolean | True (default) False |
|
| Direction: Out | ||||
| OutDocument (Optional) | See Common Parameters. The response document could be protocol specific. |
|||
Copyright © Cloud Software Group, Inc. All rights reserved.