On UNIX, you configure the Unified Broker framework by editing the $DLC/properties/ubroker.properties file. In this file, you provide configuration information for the AppServer, WebSpeed, and DataServers. For general information on how to work with the ubroker.properties file, see Configure OpenEdge.

When you configure the OpenEdge DataServer for Oracle, you are providing information that the Unified Broker framework can use to make sure that it is running the correct DataServer broker instance, that the broker is spawning the appropriate DataServer process, and that broker and servers are running in the correct environment.

The following table describes the sections in the ubroker.properties file that apply to the OpenEdge DataServer for Oracle. The file configures a default broker, orabroker1, which you can use as is or use as a template for your own configuration specifications.

Table 1. OpenEdge DataServer for Oracle sections
Section Description
[UBroker.OR] Parent entity of the OpenEdge DataServer for Oracle brokers. It defines default property settings for all OpenEdge DataServer for Oracle Broker instances.
[UBroker.OR.orabroker1] Sample property entity of an OpenEdge DataServer for Oracle Broker instance. It defines property settings for the OpenEdge DataServer for Oracle Broker named orabroker1. Note that although many of the settings in this section might work in your environment, some of the settings are for demonstration purposes only. You must specify the appropriate settings for:
  • srvrExecFile — Specify the pathname of DataServer executable you want to use. The default is $DLC/bin/_orasrv.
  • srvrStartupParam— In general terms, you should not modify the parameters in this section. Note that the values assigned to the parameters are for the broker's internal use only. For example, the values of the code-page parameters do not correspond to the values that your client connection might require. You can add startup parameters, however. One parameter you may wish to add, for instance is the –ssl parameter in order to make your DataServer instance TLS enabled.
    Note: For more information on setting the -ssl parameter in the srvrStartupParam value, see Establishing the TLS protocol in a DataServer broker instance of the Unified Broker.
[Environment.orabroker1] Environment settings that apply to the DataServer for Oracle Broker named orabroker1. Be sure to set the variables to the appropriate values; the values in the file are for demonstration purposes only. ORACLE_HOME and ORACLE_SID are required when not using SQL*NET to connect to Oracle. Add any environment variables that you want to apply to the DataServer's environment to this section. Environment variables defined here will be made available to the AdminService and broker at run-time and will override any values that may have been set previously (such as in the Windows registry or in a UNIX shell script).

Here are the OpenEdge DataServer for Oracle sections in the ubroker.properties file:

#
#  Default properties for broker instances serving Oracle DataServers
#
#
 #  Default properties for broker instances serving Oracle DataServers
 #
 [UBroker.OR]
     srvrExecFile=$DLC/bin/_orasrv
     srvrStartupParam=-svub -S X -N TCP -U X -P X -hs 0 -s 40
     operatingMode=State-aware
     classMain=com.progress.ubroker.broker.ubroker
     portNumber=4445
     defaultService=0
     initialSrvrInstance=0
     minSrvrInstance=0
     maxSrvrInstance=256
     brkrLoggingLevel=3
     description=Oracle DataServer Broker
#
# Sample Oracle DataServer Broker definition
#[UBroker.OR.orabroker1]
     srvrExecFile=$DLC/bin/_orasrv
     srvrStartupParam=-svub -S X -N TCP -U X -P X -hs 0 -s 40
     srvrLogFile=$WRKDIR/orabroker1.server.log
     brokerLogFile=$WRKDIR/orabroker1.broker.log
     portNumber=4445
     defaultService=1
     appserviceNameList=orabroker1
     controllingNameServer=NS1
     environment=orabroker1
     uuid=172.18.103.53:1f415c:d6330e5d24:-7f4d
     description=A sample Oracle DataServer Broker

##
Environment for Oracle Dataserver Broker: orabroker1
##
Connection to an Oracle database through the Progress
# dataserver requires that environment variables for
# ORACLE_HOME and ORACLE_SID are set in the context of
# a running dataserver broker instance. These values
# must either be set in the shell from which the Admin
# Service is started or they must be explicitly set here
#
for the broker instance.
#[Environment.orabroker1]
# ORACLE_HOME=/u01/oracle/client
# ORACLE_SID=OR

#
# Sample Oracle DataServer Broker definition using SSL
#[UBroker.OR.oraSSLbroker1] 
     srvrExecFile=$DLC/bin/_orasrv
     srvrStartupParam=-svub -S X -N TCP -U X -P X -hs 0 -s 40 
     –ssl
     srvrLogFile=$WRKDIR/orasslbroker1.server.log
     brokerLogFile=$WRKDIR/orasslbroker1.broker.log 
     portNumber=4446
     defaultService=0
     appserviceNameList=orasslbroker1
     controllingNameServer=NS1
     environment=orasslbroker1
     uuid=172.18.103.53:1f415c:d6330e5d24:-7f4d
     description=A sample Oracle DataServer SSL Broker

#
# Environment for Oracle Dataserver Broker: orasslbroker1
#
# Connection to an Oracle database through the Progress
# dataserver requires that environment variables for
# ORACLE_HOME and ORACLE_SID are set in the context of
# a running dataserver broker instance.  These values
# must either be set in the shell from which the Admin
# Service is started or they must be explicitly set here
#
 for the broker instance.
#[Environment.orasslbroker1]
#   ORACLE_HOME=/u01/oracle/client
#   ORACLE_SID=ORCL

For a complete description of the parameters included in each of these sections, see the comments in the $DLC/properties/ubroker.properties file. Be sure to preserve the original $DLC/properties/ubroker.properties file. Work with a copy of the file. You must name the copy of the file ubroker.properties. After creating your own version of ubroker.properties, you can verify its settings by using the oraconfig utility. See DataServer Command Line Utilities and Startup Parameters for more information.

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