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:
When you create a remote source, the host name or IP address and port number must match that of the running Server Accessory. 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
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 Server Accessory 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.
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 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 (Server Accessory). You can list these options in any order.
RemoteSource options are unique to RemoteSource declarations (that is, they're only used for remote sources).
These "select" options determine which records are sent to the client.