The TimeoutControl node receives an input message that contains a timeout request.
This topic contains the following sections:
The TimeoutControl node validates the timeout request message, stores the message, and propagates the message (unchanged) to the next node in the message flow. For more information, see Timeout request message.
The TimeoutControl node is contained in the Timer drawer of the palette, and is represented in the workbench by the following icon:
Use a TimeoutControl node and a TimeoutNotification node together in a message flow for an application that requires events to occur at particular times, or at regular intervals.
More than one TimeoutControl node can be used with a TimeoutNotification node. Timeout requests that are processed by those TimeoutControl nodes are all processed by the same TimeoutNotification node if the same Unique Identifier is used for the TimeoutNotification node and each of the TimeoutControl nodes.
When you have put an instance of the TimeoutControl node into a message flow, you can configure it; see Configuring a message flow node. The properties of the node are displayed in the Properties view.
Leave Message Set blank for XML, XMLNS, XMLNSC, JMS, MIME, and BLOB parsers.
Leave Message Type blank for XML, XMLNS, XMLNSC, JMS, IDOC, MIME, and BLOB parsers.
Leave Message Format blank for XML, XMLNS, XMLNSC, JMS, MIME, and BLOB parsers.
The TimeoutControl node terminals are described in the following table.
Terminal | Description |
---|---|
In | The input terminal that accepts a message tree for processing (which includes validating the timeout request specified in the message tree at Request Location) and adds it to the control queue. |
Failure | The output terminal to which the input message is propagated if a failure is detected during processing in this node. If this terminal is not connected to another node, error information is passed back to the previous node in the message flow. |
Out | The output terminal to which incoming messages are propagated, unchanged, after successful timeout request processing. If this terminal is not connected to another node, no propagation occurs. If propagation of the message fails, the message is propagated to the Failure terminal. |
The following tables describe the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the bar file to deploy it).
The Description properties of the TimeoutControl node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | The node type, TimeoutControl | The name of the node. |
Short Description | No | No | A brief description of the node. | |
Long Description | No | No | Text that describes the purpose of the node in the message flow. |
The Basic properties of the TimeoutControl node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Unique Identifier | Yes | Yes | None | This is the only mandatory property for the node. Its value must be unique within the broker. The equivalent property of the TimeoutNotification node with which it is paired must have the same value. The maximum length of this identifier is 12 characters. |
Request Location | No | No | None | This property describes where to find the timeout request information. This value must be a valid location in the message tree and is validated at run time. If no request location is specified, LocalEnvironment.TimeoutRequest is assumed. For more information about the timeout request message, see Timeout request message. |
Request Persistence | No | No | Automatic | This property controls whether an incoming timeout request survives a broker or message flow restart. Valid values are Automatic, Yes, or No. If the value is Automatic, the Persistence setting in the Properties folder of the incoming message is used. |
The Message properties of the TimeoutControl node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Stored Message Location | No | No | None | The location of the part of the request message that you want to store for propagation by the TimeoutNotification node with which this node is paired. |
Message Domain | No | No | None | The domain that is used to parse the stored timeout request message by the TimeoutNotification node. |
Message Set | No | No | None | The name or identifier of the message set in which the stored timeout request message is defined. |
Message Type | No | No | None | The name of the stored timeout request message. |
Message Format | No | No | None | The name of the physical format of the stored timeout request message. |