skip to main content
OpenEdge Data Management: DataServer for ODBC
Server-Related Command Line Utilities and Startup Parameters : ODBCONFIG utility
 

ODBCONFIG utility

Use the ODBCONFIG utility to help you debug existing DataServer for ODBC configurations defined in a properties file, such as the ubroker.properties file. This utility displays the property settings associated with a DataServer for ODBC configuration, and checks that the syntax and values are valid.
The ODBCONFIG utility runs locally, on the machine on which the AdminServer is running. The utility does not run across the network.
odbconfig path-to-properties-file -validate

Syntax

Operating system
Syntax
Windows
odbconfig
[
[
[-name DataServer-name]
[-propfile path-to-properties-file]
[-validate]
]
|-help
]

Parameters

-name DataServer–name
Specifies which existing DataServer for ODBC configuration to examine. The name must match the name of an existing DataServer for ODBC configuration defined in the specified properties file. If you do not specify a DataServer by name, the ODBCONFIG utility analyzes all DataServer for ODBC configurations defined in the properties file specified by the -propfile parameter.
-propfile path–to–properties–file
Specifies a filename or pathname to a file that contains the property settings to be validated, for example test.properties. If a filename or pathname is not specified, it defaults to the installation version of the ubroker.properties file, such as %DLC%\properties\ubroker.properties on Windows.
-validate
Checks the syntax and values of property settings defined in the specified properties file.
-help
Displays command-line Help.

Notes

*The ubroker.properties file stores all the configuration definitions for each instance of the NameServer, AppServer, DataServer and WebSpeed Transaction Server products. Each configuration definition contains environment variables, registry entries if Windows, and property settings for each product instance. Progress Explorer and certain command-line utilities, such as ODBCONFIG, use this file to store, validate and manage the configurations for the products.
*The ubroker.properties file is installed in the properties subdirectory of the OpenEdge installation directory. For example, %DLC%\properties\ubroker.properties on Windows.
*The 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.
For example, the DataServer for ODBC configurations in ubroker.properties might include:
Configuration entity name
Configuration entity function
[UBroker]
Defines default property settings for all NameServer, AppServer, DataServer, and WebSpeed Transaction Server brokers.
[UBroker.OD]
Defines default property settings for all instances of DataServers for ODBC.
[UBroker.OD.product–instance–name]
Defines property settings for this instance of a DataServer for ODBC. The ubroker.properties file may contain several of these entities each with a unique product–instance–name.
*Parent entities provide default values for all of their child entities. For example, the parent [UBroker] contains a set of definitions that can be inherited by its child [UBroker.OD], and then again by its child [UBroker.OD.product–instance–name]. 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.
*Optionally, you may edit the ubroker.properties file using a text editor such as Notepad. If you want to manually edit this file to create or modify a product configuration, begin by making a backup copy from the installed ubroker.properties file (and naming it for example, test.properties). Once you edit the properties file, use the relevant validation utility, such as ODBCONFIG for the DataServer properties and NSCONFIG for the Name Server properties, to validate the changes and make sure there are no syntax errors or conflicts.