
	Version 8.0	SEARCH CONTENTS \| PDF PAGE PDF BOOKS \| HOME UP PREV NEXT

Quick Reference

— webMethods EntireX Administration —

Broker Attribute File

Note:
This section lists all Broker parameters. Not all parameters are applicable to all supported operating systems.

The Broker attribute file contains a series of parameters (attributes) that control the availability and characteristics of clients and servers, publishers and subscribers as well as of the Broker itself. You can customize the Broker environment by modifying the attribute settings.

This document covers the following topics:

Name and Location of Attribute File
Attribute Syntax
Broker-specific Attributes
Service-specific Attributes
Topic-specific Attributes
Codepage-specific Attributes
Adabas SVC/Entire Net-Work-specific Attributes
Security-specific Attributes
TCP/IP-specific Attributes
c-tree-specific Attributes
SSL-specific Attributes
DIV-specific Attributes
Adabas-specific Attributes
Variable Definition File

Name and Location of Attribute File

The name and location of the Broker attribute file is platform-dependent.

Platform	File Name/Location
z/OS	Member EXBATTR in the EntireX Broker source library.
UNIX	File etbfile in directory $EXXDIR/etb/ETB`nnn` , where ETB`nnn` is the assigned Broker ID.
Windows	File ETB`nnn`.atr in EntireX subdirectory Broker\ETB`nnn` , where ETB`nnn` is the assigned Broker ID.
z/VSE	Library member ETB`nnn`.ATR, where ETB`nnn` is the assigned Broker ID.

Attribute Syntax

Each entry in the attribute file has the format:

ATTRIBUTE-NAME=value

The following rules and restrictions apply:

A line can contain multiple entries separated by commas.
Attribute names can be entered in mixed upper and lowercase.
Spaces between attribute names, values and separators are ignored.
Spaces in the attribute names are not allowed.
Commas and equal signs are not allowed in value notations.
Lines starting with an asterisk (*) are treated as comment lines. Within a line, characters following an * or # sign are also treated as comments.
The CLASS keyword must be the first keyword in a service definition.
Multiple services can be included in a single service definition section. The attribute settings will apply to all services defined in the section.
Multiple topics can be included in a single topic definition section. The attribute settings will apply to all topics defined in the section.
Attributes specified after the service definition (CLASS, SERVER, SERVICE keywords) overwrite the default characteristics for the service.
Attributes specified after the topic definition (TOPIC keyword) overwrite the default characteristics for the topic.
Attribute values can contain variables of the form ${variable name} or $variable name:
- Due to variations in EBCDIC codepages, braces should only be used on ASCII (UNIX or Windows) platforms or EBCDIC platforms using the IBM-1047 (US) codepage.
- The variable name can contain only alphanumeric characters and the underscore (_) character.
- The first non-alphanumeric or underscore character terminates the variable name.
- On Windows and UNIX, the string ${variable name} is replaced with the value of the corresponding environment variable.
- On z/OS, variable values are read from a file defined by the DD name ETBVARS. The syntax of this file is the same as the attribute file.
- If a variable has no value: if the variable name is enclosed in braces, error 00210594 is given, otherwise $variable name will be used as the variable value.
- If you encounter problems with braces (and this is not unlikely in a z/OS environment) we suggest you omit the braces.

Broker-specific Attributes

The Broker-specific attribute section begins with the keyword DEFAULTS=BROKER. It contains attributes that apply to the EntireX Broker. At startup time, the attributes are read and duplicate or missing values are treated as errors. When an error occurs, the EntireX Broker stops execution until the problem is corrected.

Be sure to specify sufficiently large values for the Broker attributes that define the global resources. Otherwise, resource shortages for your applications may result.

Attribute Values Opt/
Req Operating System

ACCOUNTING NO | 128-255 O z

NO | YES [SEPARATOR =char ] O u w

Determines whether accounting records are created.

NO	Do not create accounting records.
`nnn`	The SMF record number to use when writing the accounting records.
YES	Create accounting data. `char=` separator character(s). Up to seven separator characters can be specified using the SEPARATOR suboption, for example ACCOUNTING = (YES, SEPARATOR=;). If no separator character is specified, the comma character will be used.

