skip to main content
OpenEdge Development: ADM Reference
Messaging Objects and Their Methods and Properties : Message object properties
 
Message object properties
Messaging Object properties provide information about messaging objects and their classes. This information can include whether an object is enabled, the contents of the object and so on. You can read property values and in many instances you can change property values. To read a value for a property, you use a get function and to change a value for a property, you use a set function.
These functions conform to the following conventions:
*get — Uses the form getpropname and returns the current value of the property. This function accepts no arguments.
*set — Uses the form setpropname. The set function accepts a single argument—the new value for the property—and returns TRUE/FALSE depending on whether the value change succeeds.
For more information about getting and setting property values, see Chapter 1, “ADM2 SmartObject API Reference.”
ClientID
Property that stores the Client ID for the JMS broker connection. This property value is used during creation of the JMS session to set the ClientID of the JMS session. It should only be set before initialization of the messaging object.
Data type: CHARACTER
Note: Read and Write.
ConsumerSchema
XML Schema filename.
Data type: CHARACTER
Note: Read only.
ContextForServer
Value for gcContextForServer.
Data type: LOGICAL
Note: Write only.
CurrentMessage
Property that stores the handle of the current message being produced. This property is set when the message is created by the producer's sendMessage, it should not be set in any other way. The handle of the message is sent to the send handler, therefore in most circumstances, it should not be necessary to get this handle for use in application code.
Data type: HANDLE
Note: Read and Write.
CurrentMessageId
ID from the previous sendMessage where ReplyRequired.
Data type: CHARACTER
Note: Read and Write.
Destination
Property that stores the destination of the message being sent. This would usually be set by the instance properties of the message handling object (SmartB2BObject or SmartSender) that is sending the message. It could be set after initialization of the object before the message is sent.
Data type: CHARACTER
Note: Read and Write.
DestinationList
Value of DestinationList.
Data type: CHARACTER
Note: Read and Write.
Destinations
Property that stores a CHR(1) delimited list of destinations from which a SmartConsumer object can receive messages. This property is set from the instance properties of the object and used during initialization of the object to create message consumers for each destination.
Data type: CHARACTER
Note: Read and Write.
DirectionList
Value of DirectionList.
Data type: CHARACTER
Note: Read and Write.
DocumentElement
ID of the root element.
Data type: DECIMAL
Note: Read only.
DocumentHandle
Property that stores the XML document handle.
Data type: HANDLE
Note: Read and Write.
DocumentInitialized
Determines if the document is initialized. For example, it has a root node.
Data type: LOGICAL
Note: Read only.
Domain
Property that stores the messaging domain (Publish and Subscribe or Point-to-Point) for the SmartProducer and SmartConsumer messaging objects to determine how the JMS session is started for the object. This property can only be set before initialization of the messaging object and cannot be changed once the object is initialized.
Data type: CHARACTER
Note: Read and Write.
DTDPublicId
DTDPublicId property of the Document.
Data type: CHARACTER
Note: Read and Write.
DTDPublicIdList
CHR(1)- separated list of DTD Public Ids for producer.
Data type: CHARACTER
Note: Read and Write.
DTDSystemID
DTDSystemId property of the Document.
Data type: CHARACTER
Note: Read and Write.
DTDSystemIdList
CHR(1)-separated list of DTD System Ids for producer.
Data type: CHARACTER
Note: Read and Write.
ExternalRefList
List of external references this router uses to determine how external target namespaces map to internal XML mapping schemas.
Data type: CHARACTER
Note: Read and Write.
InMessageSource
Handle that accesses the source of a message.
Data type: HANDLE
Note: Read and Write.
InternalRefList
Comma-separated list. You can change this list by calling modifyListAttribute.
Data type: CHARACTER
Note: Read and Write.
JMSpartition
Value of JMSpartition.
Data type: CHARACTER
Note: Read and Write.
JMSpassword
Property that stores the password for the JMS broker connection for messaging objects (SmartProducer and SmartConsumer objects).
Data type: CHARACTER
Notes:  
*Read and Write.
*This property must be set before initialization objects because it must be set in the JMS session before the JMS session begins.
JMSsession
Handle of the JMS session this instance is using.
Data type: CHARACTER
Note: Write only.
JMSuser
Property that stores the user for the JMS broker connection for messaging objects (SmartProducer and SmartConsumer objects).
Data type: CHARACTER
Notes:  
*Read and Write.
*This property must be set before initialization objects because it must be set in the JMS session before the JMS session begins.
LoadedByRouter
Determines whether or not the XML and Schema have already been loaded by the router. If TRUE, the XML and Schema have already been loaded.
Data type: LOGICAL
Note: Read and Write.
LogFile
Property that stores the name of the log file written to for a SmartConsumer object running in batch. This should be set before initialization of the object.
Data type: CHARACTER
Note: Read and Write.
MapNameProducer
Value of MapNameProducer.
Data type: CHARACTER
Note: Read and Write.
MapObjectProducer
Value of MapObjectProducer.
Data type: CHARACTER
Note: Read and Write.
MapTypeProducer
Value of MapTypeProducer.
Data type: CHARACTER
Note: Read and Write.
MessageType
Identifies the type of message being sent.
Data type: CHARACTER
Note: Read and Write.
NameList
Value of NameList.
Data type: CHARACTER
Note: Read and Write.
NameSpaceHandle
Handle of the loaded XML mapping schema namespaces.
Data type: HANDLE
Note: Write only.
NewNode
Identifies the next unused node number in sequence.
Data type: DECIMAL
Notes:  
*Read only.
*Returns TRUE if the current RowObject record is in new mode. Returns the Unknown value (?) if there is no current RowObject.
*Returns TRUE if the matching contained SDO is in NewMode. This is the SBO version of getNewMode.
OutMessageSource
Property that stores the handle of the OUTMESSAGE-SOURCE object (SmartSender or SmartB2Bobject) of a SmartProducer object. This is set during creation of the SmartProducer object and should not be set by application code.
Data type: HANDLE
Note: Read and Write.
Persistency
Property that stores the persistency for messages sent in a SmartProducer's object's session. This property is initially set during initialization based on instance property values but can be set at any time to affect any messages sent after it is set.
Data type: CHARACTER
Note: Read and Write.
PingInterval
Value of the ping interval for the session.
Data type: INTEGER
Note: Read and Write.
Priority
Property that stores the priority for messages sent in a SmartProducer's object's session. This property is initially set during initialization based on instance property values but can be set at any time to affect any messages sent after it is set.
Data type: INTEGER
Note: Read and Write.
PromptLogin
Determines whether or not the producer, consumer, or both prompts the user for the JMS broker login.
Data type: LOGICAL
Note: Read and Write.
ReplyReqList
Value of ReplyReqList.
Data type: CHARACTER
Note: Read and Write.
ReplyRequired
Property that stores a value that determines whether a reply is required for a message being sent for a message handling object (SmartB2BObject acting as a producer or SmartSender). This property is initially set during initialization based on instance property values but can be set at any time to affect messages sent after it is set.
Data type: LOGICAL
Note: Read and Write.
ReplySelector
Property that stores a reply selector value to be used for messages that require replies that are being sent for a message handling object (SmartB2Bobject or SmartSender).
Data type: CHARACTER
Note: Read and Write.
ReplySelectorList
Value of ReplySelectorList.
Data type: CHARACTER
Note: Read and Write.
RouterSource
Property that stores the handle(s) of the ROUTER-SOURCE objects for a SmartRouter object.
Data type: CHARACTER
Note: Read and Write.
SchemaHandle
Handle of the loaded XML mapping schema.
Data type: HANDLE
Note: Read and Write.
SchemaList
List of the schema this B2B uses.
Data type: CHARACTER
Note: Read and Write.
SchemaManager
Starts the schema manager, if necessary, and returns its procedure handle.
Data type: HANDLE
Note: Read only.
Selectors
Represents the message selectors used when receiving messages.
Data type: CHARACTER
Note: Read and Write.
ShutDownDest
Queue to which a message can be sent to shut down a SmartConsumer running unattended.
Data type: CHARACTER
Note: Read and Write.
Subscriptions
Represents the information this consumer uses when subscribing to topics (only for Pub/Sub domain).
Data type: CHARACTER
Note: Read and Write.
SupportedMessageTypes
Property that stores the Sonic Adapter supported message types. It is used by the SmartProducer's instance property dialog to provide a combo-box of supported messages types used to choose the message type to be stored in the MessageType property for that object.
Data type: CHARACTER
Note: Read only.
TargetNameSpace
Defines the XMLNS attribute of the document instance.
Data type: CHARACTER
Note: Read only.
TimeToLive
Represents the time during which the message is considered current and not stale.
Data type: DECIMAL
Note: Read and Write.
TypeName
Identifies the documentation, destination, or both for multi-document producers.
Data type: CHARACTER
Note: Read and Write.
UseDTD
Determines whether or not to use DTD. TRUE, if DTD is to be used.
Data type: LOGICAL
Note: Read only.
ValidateOnLoad
Determines whether or not the document should be validated on load.
Data type: LOGICAL
Note: Read and Write.
Waiting
Determines how long the adapter waits for a message.
Data type: LOGICAL
Note: Read and Write.