Show Contents / Index / Search

Configuration File Options

The configuration file has three types of declarations: RemoteSource, LocalFilter and LocalSource. The file must start with a RemoteSource declaration followed by RemoteSource declaration options. Either LocalFilter or LocalSource declarations can appear next, followed by any number of declaration options specific to that declaration.

All configuration file options have a corresponding option or method in the Enterprise Server user interface, except for the restricted host list (which can only be created in the configuration file).

As you create or edit a configuration file, observe the following formatting rules:

  • Multiple options can be listed on a single line, or can be split across multiple lines.
  • No termination or continuation characters are required.
  • The comment character is the pound sign (#). It can appear anywhere on a line; anything after the comment character is ignored.
  • Declarations and options can end with a comma or semicolon, if desired.

    Note: The syntax examples in this document represent options two ways: optional items (items that may or may not be specified) are enclosed by square brackets ([]) and separated by vertical bars; required items (items that must be specified) are enclosed by braces ({}) and separated by vertical bars. All options are shown in italics.

RemoteSource Declaration

When you create a remote source, the host name or IP address and port number must match that of the running Databridge Server. The base source is implicit in the remote source. (When you create a remote source using the user interface application, you must explicitly create a base source via the Add to DBEnterprise command.)

For the RemoteSource declaration, you can use options from the SourceOptions table and the RemoteSourceOnlyOptions table. RemoteSourceOnlyOptions are unique to a RemoteSource and can follow only RemoteSource declarations. Options can be listed in any order. The syntax is as follows:

[ REMOTE ] SOURCE remotesourcename AT "hostnameoripaddress" PORT portnum RemoteSourceOptions

LocalSource Declaration

The LocalSource declaration specifies a local source that is derived from a base source. The user interface equivalent to this declaration is the Add local (filtered) source command on the context menu for a Databridge Server defined base source. The syntax is as follows:

[ LOCAL ] SOURCE localsourcename LocalSourceOptions

For the LocalSource declaration, you can use any combination of options from the SourceOptions. In addition, you can use FilterReference and LocalFilterOptions, which are unique to local sources. FilterReference uses the following syntax:

USING filtername [ ( parameterlist ) ]

where filtername is the name of a LocalFilter.

The optional parameterlist (which must be enclosed in parentheses) is a list of values that substitute for the formal parameters specified in the LocalFilter declaration. (See the ByBank filter and the OnlyBank1, OnlyBank3, OnlyBank99, and OnlyBank880 local sources declared in the BankDB.cfg sample configuration file.)

For an example of LocalFilterOptions syntax, see "LocalFilterOptions" at the end of this document.

LocalFilter Declaration

A local filter specifies conditions that are required of the updates (in addition to DBGenFormat FILTER conditions on the MCP Server) before they are sent to the client. The syntax is as follows:

FILTER filtername [ ( formalparameterlist ) ] localfilteroptions

The filtername can be any name and is the identifier that a LocalSource includes in the USING option. The optional formalparameterlist, which must be enclosed in parentheses, are the place-holder names that will be replaced by the actual values in the USING option. See the ByBank filter and the OnlyBank1, OnlyBank3, OnlyBank99, and OnlyBank880 local sources declared in the BankDB.cfg sample configuration file.

The localfilteroptions are listed in the FilterOptions table.

SourceOptions

SourceOptions can be used for RemoteSources or LocalSources. Once you describe the RemoteSource declaration, you can map the remote source into several local sources. Local sources can specify their own filtering in addition to the filtering already done by the Remote Source (Databridge Server). You can list these options in any order.

Option

Does this

Syntax

UI Setting

cache parent directory

-or-

cached in directory

Enables update caching and specifies the location of cached update files.

[ { CACHE | CACHED } [ IN | ON | AT ] DIRECTORY "path"

Cache directory in the Source Properties and Base Source Properties dialog boxes

checkpoint

Determines the frequency with which the Databridge Client commits (saves) updates from Enterprise Server.

CHECKPOINT [ CLIENT | CLIENTS ] [ EVERY ] numblocks [ AUDIT ] BLOCKS

 

CHECKPOINT [ CLIENT | CLIENTS ] [ EVERY ] numrecords [ UPDATE ] RECORDS

 

CHECKPOINT [ CLIENT | CLIENTS ] [ EVERY ] num { SECOND | SECONDS }

CHECKPOINT [ CLIENT | CLIENTS ] [ EVERY ] { QUIETPOINT | QPT }

Checkpoint Options dialog box

client count

Indicates the number of Databridge Clients that are expected to read the cached audit updates.

CLIENTS [ = ] number

Remove cache files when read n times in the Base Source Cache Properties and Source Cache Properties dialog boxes

restricted host list

Specifies Databridge Clients that have access to this Enterprise Server source. Leave blank to give all Databridge Clients access.

HOST { "hostname" | "ipaddress" }

 

Not available

view log

Determines if the log file opens at the end of each server or cacher run.

VIEW LOG = { ALWAYS [ASK] | NEVER | ON FAILURE [ ASK ] }

Show Log after tracking and Ask First in the Base Source Properties and Source Properties dialog boxes

RemoteSourceOnlyOptions

RemoteSource options are unique to RemoteSource declarations (that is, they're only used for remote sources).

Option

Does this

Syntax

UI Setting

on notify

Specifies a batch file or a command to run when Databridge Server sends a notification that more audit is available.

ON NOTIFY [ , ] RUN "commandfilepath"

When more audit is available, run in the Base Source Properties dialog box

maxwait

Specifies a maximum wait period, which essentially determines the number of times that Enterprise Server re-queries Databridge Server for new audit when caching updates.

MAXWAIT { FOREVER | DONTWAIT | numseconds [ SECONDS ] }

Wait for audit to cache / Max seconds in the Base Source Cache Properties dialog box

mirror directory

Specifies where mirrored audit files will be stored.

MIRROR [ IN | ON | AT ] DIRECTORY "path"

Mirroring parent directory in the Audit Mirroring Properties dialog box

modifies

Specifies whether the before-images, after-images (or both) of a base source are cached.

MODIFIES { AFTER IMAGES ONLY | BEFORE AND AFTER IMAGES }

Both before-images and after-images for modifies in the Base Source Cache Properties dialog box

retry

Specifies the time interval (in seconds) that Enterprise Server waits between queries for new audit.

RETRY numseconds

Wait for audit to cache in the Base Source Cache Properties Properties dialog box

LocalFilterOptions

These "select" options determine which records are sent to the client.

This option

Does this

Syntax

User interface equivalent

select from

Specifies which updates to send to the client from the indicated data set.

Use as many times as needed for other data sets.

ALL and * are equivalent.

SELECT { ALL | * } FROM datasetname [ WHERE expression ]

Note: If datasetname is a reserved word, it must be in quotation marks.

The syntax for expression is the same as that used for DBGenFormat (see the Databridge Host Administrator's Guide).

WHERE box in the Row Filter dialog box. See Filtering a Local Source.

 

select none from

Discard all updates from the indicated data set.

Use as many times as needed for other data sets.

SELECT NONE FROM datasetname

Note: If datasetname is a reserved word, it must be in quotation marks.

WHERE box in the Row Filter dialog box.

select from other data sets

Determines what to do with updates for data sets not specified by one of the first two options.

The NONE value discards all other updates.

ALL and * are equivalent.

SELECT { ALL | * | NONE } FROM OTHER DATASETS

WHERE box in the Row Filter dialog box.