WebSphere Message Brokers
File: ac20815_
Writer: Terry Cowling

Reference topic

This build: July 31, 2007 21:19:31

Timeout request message

The XML format of a timeout request message is specified below. Any other format that is supported by an installed parser can be used instead of XML.
<TimeoutRequest>
  <Action>SET | CANCEL</Action>
  <Identifier>String (any alphanumeric string)</Identifier>
  <StartDate>String (TODAY | yyyy-mm-dd)</StartDate>
  <StartTime>String (NOW | hh:mm:ss)</StartTime>
  <Interval>Integer (seconds)</Interval>
  <Count>Integer (greater than 0 or -1)</Count>
  <IgnoreMissed>TRUE | FALSE</IgnoreMissed>
  <AllowOverwrite>TRUE | FALSE</AllowOverwrite>
</TimeoutRequest>
Action
This element must be set to either SET or CANCEL. It is an error to omit this element or to set a different value. If CANCEL is set, the only other element that is required is the Identifier, which must match the Identifier of the TimeoutRequest that is to be cancelled.
Identifier
This can be any alphanumeric string. It is an error to omit this element.
StartDate
This element must be set to TODAY or to a date specified in yyyy-mm-dd format. The default value is TODAY.
StartTime
This element must be set to NOW or to a time specified in hh:mm:ss format. The default value is NOW. StartTime is assumed to be the broker's local time.
Interval
This is an integer that specifies the number of seconds between propagations of the message. The default value is 0.
Count
This must be an integer that is either greater than 0 or is -1 (which specifies a timeout request that never expires). The default value is 1.
IgnoreMissed
This controls whether timeouts that occur while either the broker or the timeout notification flow is stopped, are processed the next time that the broker or timeout notification flow is started. The default value is TRUE which means that missed timeouts are ignored by the TimeoutNotification node when the broker or message flow is started. If this value is set to FALSE then the missed timeouts are all immediately processed by the Timeout Notification node when the flow is started.

Note that the Request Persistence property of the TimeoutControl node must be set to Yes or Automatic (with the originating request message being persistent) for the stored timeouts to persist beyond the restart of the broker or the timeout notification flow.

AllowOverwrite
This controls whether subsequent timeout requests with a matching Identifier can overwrite this timeout request. The default value is TRUE.
Note: A predefined schema definition of the timeout request is provided in the broker toolkit. Take the following steps to review the definition or define it within a message set:
  1. Create or select a message set project that contains the message set.
  2. Create a new message definition file.
  3. Select IBM supplied message.
  4. Select next, expand the tree, and select 6.0.0\ibm\nodes\timeout\timeoutrequest.xsd.
Related concepts
Configuring timeout flows
Related reference
TimeoutControl node
TimeoutNotification node
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2007Copyright IBM Corporation 1999, 2007. All Rights Reserved.
This build: July 31, 2007 21:19:31

ac20815_ This topic's URL is: