Integration node properties

For each integration node, IBM® Integration Bus maintains a set of properties. You can access some of these properties from your ESQL programs. You can also access integration node properties from a Mapping node. A subset of the properties is also accessible from Java™ programs. It can be useful, at run time, to have real-time access to details of a specific node, flow, or integration node.

Integration node properties are divided into four categories:
  • Properties that relate to a specific node
  • Properties that relate to nodes in general
  • Properties that relate to a message flow
  • Properties that relate to the integration server

For a description of the integration node, flow, and node properties that are accessible from ESQL and Java, see Integration node properties that are accessible from ESQL, the Mapping node, and Java.

For a description of the integration node properties that are accessible from a Mapping node, see Accessing integration node properties from a Mapping node.

Integration node properties have the following characteristics.
  • They are grouped by integration node, integration server, flow, and node.
  • They are case-sensitive. Their names always start with an uppercase letter.
  • They return NULL if they do not contain a value.
All nodes for which user programs can edit ESQL support access to integration node properties. These nodes are:
  • Compute nodes
  • Database nodes
  • DatabaseInput nodes
  • Filter nodes
  • All derivatives of these nodes

User-defined properties can be queried, discovered, and set at run time to dynamically change the behavior of a message flow. You can use the IBM Integration API to manipulate these properties, which can be used by a systems monitoring tool to perform automated actions in response to situations that it detects in the monitored systems. For more information, see User-defined properties.

A complex property is a property to which you can assign multiple values. Complex properties are displayed in a table in the Properties view, where you can add, edit, and delete values, and change the order of the values in the table. You cannot promote complex properties; therefore, they are not shown in the Promote properties dialog box. Nor can you configure complex properties; therefore, they are not supported in the BAR editor. For an example of a complex property, see the Query elements property of the DatabaseRoute node.

For more information about editing the properties of a node, see Configuring a message flow node.