Integration node properties that are accessible from ESQL, the Mapping node, and Java
You can access integration node, message flow, and node properties from ESQL and Java™.
Integration node properties accessible through the Mapping node
The following table shows the properties that are available through the Mapping node:
ESQL Property name | Mapping node function | Description |
---|---|---|
Integration node name (Character): BrokerName | iib:getBrokerName() | The name of the integration node. |
Queue manager name (Character): QueueManagerName | iib:getQueueManagerName() | The name of the WebSphere® MQ queue manager to which the integration node is connected. |
Node label (Character): NodeLabel | iib:getNodeName() | The name of the node. |
Message flow name (Character): MessageFlowLabel | iib:getMessageFlowName() | The name of the message flow where the Mapping node executing the map is running in. |
Application name (Character): ApplicationLabel | iib:getApplicationName() | The name of the application where the message flow in which the Mapping node executing the map is running in. |
Library name (Character): LibraryLabel | iib:getLibraryName() | The name of the library where the message flow in which the Mapping node executing the map is running in. |
Integration node properties available to ESQL and Java code
The following table shows the properties that are available to ESQL and Java code by using the IBM® Integration API.
The Java code, where applicable, is shown in the second column of the table.
Note that the BrokerProxy
, ExecutionGroupProxy
,
MessageFlowProxy
, and LocalBrokerUtilities
classes
are all part of the IBM Integration
API (IntegrationAPI.jar). This JAR needs to be
referenced from your Java project
in your IBM Integration Toolkit, but it does not
need to be deployed to the integration node.
It is best practice to call disconnect() on the BrokerProxy object after you have finished using it. By calling disconnect(), you deregister all listeners that are registered to the BrokerProxy instance and close the link to the integration node.
For a complete overview of integration node properties, see Integration node properties.
ESQL Property name | Java access method | Description |
---|---|---|
BrokerName (Character) | UseMbBroker.getBroker().getName() |
The name of the integration node. |
BrokerUserId (Character) | Use System.getProperty("user.name"); |
The user ID under which the integration node is running (that is, the user ID specified by the -i flag on the mqsicreatebroker command on Windows, or the user ID that started the integration node by using the mqsistart command on Linux® and UNIX systems). |
BrokerVersion (Character) | UseBrokerProxy b = BrokerProxy.getLocalInstance(); |
The 4-character version number of the integration node (see BrokerVersion). |
executionGroupLabel (Character) | UseMbExecutionGroup.getExecutionGroup().getName(); or System.getProperty("broker.egLabel"); |
The name of the integration server (a human-readable
name). Replace executionGroupLabel with the name
of the integration server. |
ExecutionGroupName (Character) | UseSystem.getProperty("broker.egLabel"); |
The name of the integration server (typically a UUID identifier). |
Family (Character) | Use System.getProperty("os.name") |
The generic name of the software platform that
the integration node is running on ('WINDOWS' , 'UNIX' ,
or 'ZOS' ). |
ProcessId (Integer) | UseExecutionGroupProxy eg = ExecutionGroupProxy.getLocalInstance(); |
The process identifier (PID) of the integration server. |
QueueManagerName (Character) | Use MbNode.getBroker().getQueueManagerName() |
The name of the queue manager to which the integration node is connected. |
WorkPath (Character) | Use System.getProperty("broker.workpath"); |
(Optional) The directory in which working files for this integration node are stored. |
ESQL Property name | Java access method | Description |
---|---|---|
AdditionalInstances (Integer) | UseExecutionGroupProxy eg = ExecutionGroupProxy.getLocalInstance(); |
The number of additional threads that the integration node can use to service the message flow. |
CommitCount (Integer) | UseExecutionGroupProxy eg = ExecutionGroupProxy.getLocalInstance(); |
The number of input messages that are processed by the message flow before a syncpoint is taken. |
CommitInterval (Integer) | UseExecutionGroupProxy eg = ExecutionGroupProxy.getLocalInstance(); |
The time interval at which a commit is taken when the CommitCount property is greater than 1 (that is, where the message flow is batching messages), but the number of messages processed has not reached the value of the CommitCount property. |
CoordinatedTransaction (Boolean) | Use
getMessageFlow().isCoordinatedTransaction(); |
Whether the message flow is processed as an XA coordinated transaction, coordinated by WebSphere MQ. |
MessageFlowLabel (Character) | Use
getMessageFlow().getName(); |
The name of the flow. |
ApplicationLabel (Character) | Use
getMessageFlow().getApplicationName(); |
The name of the application, or an empty string if the message flow is not running in an application. |
LibraryLabel (Character) | Use
getMessageFlow().getLibraryName(); |
The name of the application, or an empty string if the message flow is not running in a library. |
MaximumRateMsgsPerSec (Integer) | UseExecutionGroupProxy eg = ExecutionGroupProxy.getLocalInstance(); |
A positive value configures a message flow to monitor and maintain the total number of messages processed every second below the maximum rate value set. Default value of 0 will turn this option off. |
NotificationThresholdMsgsPerSec (Integer) | UseExecutionGroupProxy eg = ExecutionGroupProxy.getLocalInstance(); |
A positive value configures a message flow to cause a notification message to be published when the rate for messages arriving in the flow exceeds the notification threshold value set. Default value of 0 will turn this option off. |
WlmPolicy (Character) | UseExecutionGroupProxy eg = ExecutionGroupProxy.getLocalInstance(); |
Identifies the WorkloadManagement policy configurable service name used by the message flow. |
ESQL Property name | Java access method | Description |
---|---|---|
DataSource (Character) | Not possible | The ODBC Data Source Name (DSN) of the database in which the user tables are created. |
DataSourceUserId (Character) | Not possible | The user ID that the integration node uses to access the database user tables. |
MessageOptions (Integer 64-bit)1 | Not possible | The bit stream and validation options in force. |
NodeLabel (Character) | Use MbNode :getName(); |
The name of the node. |
NodeType (Character) | Not applicable | The type of node (Compute, Database, or Filter). |
ThrowExceptionOnDatabaseError (Boolean)1 | Not possible | Whether the integration node generates an exception when a database error is detected. |
TransactionType (Character)1 | Not possible | The type of transaction (Automatic or Commit) used to access a database from this node. |
TreatWarningsAsErrors (Boolean)1 | Not possible | Whether database warning messages are treated as errors, and cause the output message to be propagated to the failure terminal. |
- Not applicable for the DatabaseInput node.