Table 1. AppServer Broker Advanced Features properties
Property Description
Maximum client instances The maximum number of client connections that the broker can support concurrently.

The default is 512, which is high enough to ensure that the number of client connections is virtually unlimited. Realistically, however, the system-level resources needed to support an unlimited number of clients might be exhausted before this limit is reached. If you see broker log entries that contain Exception Messages for "out of space" or "OutOfMemory" you might need to reduce the maximum number of client connections to a more reasonable value.

Note, however, that lowering this value can cause some client requests to be rejected ("Exceeded Max Clients"). Configuring and starting multiple brokers to handle higher client loads alleviates the problem.
Priority weight (0-100) (dynamic property) An integer value between 0 and 100 that influences the share of the workload that the selected AppServer receives. The larger the value, the heavier the load that is distributed to the server. The NameServer distributes client requests across all AppServers that have the same application service in proportion to the Priority weight value. The default is 0.

You can update this property dynamically. Any changes will affect all current and new brokers.
Registration retry (in seconds) After registering with its controlling NameServer, the AppServer periodically sends "keep-alive" messages to the NameServer to let the NameServer know that it is still active. The Registration retry value is the number of seconds that pass between "keep-alive" messages.

The default is 30.
Server startup timeout (dynamic property) Specifies the amount of time, in seconds, that the broker waits for an active agent to become available before starting a new agent process.

The default is 3.

You can update this property dynamically. Any changes will affect only new agents that start after the property value has change; existing (running) brokers and agents are not updated.
Request timeout (dynamic property) Specifies the amount of time, in seconds, that the broker will wait for an agent to become available for processing a request.

The broker waits for this period only if the Maximum servers setting has been reached. After the timeout has expired, the client receives a "no servers available" error message.

The default is 15.

You can update this property dynamically. Any changes will affect all current and new brokers and/or agents.
Auto trim timeout (dynamic property) The amount of time, in seconds, that the broker waits before automatically trimming the number of running agents.

The broker keeps track of the maximum number of agents that are simultaneously busy during the interval you specify. At the end of the interval, the broker attempts to trim the number of agents to match the Maximum servers for the interval, or the Minimum servers, whichever is greater.

You can disable this feature by setting the timeout to zero (0). The default Server Auto-trim Interval is 1800 seconds.

Progress Software recommends that you use this default setting to avoid unnecessary process management that might result from frequent starting and trimming of agents.

You can update this property dynamically. Any changes will affect all current and new brokers and/or agents.
TCP/IP version Internet Protocol for network communication:
  • IPv4 — Accepts only IPv4 connections
  • IPv6 — Allows IPv4 and IPv6 connections using mapped address (where supported)

The default is IPv4.

You must also set the jvmArgs property in the ubroker.properties file to override the default behavior of the JVM for IPv6 connections.

jvmArgs=-Djava.net.preferIPv4Stack=false -Djava.net.preferIPv6Addresses=true.
jvmargs Java System Properties.
Enable dynamic property updates Allows dynamic changes to occur to several of the instance's properties, without requiring you to shut down the instance.

This property is disabled by default.

Note: Any property that is dynamic is labeled as such in this document.
AppServer Keepalive Allows the AppServer to recognize that a client bound to it is no longer connected.
serverASK Activity Timeout Specifies the number of seconds with no activity that the AppServer waits before sending the client a message requesting that the connection be maintained.

The property is used only if the AppServer Keepalive property is set to allowServerASK.
serverASK Response Timeout Specifies the number of seconds with no activity after the AppServer sends the client a message (requesting that the connection be maintained) before the client is disconnected. This property is used only if the AppServer Keepalive property is set to allowServerASK.
Enable debugging through the broker (dynamic property) Specifies whether or not the debugger is enabled; select the check box to enable it.

If you disable this property while the debugger is connected, the debugger connection terminates.

Note: The Broker debugger port number property must also be set to a valid value for the debugger to be properly enabled.

This property is disabled by default.
Broker debugger port number(dynamic property) Specifies the port number that the broker debugger will use when it starts. You can choose any valid value; if the port you specify is already in use, the debugger service will fail to start.

If you change the port number while the debugger service is active, the debugger service will be shut down and restarted using the new port number

The default port number is 3099.
Enable SSL for broker debugger (dynamic property) Specifies whether the broker debugger should accept only TLS-encrypted connections. If you enable this property, the Progress Developer Studio debugger will be required to establish an TLS session.

If you enable or disable the property while the debugger service is active, the debugger will be disconnected. The debugger service will be shut down and then restarted using the new selection.

This option is disabled by default.
Use the broker's private key/digital certificate for debugger(dynamic property) When enabled, indicates that, when using TLS, the broker debugger service should use the same private key as used by the AppServer agents.

If this property is enabled, then the Debugger private key/digital certificate alias name and Password to access the debugger's key/certificate property settings are ignored.

This property is enabled by default.
Debugger private key/digital certificate alias name (dynamic property) The name of the private key that should be used for the debugger service when the agent's private key is not being used.

This property must be defined if Enable SSL for broker debugger is enabled.

Password to access the debugger's key/certificate(dynamic property) The password required to access the private key specified by Debugger private key/digital certificate alias name.

The default for this property is blank..
Broker debugger passphrase (dynamic property) An optional property that represents the passphrase required by the debugger to connect to the debugger service in the broker.

If the debugger is connected to the debugger service when the passphrase is changed, the debugger remains connected. The next time the debugger attempts to connect to the debugger service, the new password is required.

The default for this property is blank.
Broker debugger passphrase Confirm Confirms the passphrase provided in Broker debugger passphrase.
Publish directory The name of the local directory where you want r-code to be placed when you are publishing from Progress Developer Studio.

If you are publishing remotely from Progress Developer Studio, you must set this property.