Message Service Runtime Properties for Outbound Transports

The following tables describe the Runtime Properties set when creating a message service. These runtime properties are set when defining endpoints used for a message service sending outbound messages. You can also edit these runtime properties in the Properties view of the service editor.

JMS

PropertyDescription

Non XA Queue Session Acknowledge Mode

Select one of the following:

  • AUTO_ACKNOWLEDGE - The session automatically acknowledges a client’s receipt of a message when it has either successfully returned from a call to receive or the MessageListener it has called to process the message successfully returns.

  • CLIENT_ACKNOWLEDGE - The client acknowledges a message by calling the message’s acknowledge method. Acknowledging a consumed message automatically acknowledges the receipt of all messages that have been delivered by its session.

  • DUPS_OK_ACKNOWLEDGE - This option instructs the session to lazily acknowledge the delivery of messages. If JMS fails, duplicate messages may be delivered. Use of this option can reduce session overhead because the session minimizes the work that prevents duplicates.

Non XA Queue Transacted

Select True or False

Timeout

Specify the timeout for a transaction. The default value is 3000 seconds.

XA Support

Specify if you want to support transactionality. Choose one of the following:

  • True

  • False

File

PropertyDescription

Append Message Count

Specify the number of messages to be written to a file before a new file is created. The default value is 1.

Delimiter

Required if Message Separator Mode is set to byDelimiter.

Specify the type of delimiter to use separate outbound messages. Choose from the following:

  • Default - No action is required. The inbound delimiter remains unchanged as it is passed to the outbound operation.

  • String (with Escape sequence) - Specify a nonprintable or special character as an escape character. Select String and the Use Java escape sequences checkbox.

  • Binary - Specify a special character using the format 0xXXXX, where X is a hexadecimal value. The value range is 0x0000 to 0xFFFF.

Encoding

Specify the encoding of the specified attributes, such as File Header/Footer and Message Header/Footer, excluding the embedded XML message content.

File Footer

Specify the constant string used to end every file.

File Header

Specify the constant string used to begin every file.

File Name Part

Specify the outbound file name prefix.

For FTP, multi-byte characters are not supported for this property.

Fixed Length

Specify the maximum length of the message. Required when the following Message Separator Modes are set:

  • byFixedLengthInBytes

  • byFixedLengthInChars

Maximum File Size

Limit the output file size.

When the Maximum File Size is reached, the file service does not append any more messages. At least one message is output to a file regardless of the designated Maximum File Size. If Append Message Count is set to a value greater than 1 and is reached first, however, the file service stops appending messages before Maximum File Size is reached.

Message Footer

Specify the constant string to be used after each message.

Message Header

Specify the constant string to be used before each message.

Message Separator Mode

Choose one of the following:

  • byDelimiter: Separates messages by delimiter; use with the Delimiter property

  • byFixedLengthInBytes: reserves x bytes for each message, where x is set by the Fixed Length property

  • byFixedLengthInChars: reserves x characters for each message, where x is set by the Fixed Length property

Padding Byte

Specify the byte to be used to fill the remaining reserved space when byFixedLengthInBytes property is set.

Padding Char

Specify the character to be used to fill the remaining reserved space when byFixedLengthInChars property is set.

FTP

PropertyDescription

Append Message Count

Specify the number of messages to be written to a file before a new file is created. The default value is 1.

Delimiter

Required if Message Separator Mode is set to byDelimiter.

Specify the type of delimiter to use separate outbound messages. Choose from the following:

  • Default - No action is required. The inbound delimiter remains unchanged as it is passed to the outbound operation.

  • String (with Escape sequence) - Specify a nonprintable or special character as an escape character. Select String and the Use Java escape sequences checkbox.

  • Binary - Specify a special character using the format 0xXXXX, where X is a hexadecimal value. The value range is 0x0000 to 0xFFFF.

Encoding

Specify the encoding of the specified attributes, such as File Header/Footer and Message Header/Footer, excluding the embedded XML message content.

File Directory

Specify the output directory in single-byte characters. Multi-byte characters are not supported for this property.

File Footer

Specify the constant string used to end every file.

File Header

Specify the constant string used to begin every file.

File Name Part

Specify the outbound file name prefix.

For FTP, multi-byte characters are not supported for this property.

Fixed Length

Specify the maximum length of the message. Required when the following Message Separator Modes are set:

  • byFixedLengthInBytes

  • byFixedLengthInChars

Maximum File Size

Limit the output file size.

When the Maximum File Size is reached, the file service does not append any more messages. At least one message is output to a file regardless of the designated Maximum File Size. If Append Message Count is set to a value greater than 1 and is reached first, however, the file service stops appending messages before Maximum File Size is reached.

Message Footer

Specify the constant string to be used after each message.

Message Header

Specify the constant string to be used before each message.

Message Separator Mode

Choose one of the following:

  • byDelimiter: Separates messages by delimiter; use with the Delimiter property

  • byFixedLengthInBytes: reserves x bytes for each message, where x is set by the Fixed Length property

  • byFixedLengthInChars: reserves x characters for each message, where x is set by the Fixed Length property

Mode

Specify the transfer mode. Choose one of the following:

  • ASCII

  • Binary

Padding Byte

Specify the byte to be used to fill the remaining reserved space when byFixedLengthInBytes property is set.

Padding Char

Specify the character to be used to fill the remaining reserved space when byFixedLengthInChars property is set.

Email

PropertyDescription

Close Connection after Operation

Select True or False.

XA Support

Select True or False.

Send your feedback on this help topic to Sybase Tech Pubs: pubs@sybase.com