Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 2 Messages : Properties

Properties
Properties associate an extensible set of property field names with values. The EMS server uses properties to attach ancillary information to messages.
Client applications can also use properties—for example, to customize message filtering; see Message Selectors.
Setting Message Properties
Property names must conform to the syntax for message selector identifiers; see Identifiers.
Property values cannot be null or an empty string.
Sending programs can set property values before sending a message.
Receiving programs cannot ordinarily set property values on inbound messages. However, tibemsMsg_ClearProperties removes all existing the properties from a message, and lets the program set property values.
EMS Properties
The JMS specification reserves the property name prefix JMS_vendor_name_ for provider-specific properties (for EMS, this prefix is JMS_TIBCO_). Properties that begin with this prefix refer to features of EMS; client programs may use these properties to access those features, but not for communicating application-specific information among client programs.
 
Producers can set this property to true to indicate that a message uses EMS extensions to the JMS specification for messages.
The server sets this property to true when importing a message from an external message service, since the message might use those extensions.
When the property value is null, the trace output contains the message ID and sequence number.
When the property value is body, the trace output includes the message body as well.
When this property is true, the server preserves a record of undeliverable messages by delivering them to the undelivered message queue, $sys.undelivered.
The EMS server fills this property with the user name (string) of the client that sent the message. This feature applies only when the sender_name property of the message’s destination is non-null. The sender can disable this feature (overriding the destination property sender_name) by setting a non-null value for the message property JMS_TIBCO_DISABLE_SENDER.
COBOL Constants
01 TIBEMS-PROPERTIES.
05 JMS-TIBCO-CM-PUBLISHER PIC X(23) VALUE
Z'JMS_TIBCO_CM_PUBLISHER'.
05 JMS-TIBCO-CM-SEQUENCE PIC X(22) VALUE
Z'JMS_TIBCO_CM_SEQUENCE'.
05 JMS-TIBCO-COMPRESS PIC X(19) VALUE
Z'JMS_TIBCO_COMPRESS'.
05 JMS-TIBCO-DISABLE-SENDER PIC X(25) VALUE
Z'JMS_TIBCO_DISABLE_SENDER'.
05 JMS-TIBCO-IMPORTED PIC X(19) VALUE
Z'JMS_TIBCO_IMPORTED'.
05 JMS-TIBCO-MSG-EXT PIC X(19) VALUE
Z'JMS_TIBCO_MSG_EXT'.
05 JMS-TIBCO-MSG-TRACE PIC X(20) VALUE
Z'JMS_TIBCO_MSG_TRACE'.
05 JMS-TIBCO-PRESERVE-UNDELIVERED PIC X(31) VALUE
Z'JMS_TIBCO_PRESERVE_UNDELIVERED'.
05 JMS-TIBCO-SENDER PIC X(17) VALUE
Z'JMS_TIBCO_SENDER'.
05 JMS-TIBCO-SS-SENDER PIC X(20) VALUE
Z'JMS_TIBCO_SS_SENDER'.
JMS Properties
The JMS specification reserves the property name prefix JMSX for properties defined by JMS. Client programs may use these properties to access those features, but not for communicating application-specific information among client programs.
For information about these properties, see the JMS specification.

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved