IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

Accessing broker properties from ESQL

You can access broker properties, at run time, from the ESQL modules in your message flow nodes.

You can use broker properties on the right side of regular SET statements. For example:
DECLARE mybroker CHARACTER;
SET mybroker = BrokerName;
where BrokerName is the broker property that contains the name of the broker on which the message flow is running. However, you cannot use broker properties on the left side of SET statements. This restriction exists because, at run time, broker properties are constants: they cannot be modified, therefore their values cannot be changed by SET statements. If a program tries to change the value of a broker property, the error message Cannot assign to a symbolic constant is issued.
Broker properties:
  • Are grouped by broker, integration server, flow, and node.
  • Are case sensitive. Their names always start with an uppercase letter.
  • Return NULL if they do not contain a value.

If your ESQL code already contains a variable with the same name as one of the broker properties, your variable takes precedence; that is, your variable masks the broker property. To access the broker property, use the form SQL.<broker_property_name>. For example: SQL.BrokerName.

Broker properties that are accessible from ESQL, the Mapping node, and Java shows the broker, flow, and node properties that are accessible from ESQL and indicates which properties are also accessible from Java.


ak09512_.htm | Last updated Friday, 21 July 2017