ACCOUNTING-VERSION 1 | 2 O z u w

Determines whether accounting records are created.

1	Collect accounting information. This value is compatible with Broker 7.2.1 and the previous version.
2	Collect extended accounting information in addition to that available with option 1.
3	Create accounting records in layout of version 3.

This parameter applies to z/OS, Windows, and UNIX, when ACCOUNTING is activated.

AUTOLOGON YES | NO O z u w v

YES	LOGON occurs automatically during the first SEND or REGISTER.
NO	LOGON/LOGOFF calls must be used.

Using LOGON/LOGOFF calls (AUTOLOGON=NO) results in a more efficient use of resources.

BROKER-ID A32 R z u w v

Identifies the Broker to which the attribute file applies. The Broker ID must be unique per machine.

Note:
The numerical section of the BROKER-ID is no longer used to determine the DBID in the Broker kernel with Entire Net-Work transport (NET). To determine the DBID, use attribute NODE in the DEFAULTS=NET section of the attribute file.

CLIENT-NONACT n | n S | n M | n H R z u w v

Define the non-activity time for clients.

`n`	Same as `n` S.
`n` S	Non-activity time in seconds (max. 2147483647).
`n` M	Non-activity time in minutes (max. 35791394).
`n` H	Non-activity time in hours (max. 596523).

A client that does not issue a Broker request within the specified time limit is treated as inactive and all resources for the client are freed.

CMDLOG NO | YES O z u w v

NO	Command logging will not be available in the Broker.
YES	Command logging features will be available in the Broker.

CMDLOG-FILE-SIZE 1024 | n O z u w v

Defines the maximum size of the file that the command log is written to, in kilobytes. The value must be 1024 or higher. The default value is 1024. When one command log file grows to this size, Broker starts writing to the other file. For more details, see Command Logging.

CONTROL-INTERVAL 60s | n | nS | nM | nH | O z u w v

Defines the time interval of time-driven Broker-to-Broker calls.

It controls the time between handshake attempts.
The Standby Broker will check the status of the Standard Broker after the elapsed CONTROL-INTERVAL time.

`n`	Same as `n` S.
`n` S	Interval in seconds (max. 2147483647).
`n` M	Interval in minutes (max. 35791394).
`n` H	Interval in hours (max. 596523).

The minimum value is 16 seconds. It is strongly recommended to use the default value (60 seconds), except for very slow machines.

CONV-DEFAULT UNLIM | n O z u w v

Default number of conversations that are allocated for every service.

UNLIM	The number of conversations is restricted only by the number of conversations globally available. Precludes the use of `NUM-CONVERSATION=AUTO`.
`n`	Number of conversations.

This value can be overridden by specifying a CONV-LIMIT for the service.
A value of 0 (zero) is invalid.

DEFERRED NO | YES O z u w v

Disable or enable deferred processing of units of work.

NO	Units of work cannot be sent to the service until it is available.
YES	Units of work can be sent to a service that is not up and registered. They will be processed when the service becomes available.

DYNAMIC-MEMORY-MANAGEMENT NO | YES O z u w

NO	All memory is allocated at Broker startup based on the calculation from the defined NUM-* attributes. Size of memory cannot be changed. This is the known behavior of EXX 7.3.
YES	An initial portion of memory is allocated at Broker startup based on defined NUM-* attributes or internal default values if no NUM-* attributes have been defined. More memory is allocated without Broker restart if there is a need to use more storage. Unused memory is deallocated. The upper limit of memory consumption can be defined using attribute `MAX-MEMORY`.

If you run your Broker with attribute DYNAMIC-MEMORY-MANAGEMENT=YES, the following attributes are not needed:

NUM-CLIENT
NUM-CMDLOG-FILTER
NUM-COMBUF
NUM-CONV[ERSATION]
NUM-LONG[-BUFFER]
NUM-PUBLICATION
NUM-PUBLISHER
NUM-SERVER
NUM-SERVICE
NUM-SERVICE-EXTENSION
NUM-SHORT[-BUFFER]
NUM-SUBSCRIBER
NUM-SUBSCRIBER-TOTAL
NUM-TOPIC
NUM-TOPIC-EXTENSION
NUM-TOPIC-TOTAL
NUM-UOW|MAX-UOWS|MUOW
NUM-WQE

