Directives

ODXAIM operates through the use of command line directives. Many of the option settings can also be defined within a configuration file. With the exception of the configuration filespec, all options are preceded with a - (dash). For a list of available options, run ODXAIM with the -help or -? directive.

c:\omnidex\demo>odxaim -?
OdxAIM - Omnidex Automatic Indexing Manager

Valid directives are:

Start up ODXAIM monitoring process

odxaim [cfgfile]
[-env=OAEnvFile]
[-sleepint=n]
[-sleepstep=n]
[-sleepmin=n]
[-sleepmax=n]
[-colsep=c]
[-datasep=d]
[-nontservice]

Shut down ODXAIM monitoring process

odxaim -shutdown [cfgfile] [-env=OAEnvFile]

Generate triggers - Setup

odxaim -gentrigger
[-file=newtrigfile]
[cfgfile]
[-env=OAEnvFile]
[-newenvsrc=newenvsrcfile]
[-genericaimtables=(oatablelist)]
[-colsep=c]
[-datasep=d]
[-overwrite]

Generate environment source entries

odxaim -genodxtrans
[-file=envsource]
[-env=OAEnvFile]
[-genericaimtables=(oatablelist)]
[-newfile | -append]

Install ODXAIM as a Windows service

odxaim cfgfile
[-ntservice=unique_service_name]
[-ntsrvaction={INSTALL | INSTALL_AUTO | DELETE |
START | STOPT | PAUSE | CONTINUE}]

Get help

odxaim -help | -?

Get version information

odxaim -version

Start the ODXAIM Monitoring Process

Unless ODXAIM is installed as a Windows Service, the ODXAIM monitoring process is started from a system prompt. Each ODXAIM process monitors a single OMNIDEX environment.

The following directives can be used in conjunction with the -env directive, to override default settings.

[-sleepint=n] - n is the number of seconds to sleep before polling the odxtrans tables for more transactions.

[-sleepstep=n] - n is the incremental step value to ease performance when polling the odxtrans tables.

[-sleepmin=n] - n is the minimum sleep value to wait before polling the odxtrans tables.

[-sleepmax=n] - n is the maximum sleep value used (sleepstep is no longer added to sleep time).

[-colsep=c] - c is the column separator character. Default ~ (tilde).

[-datasep=d] - d is the data separator character. Default ^ (carat).

[-nontservice] - Allows you to start an ODXAIM process, without linking to the SCM, when ODXAIM is installed a Windows service.

-colsep and -datasep are only necessary when using the generic transaction tables. In this case, all data from the updated columns is concatenated together into a single character column, separated by the -colsep and -datasep characters.

Start the ODXAIM process by passing either an ODXAIM configuration file specification,

odxaim c:\omnidex\demo\ordersaim.cfg

or the -env directive with the OMNIDEX environment file specification and any desired configuration settings.

odxaim -env=c:\omnidex\demo\orders.env

The first example starts an ODXAIM process using the configuration settings, including the OMNIDEX environment file specification, defined in the configuration file ordersaim.cfg.

The second examples starts an ODXAIM process to monitor the OMNIDEX environemnt orders.env, using default settings.

Shut down the ODXAIM Monitoring Process

Unless ODXAIM is installed as a Windows Service, the ODXAIM monitoring process can be shut down by passing the -shutdown directive along with either the -env directive or the configuration file specification, depending on how the process was started.

odxaim -shutdown cfgfile
Shut down ODXAIM process that was started against the specified configuration file. cfgfile is the fully qualified configuration filespec that ODXAIM was started with.

odxaim -shutdown c:\omnidex\demo\ordersaim.cfg

odxaim -shutdown -env=OAEnvFile
Shut down ODXAIM process that was started against the specified environment. OAEnvFile is the fully qualified environment filespec that ODXAIM was started against.

odxaim -shutdown -env=c:\omnidex\demo\orders.env

On Windows, an ODXAIM process not running as a Windows service can also be stopped by entering control+c in the same DOS window in which the process is running.

Generate the Triggers

The -gentrigger directive connects to the specified OMNIDEX environment and generates an SQL script file containing the CREATE TABLE statements for the ODXAIM transaction tables and the triggers to install on the underlying database.

The OMNIDEX environment is specified either inside a configuration file

odxaim -gentrigger c:\omnidex\demo\ordersaim.cfg

or with the -env=OAEnvFile directive.

odxaim -gentrigger c:\omnidex\demo\orders.env

The following directives can be used in conjunction with the -gentrigger directive.

[cfgfile] - The ODXAIM configuration file. -gentrigger must be accompanied by either a configuration file specification or -env directive.

[-env=OAEnvFile] - OAEnvFile is the OMNIDEX environment catalog. -gentrigger must be accompanied by either a configuration file specification or -env directive.

[-file=newtrigfile] - The output file specification for the SQL script. Can be used with either the -env directive or the configuration file specification. If omitted, ODXAIM will prompt for the output file specification.

[-newenvsrc=newenvsrcfile] - Generates the environment source entry for the ODXAIM transaction tables. newenvsrcfile is the output file. Can be used with either the -env directive or the configuration file specification.

[-genericaimtables=(oatablelist)] - A comma separated list of tables (no spaces) that will use the generic transaction table. Can be used with either the -env directive or the configuration file specification.

[-colsep=c] - c is the column separator character. Default ~ (tilde). Only for use with the configuration file specification.

[-datasep=d] - d is the data separator character. Default ^ (carat). Only for use with the configuration file specification.

[-overwrite] - Instructs ODXAIM to overwrite the ouput files if they already exist. If omitted and the output file exists, ODXAIM will error. Can be used with either the -env directive or the configuration file specification.

