Editing the ubroker.properties file

The simplest way to make configuration changes to the ubroker.properties file is to copy an existing broker or NameServer definition and then modify the copied values as required for your configuration. You must ensure that all related properties and sections of the file are properly specified for each broker or NameServer instance.

Note: Be sure to preserve the original %DLC%\properties\ubroker.properties file. Rename the original file and work with a copy of the file. You must name the copy of the file ubroker.properties.

The following table describes the sections in the ubroker.properties file that apply to the DataServer for MS SQL Server. The file configures a default NameServer named NameServer.NS1 and a default broker named mssbroker1, which you can use either without editing or as templates for your own configuration specifications.

Table 1. DataServer for MS SQL Server sections of the ubroker.properties file
Product Section Description
All products ParentGroup Defines the name of each NameServer and product broker parent entity.
Environment Default environment variable settings for all NameServers and product brokers.
UBroker Defines default property settings for all product brokers.
NameServer NameServer The parent entity of NameServers. It defines default property settings for all NameServer instances.
NameServer.NS1 A sample property entity of a NameServer instance. It defines property settings for this NameServer instance.
Environment.NS1 A sample environment entity of a NameServer instance. It defines environment variable settings for this NameServer instance.
DataServer UBroker.MS The parent entity of DataServer for MS SQL Server brokers. It defines default property settings for all of these broker instances.
DataServer UBroker.MS.mssbroker1

A sample property entity of a DataServer for MS SQL Server broker instance. It defines default property settings for the broker instance named mssbroker1.

Note that although many of the settings in this section can work in your environment, some of them are for demonstration purposes only. You must specify the appropriate settings for the following:

  • srvrExecFile: Specify the pathname of the DataServer executable that the broker runs.
  • @{Startup\DLC}\bin\_msssrv.exe, the default, which runs the default DataServer from your OpenEdge install path.
  • srvrStartupParam: Specify the OpenEdge startup parameters for the DataServer. Do not modify the default parameters, although you can add parameters if necessary. The -svub switch is required for a broker connection in the Unified Broker framework.
  • srvrDSLogfile: To specify the name of dataserver log file. If not specified default name as dataserv.lg used.
  • srvrminport: To specify maximum port number for server.
  • srvrmaxport: To specify minimum port number for server.
DataServer Environment.mssbroker1

A sample environment entity of a DataServer for MS SQL Server broker instance. It defines environment variable settings that apply to the broker instance named mssbroker1.

Be sure to set the variables to the appropriate values; the values in the file are for demonstration purposes only. Add to this section any environment variables that you want to apply to the DataServer's environment. See Configuring a remote DataServer for the environment variable settings required to configure the DataServer for MS SQL Server.

The following example illustrates the DataServer sections of the ubroker.properties file:

 #
 #  Default properties for broker instances serving MSS DataServers
 #
 [UBroker.MS]
     srvrExecFile="@{Startup\DLC}\bin\_msssrv.exe"
     srvrStartupParam=-svub -S X -N TCP -U X -P X -hs 0 -s 40 
     operatingMode=State-aware
     classMain=com.progress.ubroker.broker.ubroker
     portNumber=4446
     defaultService=0
     initialSrvrInstance=0
     minSrvrInstance=0
     maxSrvrInstance=256
     brkrLoggingLevel=3
     description=MSS DataServer Broker
 #
 # Sample MSS DataServer Broker definition
 #
 [UBroker.MS.mssbroker1]
      srvrExecFile="@{Startup\DLC}\bin\_msssrv.exe"
      srvrStartupParam=-svub -S X -N TCP -U X -P X -hs 0 -s 40 
      srvrLogFile=@{WorkPath}\mssbroker1.server.log
      brokerLogFile=@{WorkPath}\mssbroker1.broker.log
      portNumber=4446
      defaultService=1
      appserviceNameList=mssbroker1
      controllingNameServer=NS1
      environment=mssbroker1
      uuid=172.18.103.53:32:e031b1e7bc:-7d29
      description=A sample MSS DataServer Broker
 
 ##
 Environment for MSS Dataserver Broker: mssbroker1
 ##
 #[Environment.mssbroker1]
 #
 # Sample MSS DataServer Broker definition using SSL
 #
 [UBroker.MS.mssSSLbroker1]
      srvrExecFile="@{Startup\DLC}\bin\_msssrv.exe"
      srvrStartupParam=-svub -S X -N TCP -U X -P X -hs 0 -s 40 
      srvrLogFile=@{WorkPath}\mssSSLbroker1.server.log
      brokerLogFile=@{WorkPath}\mssSSLbroker1.broker.log
      portNumber=4447
      defaultService=0
      appserviceNameList=mssSSLbroker1
      controllingNameServer=NS1
      environment=mssSSLbroker1
      uuid=172.18.103.53:32:e031b1e7bc:-7d29
      description=A sample MSS DataServer Broker using SSL

 #
 # Environment for MSS Dataserver Broker: mssSSLbroker1
 #
 [Environment.mssbroker1]
      DSLOGDIR=@{WorkPath}

For a complete description of the parameters included in each of these sections, see the comments in the %DLC%\properties\ubroker.properties.README file.

The ubroker.properties file is read on startup of the AdminService process. For changes in any used environment variables to take effect, the AdminService must be restarted.