Release 10.1A: OpenEdge Getting Started:
Installation and Configuration

> ## Ubroker.properties file structure

> The `ubroker.properties` file consists of a hierarchical structure of configuration entities, where parent entities provide configuration information that you can override or extend in each child entity. Each configuration entity has a name that begins the entity definition, and the definition contains configuration settings for one or more product instances. The AppServer configurations in `ubroker.properties` are shown in the following table:

> Configuration entity name | Configuration entity function
> --- | ---
>     [UBroker]
> | Defines default property settings for all NameServer, AppServer, DataServer, and WebSpeed Transaction Server brokers.
>     [UBroker.AS]
> | Defines default property settings for all instances of an AppServer.
>     [UBroker.AS.product-instance-name]
> | Defines property settings for this instance of an AppServer. The `ubroker.properties` file can contain several of these entities each with a unique `product-instance-name.`

> Note: Each configuration definition contains environment variables, registry entries, and property settings for each product instance. Progress Explorer and the associated command-line configuration utilities use this file to store and validate the configurations for the products.

> Parent entities provide default values for all of their child entities. However, at any child level, a redefinition of any value supersedes the default value of its parent. All children from the redefinition level down inherit this new value.

> Like the `ubroker.properties` file, a similar file, `conmgr.properties,` stores all the properties for each instance of an OpenEdge database.The `conmgr.properties` file is installed in the `$DLC\properties\conmgr.properties`.

> ##### AdminServer and requirements to set an owner for the Broker

> The AdminServer honors a user’s permissions, according to the user’s profile that was used to start an AdminServer. For example, a user who intends to start an AdminServer for another user’s process must have the rights to start this second process. These rights or settings must be previously set in the broker’s Owner Information properties category. For more information about the Owner Information and the owner feature, see the Progress Explorer online help.

> ##### Working with the supported products

> For the definitions and usage of all properties supported in the properties file, see the comments in the `ubroker.properties.readme` file that is available at `C:\``$DLC``\properties` from the installed `ubroker.properties` file. For more information on:

> - Each configuration management and validation utility, see OpenEdge Application Server: Administration and OpenEdge Data Management: Database Administration .

> - Maintaining `ubroker.properties` for AppServer installations, see OpenEdge Application Server: Administration .

> - Maintaining `ubroker.properties` for DataServer installations, see the OpenEdge DataServer Guide for your DataServer product.

> - Maintaining `ubroker`.`properties` for WebSpeed installations, see OpenEdge Application Server: Administration .

> - Maintaining `ubroker.properties` for NameServer installations, see the "OpenEdge Unified Broker administration framework" section and the configuration manual for each product that includes the NameServer in its configuration.

> - Maintaining `ubroker`.`properties` for AppServer Internet Adapter installations, see OpenEdge Application Server: Administration .

> - Maintaining `ubroker`.`properties` for the OpenEdge Adapter for SonicMQ installations, see OpenEdge Application Server: Administration .

> ##### Editing and validating the content of the ubroker.properties file

> Progress Explorer can be used in Windows platforms, and can connect remotely to UNIX host machines to perform configuration activities. Use the mergeprop utility on either platform if the Progress Explorer is not available.

> To ensure proper run-time processing, the file must be named `ubroker.properties` and must be located in the `properties` subdirectory of the OpenEdge installation directory.

> ##### Guidelines for editing the properties file

> In general, you should update all configurations (local or remote) using either the Progress Explorer tool or mergeprop utility. If you must update a configuration locally using a text editor:

> - Do not directly change the values in the `ubroker.properties` file unless you have a complete understanding of how the changes affect Unified Broker components.

> - Make a copy of this file, edit the copy, and verify the result before replacing the original with your edited copy.

> - For complete definitions of all the properties and detailed information on how to set them, see the comments included in the properties file.

> - Verify the result using the appropriate configuration validation utilities.

> | To edit the file and create or modify a product configuration:

> 1. Make a backup copy from the installed `ubroker.properties` file (and name it, for example, `test.properties`).

> 2. Make changes to `test.properties` with a text editor.

> 3. Run the appropriate validation utility on `test.properties` using the -`propfile` option to validate your changes. For a complete list of the command-line utilities you can use to validate property file changes, see Table 10–8.

> Shut down any running brokers or NameServers using the -`stop` option of the appropriate configuration management utilities (for example, `nsman` and `asbman`).

> 4. Copy `test.properties` to `ubroker.properties` in the `properties` subdirectory of the OpenEdge installation directory. If you might return to the previous configuration, store a backup copy of the `ubroker.properties` file before replacing it with your modified version.

> 5. Restart your brokers and NameServers using the -`start` option of the appropriate configuration management utilities.For a complete list of the command-line utilities you can use to configure property files, see Table 10–7.

> For more information on editing and validating the `ubroker.properties` file to configure a NameServer, see the "Editing the properties file" section. For more information on editing and validating the file for each Unified Broker product, see your product documentation.

Copyright © 2005 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095