-colsep and -datasep are only necessary when using the generic transaction tables. In this case, all data from the updated columns is concatenated together into a single character column, separated by the -colsep and -datasep characters.

odxaim -gentrigger c:\omnidex\demo\orders.env -file=c:\omnidex\demo\aimtriggers.sql -newenvsrc=aimsrc.src

Generate Environment Source Entries

The -genodxtrans directive onnects to the specified OMNIDEX environment and generates the environment source file entries for the ODXAIM transaction tables.

The following directives can be used in conjunction with the -genodxtrans directive.

[-file=envsource] - The output file specification.

[-env=OAEnvFile] - The OMNIDEX environment catalog that will be monitored by ODXAIM.

[-genericaimtables=(oatablelist)] - A comma separated list of tables (no spaces) that will use the generic transaction table.

[-newfile | -append] - Create a new file or append to the end of an existing file. If the file already exists and -newfile was passed, the existing file will be overwritten.

If any of the tables will use the generic transaction table, the table list passed with the -genericaimtables directive must match the table list passed when the triggers were generated.

This step can be combined with the trigger generation by using the -newenvsrc directive. The -genodxtrans directive will not be used in this case.

odxaim -gentrigger c:\omnidex\demo\orders.env -newenvsrc=aimsrc.src

The above example is the same as the following example:

odxaim -gentrigger c:\omnidex\demo\orders.env

odxaim -genodxtrans c:\omnidex\demo\orders.env -newfile=aimsrc.src

Both examples produce the same output but the first is simpler.

Windows Service

ODXAIM can be installed as a Windows service which can be maintained using the Windows Service Manager. The initial setup steps must be performed prior to installing ODXAIM as a service, meaning the triggers must be generated and installed on the database and the environment source entries must be added to the OMNIDEX environment catalog.

The following directives are provided to install and maintain ODXAIM as a Windows service. These directives are required for installation. However, DISC recommends that the Windows Service Manager be used for maintaining the service.

odxaim cfgfile
[-ntservice=unique_service_name]
[-ntsrvaction={INSTALL | INSTALL_AUTO | DELETE |
START | STOPT | PAUSE | CONTINUE}

To install ODXAIM as a Windows service, you must pass the fully qualified filespec of the configuration file, along with either the INSTALL or INSTALL_AUTO directive.

INSTALL - Simply installs ODXAIM as a service.

INSTALL_AUTO - Installs ODXAIM as a service that starts automatically when the system restarts.

These settings can be changed manually using the Windows Service Manager.

odxaim c:\omnidex\demo\ordersaim.cfg -ntsrvaction=INSTALL

The next five options are passed with the -ntsrvaction directive to maintain the service. Please note that, with the exception of DELETE, all of these actions can also be accomplished using the Windows service manager (recommended).

DELETE
Remove this service. If this action is performed, the service will have to be re-installed.

odxaim c:\omnidex\demo\ordersaim.cfg -ntsrvaction=DELETE

START
Start the installed ODXAIM service. If the service was stopped or paused or was not set to start automatically when the system reboots, it can be started using this action.

odxaim c:\omnidex\demo\ordersaim.cfg -ntsrvaction=START

STOP
Stop the installed ODXAIM service.

odxaim c:\omnidex\demo\ordersaim.cfg -ntsrvaction=STOP

PAUSE
Pause the installed ODXAIM service.

odxaim -ntservice=ODXAIM_SALES -ntsrvaction=PAUSE

CONTINUE
Restart the installed, paused ODXAIM service.

odxaim -ntservice=ODXAIM_SALES -ntsrvaction=continue

-ntservice=unique service name
This directive allows ODXAIM to be installed multiple times on the same server using unique service names. Pass this option when installing the service. If multiple services are to be installed, each service must have a unique name.

odxaim c:\omnidex\demo\ordersaim.cfg -ntsrvaction=INSTALL -ntservice=ODXAIM_Sales

odxaim c:\omnidex\demo\ordersaim2.cfg -ntsrvaction=INSTALL_AUTO -ntservice=ODXAIM_Accounting

Getting Help

To display ODXAIM help, run ODXAIM at the system prompt followed by on of the following two directives:

-help

-?

The -help and -? directives are synonymous

c:\omnidex\demo>odxaim -help
OdxAIM - Omnidex Automatic Indexing Manager

Valid directives are:

odxaim [cfgfile]
[-env=OAEnvFile]
[-sleepint=n]
[-sleepstep=n]
[-sleepmin=n]
[-sleepmax=n]
[-colsep=c]
[-datasep=d]
[-nontservice]

odxaim -shutdown [cfgfile] [-env=OAEnvFile]

odxaim -gentrigger
[-file=newtrigfile]
[cfgfile]
[-env=OAEnvFile]
[-newenvsrc=newenvsrcfile]
[-genericaimtables=(oatablelist)]
[-colsep=c]
[-datasep=d]
[-overwrite]

odxaim -genodxtrans
[-file=envsource]
[-env=OAEnvFile]
[-genericaimtables=(oatablelist)]
[-newfile | -append]

odxaim cfgfile
[-ntservice=unique_service_name]
[-ntsrvaction={INSTALL | INSTALL_AUTO | DELETE |
START | STOPT | PAUSE | CONTINUE}]

odxaim -help | -?

odxaim -version

Getting Version Information

To display ODXAIM version information, run ODXAIM at the system prompt followed by the -version directive.

C:\test>odxaim -version
Omnidex Automatic Indexing Manager 1.3.00
odxaim compiled Dec 15 2004 06:49:12

OmniAccess 4.1 Build 4F

C:\test>

Top