Try OpenEdge Now
skip to main content
Administration
WebSpeed Administration : Configuring WebSpeed on UNIX : Overview of the ubroker.properties file : Editing the ubroker.properties file
 
Editing the ubroker.properties file
You can edit ubroker.properties directly using any text editor to create new WebSpeed Transaction Server and NameServer configurations or edit existing configurations. The simplest way to make new configurations in the ubroker.properties file is to copy an existing Transaction Server or NameServer definition and then modify the values of the copy's properties to suit your needs. When you do this, you must be sure to supply each definition with its own uuid setting, as described in the list of required unique parameters later in this section.
You can also use OpenEdge Management or OpenEdge Explorer to create and configure instances of the WebSpeed Transaction Server or the NameServer on UNIX.
If you edit the configuration by hand, without OpenEdge Management or OpenEdge Explorer, note the following:
*The ubroker.properties file resides in the /properties subdirectory of the OpenEdge installation directory.
*You should not directly change the values in the ubroker.properties file unless you have a complete understanding of how the changes affect WebSpeed components. If you have OpenEdge Management or OpenEdge Explorer available, use it to make all changes to this file on UNIX.
*For complete definitions of all the properties and detailed information on how to set them, see the comments included in the installed file.
*If you create additional instances of the WebSpeed Transaction Server and the NameServer, you must be sure that each of the following parameters has a value unique to the entire ubroker.properties file:
*[Ubroker.WS.broker-name] — The Transaction Server name is unique and case-sensitive. It can contain alphanumeric and special characters, except period (“.”), colon (":"), or square brackets (“[ ]”). The name must not contain blank spaces.
*portNumber — Each Transaction Server configuration requires a unique port number.
*defaultService — If you configure two WebSpeed Transaction Servers to use the same NameServer and specify that the Transaction Servers perform the same application service, the Transaction Servers must also support the same business function. Set only one of the Transaction Servers as the default.
*appserviceNameList — A list of aliases that can be used in the WService=<appservice-name> in the URL.
*uuid — A universally unique identifier for a Transaction Server. If you use OpenEdge Explorer to create the new Transaction Server, this property is automatically set. If you manually add Transaction Server definitions, generate a unique uuid for each Transaction Server definition by using the following command:
install-path\bin\genuuid
You can then cut and paste the value after "uuid=".
*Log files — Each Transaction Server configuration and NameServer configuration generates its own log files; the names must be unique for each Transaction Server and each NameServer.
*If you create additional instances of the WebSpeed Transaction Server and the NameServer by copying an existing instance, be sure that each of the following parameters has the correct values for the new instance:
*srvrStartupParam — Identify the startup parameters for your agents. Copy the value from the ubroker.properties file's [UBroker.WS] section to your new Transaction Server definition, and modify.
The srvrStartupParam property is a dynamic property. Any changes to this property only affects new agents started after the value changes because the change affects how the agent is started. Existing (running) brokers and agents are not updated with the new value.
*controllingNameServer — Make sure that each Transaction Server points to its controlling NameServer.
*userName and groupName — You can optionally specify a username and a group name that the Transaction Server runs under; if you do not specify these names, the Transaction Server runs under the username and group name of the user who starts the AdminServer.
Note: If you install the NameServer on a separate host from the WebSpeed Transaction Server, the NameServer installation includes its own copy of the properties file.
You must ensure that all related properties and sections of the file are properly specified for each Transaction Server or NameServer instance. If you do edit the file directly, use the appropriate configuration utility (NSCONFIG or WSCONFIG) to validate the product configuration that you have edited.
For a complete overview of all the sections in the ubroker.properties file and more information on how to edit the file, see the comments in the file, or see OpenEdge Getting Started: Installation and Configuration. You can use the mergeprop utility installed with OpenEdge to manually edit the ubroker.properties file. For information on using mergeprop, see OpenEdge Getting Started: Installation and Configuration. For more information on the configuration utilities, see Command and Utility Reference.