However, if one of these attributes is defined, it determines the allocation size of that particular Broker resource.

FORCE NO | YES O u

NO	Go down with error if IPC resources still exist.
YES	Clean up the left-over IPC resources of a previous run.

Note:
If Broker is started twice, the second instance will kill the first by removing the IPC resources.

For z/VSE, see also separate Adabas SVC/Entire Net-Work-specific attribute FORCE in the DEFAULTS=NET section of the attribute file.

HANDSHAKE YES | NO O z u w v

YES	The Standby Broker requests an initial handshake to the Standard Broker before starting the surveillance of the Standard Broker.
NO	The Standby Broker will perform takeover of the persistent store if the initial handshake failed.

The HANDSHAKE=NO scenario will minimize attribute changes. Standard Broker and Standby Broker can be started with RUN-MODE=STANDBY. The first started Broker will change the RUN-MODE to STANDARD.

For more details, see Achieving High Availability of the Persistent Store.

HEAP-SIZE 1024 n O z u w v

Defines the size of the internal heap in KB. It is strongly recommended to use the default value (1024 KB).

ICU-CONVERSION YES | NO O z u w v

Disable or enable ICU conversion.

YES	ICU is loaded and used for conversion.
NO	ICU is not loaded and not used.

Note:
All services with CONVERSION defined in the service properties require ICU-CONVERSION to be set to YES.

ICU requires additional storage to run properly. If conversion is not needed, setting ICU-CONVERSION to NO will help to avoid unnecessary storage consumption.

LONG-BUFFER-DEFAULT UNLIM | n O z u w v

Number of long buffers to be allocated for each service or topic.

UNLIM	The number of long message buffers is restricted only by the number of buffers globally available. Precludes the use of NUM-LONG-BUFFER = AUTO.
`n`	Number of buffers.

This value can be overridden by specifying a LONG-BUFFER-LIMIT for the service. A value of 0 (zero) is invalid.

MAX-MEMORY 0 | n | nK | nM | nG | UNLIM O z u w

Defines the upper limit of memory allocated by Broker if DYNAMIC-MEMORY-MANAGEMENT=YES has been defined.

0, UNLIM	No memory limit.
others	Defines the maximum limit of allocated memory. If limit is exceeded, error 671 `Requested allocation exceeds MAX-MEMORY` is generated.

MAX-MESSAGE-LENGTH 31647 | n O z u w v

Maximum message size that the Broker kernel can process. This value is transport-dependent. The default value corresponds to the maximum length available with Entire Net-Work / Adabas transport.

MAX-MESSAGES-IN-UOW 16 | n O z u w v

Maximum number of messages in a UOW (or publication).

MAX-MSG See MAX-MESSAGE-LENGTH.

MAX-TAKEOVER-ATTEMPTS 5 | n | UNLIM O z u w v

Defines the number of attempts to restore the persistent store data after the Standby Broker begins the takeover process. The Standard Broker may hold a system in the queue if shutdown is still running.

MAX-UOW-MESSAGE-LENGTH See MAX-MESSAGE-LENGTH.

MAX-UOWS 0 | n O z u w v

The maximum number of UOWs that can be concurrently active Broker-wide. The default value is 0 (zero), which means that the Broker will process only messages that are not part of a unit of work. If UOW processing is to be done by any service, a MAX-UOWS value must be 1 or larger for the Broker.

The MAX-UOWS value for the service will default to the value set for the Broker. NUM-UOW is an alias of this parameter.

MESSAGE-CASE NONE | UPPER | LOWER O z u w v

Indicates if certain error message texts returned by the Broker to its clients or written by the Broker to its log file are to be in mixed case, uppercase, or lowercase.

NONE	No changes are made to message case.
UPPER	Messages are changed to uppercase.
LOWER	Messages are changed to lowercase.

