Database File Handling Environment Variables

The following environment variables all relate to the configuration of the database file handler, which enables you to store your data files for enterprise server applications within a supported database.

ES_DB_FH

Enables or disables database file handler support. This is required if your data files are stored in a datastore, or your enterprise server region stores some of its resources in a database; see Micro Focus Native Database File Handling and Enterprise Server Region Database Management for more information.

Syntax

UNIX:
ES_DB_FH=value
export ES_DB_FH

Windows:
SET ES_DB_FH=value

Values

• Y|y|true - file handling is directed through the Micro Focus Database File Handler (MFDBFH).
• N|n|false - database file handler support is disabled.

Default

Database file handler support is disabled.

ES_DB_SERVER

Specify the name of the database server to be used for region database operations.

There also needs to be a corresponding <server> entry for the database server within the configuration file specified by the MFDBFH_CONFIG environment variable. <dsn> entries for the region, cross-region and master databases must also be specified in the configuration file to enable use of region database operations.

Syntax

UNIX:
ES_DB_SERVER=server-instance
export ES_DB_SERVER

Windows:
SET ES_DB_SERVER=server-instance

Values

server-instance is the name of a valid database server instance. For example, set ES_DB_SERVER=(local)\SQLEXPRESS.

Default

Not set.

Example

Using the example above, you would be required to have something similar to that below in your database configuration file:

<?xml version="1.0" encoding="utf-8"?> 
<datastores usevault="false">
   <server name="(local)\SQLEXPRESS" type="sqlserver" access="odbc"> 
       <dsn name="SS.MYMASTER" type="database" dbname="master"/> 
       <dsn name="SS.CAS.ESDEMO" type="region.cas" region="ESDEMO" feature="all"/> 
       <dsn name="SS.CAS.CROSSREGION" type="crossregion.cas"/>
   </server> 
</datastores>

ES_LOCKDB

Specifies the region database that is to process resource locking (step- and system-scoped ENQs) for an enterprise server within a cluster, where resources (such as spool queues and catalogs) are deployed to a database.

Syntax

UNIX:
ES_LOCKDB=region-db
export ES_LOCKDB

Windows:
SET ES_LOCKDB=region-db

Parameters

region-db

region-db is the name of the region database responsible for processing step- and system-scoped ENQs.

MFDBFH_CONFIG

Specifies the location and the name of the configuration file that defines the database server instances and associated databases.

Syntax

UNIX:
MFDBFH_CONFIG=value
export MFDBFH_CONFIG

Windows:
SET MFDBFH_CONFIG=value

Values

value represents the full path and filename of your database configuration file.

Default

Not set.

MFDBFH_GRANT_USER_PERMISSIONS [15]

Grants execute privileges to specific users or roles, for types and procedures that are created when configuring an Oracle database for MFDBFH access.

Syntax

UNIX:
MFDBFH_GRANT_USER_PERMISSIONS=value
export MFDBFH_GRANT_USER_PERMISSIONS

Windows:
MFDBFH_GRANT_USER_PERMISSIONS=value

Values

value is a space-separated list of users and/or roles that will be granted to execute privileges to the types and procedures created by MFDBFH.

Default

Not set.

Notes

If the variable is not specified, the Oracle default permissions are applied, which are to grant execute permissions to the schema owner of that type/procedure only.

This variable has no effect on permissions for any other database provider used with MFDBFH.

MFDBFH_RECORD_LOCKING

Specifies the type of record locking that it is to be used when the database file handler is in effect.

Syntax

UNIX:
MFDBFH_RECORD_LOCKING=table|database
export MFDBFH_RECORD_LOCKING

Windows:
SET MFDBFH_RECORD_LOCKING=table|database

Parameters

table

A file's record locks are held in a seperate lock table. (When using this locking mode, the behavior of record locking COBOL file operations closely follows the same behavior when using Fileshare.)

database

The native record locking mechanism of the database engine is used to establish and test locks on the data file records. This method improves performance, but at the cost of the locking behavior not exactly matching that of traditional COBOL record locking; see Record Locking Strategies for more information.

Default

MFDBFH_RECORD_LOCKING=table

Note: If the value of this variable is set to anything other than 'database', this default is used.

MFDBFH_SCRIPT_DIR

Specifies the location of the scripts and stored procedures required when the database file handler is in effect.

Syntax

UNIX:
MFDBFH_SCRIPT_DIR=value
export MFDBFH_SCRIPT_DIR

Windows:
SET MFDBFH_SCRIPT_DIR=value

Values

value represents a path to the directory containing the required resources.

Default

value defaults to the \etc\mfdbfh\scripts sub directory of your product installation directory.

MFDBFH_VAULT

Specifies the name of a secrets vault (which must be defined in the product's secrets.cfg file). If this environment variable is not set, MFDBFH uses the default vault, as defined in secrets.cfg.

For more information on secrets vaults, see Vault Facility.

Syntax

UNIX:
MFDBFH_VAULT=value
export MFDBFH_VAULT

Windows:
SET MFDBFH_VAULT=value

Values

value represents the name of a vault.

Default

Not set.