DISC

Contents | What's New | Quick Links

 

Software Installation and Setup

Introduction

Software Installation

Concepts and Design

Designing Applications

Omnidex Environments

SQL Reference

Omnidex API's

Utilities

Interfaces

Performance Guide

Troubleshooting Guide

Appendix

 

 

Environment Variables

 

Environment variables define system settings necessary to run Omnidex. These settings are defined through the export, set, or SETVAR commands on UNIX, Windows, or MPE platforms respectively. On OpenVMS, define TMPDIR and OAGLOBAL as logicals, and express all other variables as symbols.

On Windows systems, use the SET command through the DOS window or in a .bat file, or define them as permanent system or user variables. On UNIX systems, the commands to set the Omnidex Environment variables can be executed through Omnidex.profile, a UNIX shell script created during the ODXMAKE process.

Set the following Environment variables during the initial installation of Omnidex. These Environment variables can be reset as needed.

Sample .bat File

Related Links

OAGLOBAL

Required on all systems. Points to the oaglobal environment file located in the Omnidex root directory.

OMNIDEX_REG

Required on all systems. Sets the path and filename of the Omnidex registry file used for product licensing.

LD_LIBRARY_PATH

UNIX only; Required when using shared libraries. Points to the directory where the libraries used by Omnidex reside.

OMNIDEX_LIBS

Required on Windows. Required on all other platforms when using External Document Indexing. Points to the directory where the libraries used by Omnidex reside.

PATH

Required on Windows and Unix. Points to the directory where Omnidex executables reside.

CLASSPATH

Required for Java development on all platforms. Points to the Omnidex.jar file.

TMPDIR (All platforms)

SYS$SCRATCH can also be used on OpenVMS.

TMP can also be used on Windows platforms.

Recommended. Required for large database indexing operations. Points to the directory where Omnidex temporary files, including DBINSTAL scratch (unload) files, are built. TMPDIR takes precedence on all platforms.

 

Examples

UNIX

export OAGLOBAL="/omnidex/oaglobal.env"
export OMNIDEX_REG="/omnidex/odxreg"
export LD_LIBRARY_PATH="/omnidex/lib"
export OMNIDEX_LIBS="/omnidex/lib"
export PATH="/omnidex/bin:$PATH"
export CLASSPATH="/omnidex/bin/omnidex.jar:$CLASSPATH"
export TMPDIR="/temp"

Windows

set OAGLOBAL=c:\omnidex\oaglobal.env
set OMNIDEX_REG=c:\omnidex\odxreg
set OMNIDEX_LIBS=c:\omnidex\bin
set PATH=%PATH%;c:\omnidex\bin
set CLASSPATH=%CLASSPATH%;c:\omnidex\bin\omnidex.jar
set TMPDIR=c:\temp

OpenVMS

DEFINE OAGLOBAL "dka0:[OMNIDEX.LIB305]OAGLOBAL.ENV"
DEFINE OMNIDEX_REG "dka0:[OMNIDEX.LIB305]ODXREG."
DEFINE SYS$SCRATCH "dka0:[USERS.USER1.TEMP]"

Note that the Library path is not set on OpenVMS.

MPE/iX

SETVAR OAGLOBAL "OAGLOBAL.PUB.DISC"
SETVAR OMNIDEX_REG "ODXREG.PUB.SYS"

Note that the Library path is not set on MPE/iX. Also, temporary file space is managed automatically; therefore, there is no need to TMPDIR.

 

Sample .bat File

The following is a sample .bat file that sets the necessary environment variables on a Windows system. Note that the same type of executable file can be used on other platforms using the appropriate system syntax.

@echo off
rem - Odxset
Echo **************************************************
Echo * Odxset *
Echo * *
Echo * Setting Omnidex Environment to current version *
Echo **************************************************
echo on
set OMNIDEX_ADDIN=ON
set OAGLOBAL=C:\omnidex\oaglobal.env
set OMNIDEX_LIBS=C:\omnidex\bin
set OMNIDEX_REG=C:\omnidex\odxreg
path =C:\omnidex\bin;%PATH%

 

top

Dynamic Information Systems Corporation - Omnidex Version 3.8 Build 6 J15.03-Copyright © 2003

DISC | Documentation Home