MUOW See NUM-UOW.

NET-RESTART See RESTART.

NET-RETRY-LIMIT See RETRY-LIMIT.

NET-RETRY-TIME See RETRY-TIME.

NEW-UOW-MESSAGES YES | NO O z u w v

YES	New UOW messages are allowed.
NO	New UOW messages are not allowed.

This applies to UOW when using Persistence and should not be used for non-persistent UOWs. A usage example could be the following:

The Broker persistent store reaches capacity and the Broker shuts down. You can set NEW-UOW-MESSAGES to NO to prevent new UOW messages from being added after a Broker restart. This action allows only consumption (not production) of UOWs to occur after Broker restart. After the persistent store capacity has been sufficiently reduced, the Broker administrator can issue the CIS command to ALLOW-NEWUOWMSGS. This action allows new UOW messages to be sent to the Broker. Reset attribute parameter NEW-UOW-MESSAGES to YES, which permits new UOW messages to be produced in subsequent Broker sessions.

NUM-CCOM See NUM-CCOM.

NUM-CLIENT n R z u w v

Number of clients that can access the Broker concurrently. A value of 0 (zero) is invalid.

NUM-CMDLOG-FILTER 1 | n O z u w v

Maximum number of filters that can be specified simultaneously. It is recommended that you limit this value to the number of services that are being monitored. Minimum value is 1. A value of zero is invalid when the attribute CMDLOG is set to YES. SeeCommand Logging for more information.

NUM-COMBUF 1 - 999999 R z u w v

Determines the maximum number of communication buffers available for processing commands arriving in Broker kernel. The size of one communication buffer is usually 16 KB split into 32 slots of 512 bytes, but it ultimately depends on the hardware architecture of your CPU. A value of 0 (zero) is invalid.

NUM-CONVERSATION or
NUM-CONV n | AUTO R z u w v

Defines the number of conversations that can be active concurrently. The number specified should be high enough to account for both conversational and non-conversational requests. (Non-conversational requests are treated internally as one-conversation requests.)

`n`	Number of conversations.
AUTO	Uses the CONV-DEFAULT and the service-specific CONV-LIMIT values to calculate the number of conversations. The values used in the calculation must not be set to UNLIM.

A value of 0 (zero) is invalid. If a wildcard service is defined in the service-specific section of the attribute file, the value of AUTO is invalid.

See Wildcard Service Definition.

NUM-LONG-BUFFER or
NUM-LONG n | AUTO R z u w v

Defines the number of long message containers. Long message containers have a fixed length of 4096 bytes and are used to store requests that are larger than 2048 bytes. Storing a request of 8192 bytes, for example, would require two long message containers.

`n`	Number of buffers.
AUTO	Uses the LONG-BUFFER-DEFAULT and the service-specific LONG-BUFFER-LIMIT values to calculate the number of long message buffers. The values used in the calculation must not be set to UNLIM.

A value of 0 (zero) is invalid.

In non-conversational mode, message containers are released as soon as the client receives a reply from the server. If no reply is requested, message containers are released as soon as the server receives the client request.

In conversational mode, the last message received is always kept until a new one is received.

If a catch-all service is defined in the service-specific section of the attribute file, the value of AUTO is invalid.

See Wildcard Service Definition.

NUM-PUBLICATION n | AUTO O z u w v

Defines the number of publications that can be active concurrently.

`n`	Number of publications
AUTO	Uses the PUBLICATION-DEFAULT and the topic-specific PUBLICATION-LIMIT to calculate the number of publications. The values used in the calculation must not be set to UNLIM

A value of 0 (zero) is invalid. If a wildcard topic is defined in the topic-specific section of the attribute file, the value of AUTO is invalid.

NUM-PUBLISHER n O z u w v

Number of publishers that can access the Broker concurrently. A value of 0 (zero) is invalid.

NUM-SERVER n | AUTO R z u w v

Defines the number of servers that can offer services concurrently using the Broker. This is not the number of services that can be registered to the Broker (see NUM-SERVICE).

