Below is an example xdb.ini file. You will make most of the changes to this file through the Options utility. Do not change any of the sections that contain a warning not to change them. In most cases such changes will have no effect on the system. You must change such settings through the Options utility.
[CLIENT] XDBCFG=C:\ProgramData\Micro Focus\Enterprise Developer\mfsql\cfg\ [SERVER] XDBSERVE=XDBLOCAL XSRVCFG=C:\ProgramData\Micro Focus\Enterprise Developer\mfsql\cfg [ConnectionDefaults] AutoConnect=On Protocol=Win32Local,NetBIOS,TCP/IP ProtocolMap=64,1,8 Servers=XDBLOCAL DefaultServerName=XDBLOCAL NodeName=cXDBCLIENT [ClientFormats] DateFormat=ISO DatePicture=yyyy-mm-dd TimeFormat=ISO TimePicture=hh.mm.ss 24 MoneyPicture=-$$$$$$$$$,$$9.99 DecimalPicture=-zzzzzzzzz,zz9.99 WeekdayPicture=WWW FloatDecimalPlaces=2 TimeZone=0 ShortMonthNames=Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec LongMonthNames=January,February,March,April,May,June,July,August,September,October,November,December ShortWeekNames=Mon,Tue,Wed,Thu,Fri,Sat,Sun LongWeekNames=Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday [MultiUser] IsolationLevel=Cursor Stability TimeOutInterval=10 AutoCommit=On BackwardLog=Off ForwardLog=Off [Preferences] Confirm=NO SortMode=US (Portuguese,Dutch) EBCDIC SortSequence=EBCDIC AbortCharacter=<27> EscapeCharacter=` CompatibilityMode=DB2 CobolLiterals=Default DynamicSqlLiterals=Default CommaDecimal=0 SQLPath= [QueryRunOption] MaxRecords=ALL Execute=First Command ResultView=Table AllowEditing=Off AutoCommit=On NoLookForPrimaryKey=Off ShowPositiveSqlcode=Off HighlighNulls=Red UseHex=Off NoDispEmptyResult=Off ReadOnlyAlert=Off [QueryDefinition] QueryUsing=3PartName ProhibitCartesian=On ShowTablename=Off AutoJoinForeignKey=On AutoJoinPrimaryKey=Off AutoJoinLikeName=Off [Browser] ConfigType=-560 AutoRefresh=Off AutoStartup=On [SysAuthID] SysIBM=SYSIBM SysXdb=SYSXDB [Security] ClientSecurity=Off PasswordEnforceLevel=1 [ClientPaths] Executables=C:\Program Files (x86)\Micro Focus\Enterprise Developer\bin\ Application=C:\ProgramData\Micro Focus\Enterprise Developer\mfsql\cfg\ System=SYSTEM Temporary=C:\ProgramData\Micro Focus\Enterprise Developer\mfsql\cfg\tmp\ Overflow=C:\ProgramData\Micro Focus\Enterprise Developer\mfsql\cfg\tmp\ [Connection XDBLOCAL] Protocol=Win32Local PrimaryAuthorizationID=TUTORIAL CurrentLocation=SYSTEM
The xdb.ini file contains values used by Micro Focus client applications (such as SQLWizard). It specifies which Server you will use, what protocol will be used, and other default values. You set set these values using Options before you start your client program.
All of the changes you will make to xdb.ini should be made through the Options utility, accessible from the Options icon in the Micro Focus group window. There are comments in xdb.ini indicating those sections that should not or cannot be edited by hand. Some of these items are actually duplicates of values found in other configuration files, maintained in xdb.ini to ensure backward compatibility with older products. Others have too many choices to be edited easily.
However, there are some parameters that must be edited by hand. xdb.ini is a text file that can be edited with any standard text editor.
Each of the sections described below corresponds to an SQLWizard-related section of xdb.ini. There may be other sections in your xdb.ini file. These are used by other products, and are described in the related documentation.
For items that provide a choice of settings, the default is shown in bold.
[ConnectionDefaults]
The Connection Defaults section stores information about what to use as the default connection, and also about what protocols are available.
Servers=server1, server2
The Servers item lists all servers that you can access. When a new server becomes available, the server name is added to this list. Each server should have a corresponding [Connection server-name] section.
NodeName=client-name
This is the name by which your machine is known to all XDB Servers you use. This name should be unique among all machines that are trying to access any XDB Server or XDB Link on your network.
DefaultServerName=server-name
This is the name of the XDB Server you want to use.
AutoConnect=On|Off
If on, the Connect dialog box is not displayed when you start SQLWizard (unless security is also on). If off, the Connect dialog box will be displayed so that you can specify a Server, AuthID and Location when connecting.
Protocol=protocol1, protocol2 ProtocolMap=n1,n2
If you are running SQLWizard against an XDB Server Version 4 (or newer), you may need to add several values (separated by commas) to the Protocol and ProtocolMap parameters in the [ConnectionDefaults] section of your xdb.ini file. The xdb.ini file segment shown below adds TCP/IP and IPX/SPX protocol support to SQLWizard:
[ConnectionDefaults] Protocol=local,netbios,tcpip,spx ProtocolMap=32,1,8,4
The table below shows allowable values for the Protocol and ProtocolMap parameters:
| Protocol | ProtocolMap |
|---|---|
| netbios | 1 |
| namedpipes | 2 |
| spx | 4 |
| tcpip | 8 |
| appc | 16 |
| local | 32 |
| win32local | 64 |
[ClientPaths]
The paths in this section of xdb.ini correspond to the paths that you set on the Paths tab of the Options utility. For more complete descriptions of these options, see Paths Tab.
Executables=default-directory
Path to the directory where executables are stored.
Application=application-path\
Path to the directory where the system should write or look for application files such as SQL scripts and import/export batch files.
Temporary=temporary-path\
Path to the directory where SQLWizard writes temporary files, such as temporary query result files.
Overflow=alternate-temporary-path
Not currently used. An alternative directory where SQLWizard can write temporary files.
System=system-location
The name of the system location.
[ClientFormats]
This section of xdb.ini corresponds to the items that you set on the Formats tab of the Options utility. For more complete descriptions of these options, see Format Tab.
DateFormat=USA|EUR|ISO|JIS|LOCAL
Indicates the default date format to be used when displaying or entering dates.
DatePicture=dd.mm.yyyy
Indicates the date picture to be used if DateFormat is set to LOCAL. See Date Pictures Overview for a description of the date picture format.
TimeFormat=USA|EUR|ISO|JIS|LOCAL
Indicates the time format to be used when displaying or entering dates.
TimePicture=hh.mm.ss 24
Indicates the time picture to be used if TimeFormat is set to LOCAL. See Time Pictures Overview for a description of the time picture format.
MoneyPicture=-$$$$$$$$$,$$9.99
The money picture to be used when displaying or entering monetary amounts. See Numeric Masks Overview for a description of the money picture format.
DecimalPicture=-zzzzzzzzz,zz9.99
The decimal picture to be used when displaying or entering decimal numbers. See Numeric Masks Overview for a description of the decimal picture format.
WeekdayPicture=WWW
The format to be used when displaying or entering weekdays. See the Date Picture Elements for the weekday picture format.
FloatDecimalPlaces=2
Number of decimal places to be displayed for float fields.
TimeZone=0
The timezone offset from Greenwich Mean time. This is used for time math.
ShortMonthNames=Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec
The strings to be used for the MMM formatted month portion of the date format.
LongMonthNames=January,February,March,April,May,June,July,August,September,October,November,December
The strings to be used for the MMMM formatted month portion of the date format.
ShortWeekNames=Mon,Tue,Wed,Thu,Fri,Sat,Sun
The strings to be used for the WWW formatted weekday portion of the date format.
LongWeekNames=Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
The strings to be used for the WWWW formatted weekday portion of the date format.
[MultiUser]
This section of xdb.ini corresponds to the items that you set on the Multiuser tab of the Options utility. For more complete descriptions of these options, refer to the Multiuser Tab.
IsolationLevel=Lock Current
Indicates the isolation level to be used by default.
AutoCommit=On|Off
Indicates whether AUTOCOMMIT should by default be turned on or off.
TimeOutInterval=n
Indicates (in seconds) how long to wait before retrying when a lock conflict occurs.
BackwardLog=On|Off
Indicates whether the Backward Log is on or off. Not used when accessing an XDB Server Version 5.0 or higher.
ForwardLog=On|Off
Indicates whether the forward log (used for recovery) is on or off. Ignored by remote XDB Servers (Win3.x).
[Preferences]
This section of xdb.ini corresponds to the items that you set on the SQL tab of the Options utility. For more complete descriptions of all of these options, refer to the SQL Tab.
Other xdb.ini items that correspond to items on the SQL tab are described later in the description of the [SysAuthID] section.
CompatibilityMode=DB2|XDB|ANSI
The SQL compatibility mode to be used. This option indicates which set of SQL rules will be enforced.
EscapeCharacter=`
The character used to precede a special character to turn it into a literal.
AbortCharacter=<27>
The character used to halt some operations. For future use.
SortSequence=Case Insensitive ASCII (A=a,...)
Specifies the sort sequence that is to be used as the default for creating a location.
[QueryRunOption]
This section of xdb.ini corresponds to the items that you set on the Query Run tab of the Options utility. For more complete descriptions of these options, refer to the Query Run Tab.
MaxRecords=ALL|n
Indicates if all records should be retrieved or only the first n records when a query is run.
Execute=All Command|First Command|Current Command
Indicates if only the first, the current, or all commands in the current query window should be executed. The ALL and FIRST options apply to the SQL Edit window and batch SQL scripts. The CURRENT option applies only to the SQL Edit window.
ResultView=Table|Form
Indicates whether the default Result view should be a RESULT TABLE or a RESULT FORM window.
AllowEditing=On|Off
Indicates whether the system should by default try to go into Edit Mode when displaying a query result. If off, you must switch to Edit Mode yourself.
NoLookForPrimaryKey=On|Off
Specifies whether, during an edit-mode query, SQLWizard automatically searches the SYSINDEX and SYSKEYS tables and adds unique key fields to the query, even if the user has not explicitly selected them. Such action allows SQLWizard to generate the appropriate WHERE clause should the user subsequently choose to update any of the extracted data.
On certain databases (such as large DB2 3.x locations without a shadow catalog), the search for unique key fields can result in extremely long query times.
If your database has been designed so that a unique key is always selected, this option can be turned on to eliminate the search for unique keys, thereby improving performance.
AutoCommit=On|Off
Indicates whether AUTOCOMMIT should be on or off.
[QueryDefinition]
This section of xdb.ini corresponds to the items that you set on the Query tab of the Options utility. For more complete descriptions of these options, refer to the Query Tab.
QueryUsing=3PartName|2PartName|1PartName
Indicates if table names should be qualified when they are inserted into queries or dragged to the SQL Edit window from the Catalog Browser.
ShowTablename=On|Off
Indicates whether the default for the Query Design window should be to show table names in the Query Conditions Grid. If on, table names are shown.
ProhibitCartesian=On|Off
Indicates whether the default for prohibiting Cartesian products should be on or off.
AutoJoinForeignKey=On|Off
Indicates if tables should be automatically joined on foreign key relationships.
AutoJoinPrimaryKey=On|Off
Indicates if tables should be automatically joined on primary keys and columns with like names in another table.
AutoJoinLikeName=On|Off
Indicates if tables should be automatically joined on like column names. Turn off with care!
[Browser]
This section of xdb.ini corresponds to the items that you set on the Browser tab of the Options utility. For more complete descriptions of these options, refer to the Browser Tab.
ConfigType=n
Modify this option only through Options.
AutoRefresh=Off|On
Not currently used. Always off
AutoStartup=On|Off
If on, the Catalog Browser is automatically loaded when SQLWizard is started (you may want to do this to make SQLWizard load faster). If off, you must access the Catalog Browser through the View menu.
[SysAuthID]
This section of xdb.ini corresponds to the items that you set in the SysAuthID section of the SQL tab of the Options utility. Other xdb.ini items that correspond to items on the SQL tab are described previously in the description of the [Preferences] section. If you receive errors when you try to connect to DB2, you should suspect that you do not have privileges on the system catalog tables or views with the AuthIDs currently set. For more complete descriptions of all of these options, refer to the SQL Tab.
SysIBM=SYSIBM
Specifies the AuthID to be used when issuing queries against system catalog tables owned by SYSIBM. Often you will only have privileges on a view on the system catalog tables. Usually the view is created using the same table name, but a different AuthID than the underlying table. When running against XDB Link to DB2, you will usually use SYSIBM=XDB instead of SYSIBM=SYSIBM.
SysXdb=SYSXDB
Specifies the AuthID to be used when issuing queries against system catalog tables owned by SYSXDB. Often you will only have privileges on a view on the system catalog tables. Usually the view is created using the same table name, but a different AuthID than the underlying table. When running against XDB Link to DB2, you will usually use SYSXDB=XDB instead of SYSXDB=SYSXDB.
[Security]
This section of xdb.ini corresponds to the Client Security items that you set on the Security tab of the Options utility. For a more complete description of this option, refer to the Security Tab. (Other items that may appear in this section are used to configure server security.)
ClientSecurity=On|Off
If on, you will have to provide a password to connect to the XDB Server. If off, you will not be asked for a password.
[Connection server-name]
There should be an instance of this section for every server listed in the Servers statement in the [Connection Defaults] section. The items specified here indicate how to make a connection to the named server. They are used in the Options Connect page.
Protocol=protocol
This is the protocol to be used when accessing the specified server. See the Connection Defaults section for a list of protocols.
PrimaryAuthorizationID=authid
This is the default user name that will be used when you connect to this server.
CurrentLocation=location-name
This is the name of the default location that will be provided when you connect to this server.
[Client]
This section contains client-side parameters.
XDBCFG=configuration-directory
This is the path of the configuration directory on the client.
ReceiveBufferSize=size
This is the size of the communications buffer on the client side. The default is approximately 60 Kb.
BulkFetch=0|1
If 1, the default, bulkfetch is on.
ANSICP=ANSI-code-page
The ANSI code page to use on the client-side.
OEMCP=OEM-code-page
The OEM code page to use on the client-side.
[Server]
This section contains server side parameters
XDBSERVE=server-name
This is the name of the default server.
XSRVCFG=configuration-directory
This is the path of the configuration directory on the server.
ReceiveBufferSize=size
This is the size of the communications buffer on the server side. The default is approximately 60 Kb.
[Trace]
This section specifies parameters that need to be set if you want to generate debugging information by turning on client/server traces.
RedirSndRcvTrace=redir-trace-path
This is the path of the client redirector rrace file, for example, c:\redir.trace.
RouterTrace=router-trace-path
This is the path of the router trace file, for example, c:\router.trace.
TraceType=type
This is usually set to 1, although Micro Focus Technical Support representatives might ask you to change this setting.
FileName=engine-trace-path
This is the path of the engine trace file, for example, c:\server.trace.
Flush=0|1
This determines whether or not the trace file is flushed to disk after each trace file entry. The default is 1, which causes the trace file to be flushed to disk after each entry.
ErrorLog=log-file-path
This is the path of the error log file, for example, c:\xmem.errors.