Global User-Defined Properties (UDP) and User Variables in Integration Server Configuration

This blog explores Global User-Defined Properties (Global UDP) and the User Variables section in the Integration Server configuration file.

Local UDPs are defined at the message flow level, whereas Global UDPs are defined at the Integration Server level and apply across multiple flows. The User Variables section is located at the bottom of the Integration Server configuration file.

Characteristics of Global UDPs:

• Global UDPs are not displayed as properties in the Integration Server Web UI.
• They cannot be overridden via the Web UI.
• Accessible in Compute Node, Java Compute Node, .NET Compute Node, and Mapping Node.
• Overrides of Global UDPs can persist across Integration Server restarts.
• Accessed by declaring an ESQL variable as External with the same name as the User Variable in the configuration file.
• IBM ACE provides an API to override User Variables (Global UDPs) at runtime.

User Variables Section:

The User Variables section contains configurable properties, which are commented out by default. Uncomment them to enable usage.

• #UserVariableOne: ‘user-var-one-value’
  Defines a Global UDP as a name-value pair. Multiple entries can be specified.
• #udp-persist-global-overrides: false
  Ensures runtime overrides of Global UDPs persist across Integration Server restarts. However, they reset to default if the application is redeployed.
• #hostname-override: ‘name’
  Overrides the hostname reported in published events, logs, and OpenTelemetry.
• #logging-hostname-override: ‘name’
  Overrides the hostname in BIP log events, including activity and administrative logs.
• #monitoring-hostname-override: ‘name’
  Overrides the hostname in monitoring events.
• #stats-hostname-override: ‘name’
  Overrides the hostname in accounting and statistics events.
• #monitoring-brokername-override: ‘name’
  Overrides the default integration node name (integration_server) in monitoring event data.
• #publication-brokername-override: ‘name’
  Overrides the default integration node name (integration_server) in event publication topics, such as MQ topic writing.
• #compute-brokername-override: ‘name’
  Overrides the default integration node name (integration_server) returned in ESQL, Java, and Mapping Nodes. By default, when running a standalone integration server, this name is returned using the BrokerName Variable.

To modify it, uncomment and update the property value.