`n`	Number of servers
AUTO	Uses the SERVER-DEFAULT and the service-specific SERVER-LIMIT values to calculate the number of servers. The values used in the calculation must not be set to UNLIM.

Setting this value higher than the number of services allows the starting of server replicas that provide the same service.

A value of 0 (zero) is invalid. If a wildcard service is defined in the service-specific section of the attribute file, the value of AUTO is invalid.

See Wildcard Service Definition.

NUM-SERVICE n R z u w v

Defines the number of services that can be registered to the Broker. This is not the number of servers that can offer the services (see NUM-SERVER). A value of 0 (zero) is invalid.

NUM-SERVICE-EXTENSION n | AUTO O z u w v

Defines the number of service extensions to link servers to services.

`n`	Number of service extensions.
AUTO	Uses the value specified or calculated for NUM-SERVER.
not specified	If this attribute is not set, the default value is NUM-SERVER multiplied by NUM-SERVICE.

The minimum value is NUM-SERVER.
The maximum value is NUM-SERVER multiplied by NUM-SERVICE.

Caution is recommended with this attribute.

Set this attribute only if the storage resources allocated for service extensions need to be restricted.
Note that the value <n> allows only the specified number of server instances of <n> to be used.
Value AUTO will calculate the number of allowed server instances from NUM-SERVER, which itself might be set to AUTO. In this case, this also considers the value of SERVER-DEFAULT and even the individual SERVER-LIMIT for each service definition (see note below).

NUM-SHORT-BUFFER or
NUM-SHORT n | AUTO R z u w v

Defines the number of short message containers. Short message containers have a fixed length of 256 bytes and are used to store requests of no more than 2048 bytes. To store a request of 1024 bytes, for example, would require four short message containers.

`n`	Number of buffers.
AUTO	Uses the SHORT-BUFFER-DEFAULT and the service-specific SHORT-BUFFER-LIMIT values to calculate the number of short message buffers. The values used in the calculation must not be set to UNLIM.

In conversational mode, the last message received is always kept until a new one is received.

If a wildcard service is defined in the service-specific section of the attribute file, the value of AUTO is invalid.

See Wildcard Service Definition.

NUM-SUBSCRIBER n | AUTO O z u w v

Defines the number of subscribers that can be active concurrently.

`n`	Number of subscribers.
AUTO	Uses the SUBSCRIBER-DEFAULT and the topic-specific SUBSCRIBER-LIMIT to calculate the number of subscribers.

A value of 0 (zero) is invalid. If a wildcard topic is defined in the topic-specific section of the attribute file, the value of AUTO is invalid.

NUM-SUBSCRIBER-TOTAL n | AUTO O z u w v

Defines the total number of subscribers that can be durably subscribed. Their subscription information is saved in the persistent store.

`n`	Total number of subscribers.
AUTO	Uses the value defined or calculated for NUM-SUBSCRIBER.

A value of 0 (zero) is invalid. This value must be greater than or equal to the NUM-SUBSCRIBER value. Parameter is required if SUBSCRIBER-STORE=PSTORE is defined.

NUM-TOPIC n O z u w v

Defines the number of topics that can be active in the Broker. A value of 0 (zero) is invalid.

NUM-TOPIC-EXTENSION n | AUTO O z u w v

Defines the number of topic extensions to link subscribers to topics.

`n`	Number of topic extensions.
AUTO	Uses the value specified for NUM-TOPIC.
not specified	If this attribute is not set, the default value is NUM-SUBSCRIBER multiplied by NUM-TOPIC.

The minimum value is NUM-SUBSCRIBER.
The maximum value is NUM-SUBSCRIBER multiplied by NUM-TOPIC.

Caution is recommended with this attribute.

Set this attribute only if the storage resources allocated for topic extensions need to be restricted.
Note that the value <n> allows only the specified number of topic instances of <n> to be used.
Value AUTO calculates the number of allowed server instances from NUM-SUBSCRIBER, which itself might set to AUTO. In this case, this also considers the value of SERVER-DEFAULT and even the individual SERVER-LIMIT for each topic definition (see note below).

NUM-TOPIC-TOTAL n | AUTO