DISC

Contents | What's New | Quick Links

 

ODXSRVR

Introduction

Software Installation

Concepts and Design

Designing Applications

Omnidex Environments

SQL Reference

Omnidex API's

Utilities

Interfaces

Performance Guide

Troubleshooting Guide

Appendix

 

 

ODXSRVR Configuration File

Preconnected ProcessesODXSRVR

 

The ODXSRVR configuration file contains settings used by Omnidex Network Services (ODXSRVR) for establishing a listener process. Many of the settings have defaults that will be used if a configuration file is not provided, however, some of ODXSRVR's most powerful features require this file and will be disabled without it.

  • Mapped Memory Transport is a feature designed for Windows NT single-tiered applications for thread-safeness against the OA API. This feature is enabled in the ODXSRVR configuration file with the UseMappedMemory setting.

Setup

Syntax

Windows Service

Interactive Process

Preconnected Processes

Mapped Memory Transport

Configuration File

Settings

  • The ODXSRVR configuration file is required when using ODXSRVR as a Windows NT service.
  • Preconnected processes will automatically establish a predetermined number of connections to a specified environment when the listener is started, eliminating the connect wait time for client requests. Each environment that will have preconnected processes be defined in both the Preconnect section and in its own section in the ODXSRVR configuration file.
  • The NSADMIN (Network Services Administrator) utility provides a means of remotely monitoring and administering an ODXSRVR process running on any server, from a Windows client machine. In order for NSADMIN to connect to a listener process, the NSADMIN section must be defined in the configuration file.
  • Other features such as security checking, auditing and logging, debugging, data conversion, connect options and more can be enabled, disabled, and defined in the ODXSRVR configuration file.

The configuration file is passed to ODXSRVR as an argument at the command prompt.

MPE

run odxsrvr.cs;info="SRVRCFG.FFL.DATA"

Unix

odxsrvr /users/data/flatfile/oa/odxs1232.cfg

Windows NT

odxsrvr c:\omnidex\bin\odxs1232.cfg

top

 

Configuration File Settings

General | NSAdmin | Security | Auditing | Preconnected Processes | TCP Sockets | Debug

 

General Section

[General]

CompressData determines whether data sent from server to client is compressed. 0 = disable, 1 = enable

CompressData=1

HebrewReversal reverses the sequence of characters so that text such as Hebrew and Arabic reads correctly from right to left. 0 = disable character reversal (display left to right), 1 = enable character reversal (display right to left).

HebrewReversal=0

Protocol indicates data communication protocol between client and server. TCP Sockets TCP/IP sockets connection (only protocol currently supported)

Protocol=TCPSOCKETS

UseMappedMemory enables/disables the use of mapped memory to coordinate multi-threaded clients that exist on the same cpu as the odxsrvr program. This feature is only available on Windows NT. 0 = don't use mapped memory IPC, 1 = setup/use mapped memory.

UseMappedMemory=0

SkipPreconnections overrides the preconnected environment settings defined in the [Preconnect] section. 0 = Use the preconnection settings, 1 = Skip the defined preconnections.

SkipPreconnections=0

Security checks and honors the security settings defined in the [Security] section. 0 = Ignore the security settings in the [Security] section, 1 = Use the security settings in the [Security] section.

Security=1

Auditing enables/disables the new logging and general auditing feature. Configured in the [Auditing] section. 0 = Disable auditing, 1 = Enable auditing.

Auditing=0

Loggin enables/disables the old (no longer recommended) logging feature. Configured in the [Logging] section. 0 = Disable logging, 1 = Enable logging.

Logging=0

UseDomainNameServices enables/disables translation of client IP addresses into domain names for Logging and Debug lists. 0 = List IP address only, 1 = List IP address and domain name

UseDomainNameServices=0

TrackSQL determines if SQL Query statements are allowed to be traced by NSAdmin while they are executing. There is a small amount of extra overhead when enabled, but likely well worth the advantage in order to view a client's query from NSAdmin and if necessary, stop its process.

TrackSQL=1

top

NSAdmin Section

[NSAdmin]

Security forces the user to enter a password when running NSADMIN against this listener. 0 = No password necessary, 1 = Requires the password.

Security=1

Password defines the password the user will be required to enter when running NSADMIN against this listener.

Password=xyz

; Password for NSAdmin to check

top

Security Section

[Security]

CheckODXSYSSecurity checks user and password passed in oaconnect parameters or from an earlier, pre-connection packet passed from the client. 0 = Disable, 1 = Enable

CheckODXSYSSecurity=0

PromptForUserPassword prompts the user for a password. This is only a good idea when there is an actual person as the client using odxcl32 and the user is expecting to be prompted. 0 = Do not prompt the user, 1 = Prompt the user.

PromptForUserPassword=0

CaseSensitiveUserPassword enables/disables case sensitivity when checking odxsys. 0 = Not case sensitive, 1 = Case sensitive.

CaseSensitiveUserPassword=0

SecurityTableName defines the name of table that contains unique userids and passwords. Default is USERS.

SecurityTableName=USERS

SecurityUserIDColumn defines the name of column in security table that contains the userid. Default is USERID

SecurityUserIDColumn=USERID

SecurityPasswordColumn defines the name of column in security table that contains the users' passwords. Default is PASSWORD.

SecurityPasswordColumn=PASSWORD

DataEncryption determines whether data sent across network is encrypted. 0 = No data encryption, 1 = Data is encrypted.

DataEncryption=1

top

Auditing Section

[Auditing]

LogFile defines the tdf file to output the audit data to.

LogFile=odxlog.tdf

UserIdRequired determines if a userid must be passed with oaconnect. The userid is defined in odxsys. 0 = Userid not required, 1 = UserId required.

UserIdRequired=1

Enable or Disable the following log events:

oaconnect and oadisconnect calls are always logged. This cannot be disabled.

Connects=1
Disconnects=1

QueryResults logs SQL statements sent through oaexecsql and oaselect and logs any particular omnidex optimization performed, the number of columns and rows fetched.

QueryResults=1

FetchColumns logs Fetched table/columns. column names placed in the EventDetail column in the UserEvents table

FetchedColumns=1

Cursors logs oaopencursor and oaclosecursor calls.

Cursors=1

Qualifies logs calls to oaqualify, oajoin, oaexport, and oafetchkeys.

Qualifies=1

Queries Logs calls to oaexecsql, oaselect, oalist, oaform

Queries=1

Updates Logs calls to oainsert, oaupdate, oadelete, oaupdatewhere, oadeletewhere

Updates=1

Externals Logs calls to oaexternal, oaexecdb, and oacommand

Externals=1

MiscAPIs Logs calls for the rest of the API

MiscAPIs=0

Failures Logs failed calls for settings selected

Failures=1

top

Preconnected Processes Section

[Preconnected Processes]

The name of the environment to connect to. Any client datasources that want to use the preconnections for this environment must have the "DATASOURCENAME" exactly the same as this name. It is possible to have multiple entries in this section.

ORDERS=Orders Database

Each entry in the [Preconnected Processes] section requires its own [Preconnect name] section.

[Preconnect ORDERS]

EnvironmentFile=C:\data\oracle\oa\orders.env

NativePassword is used for connecting directly to TurboImage instead of an OmniAccess environment file.

;NativePassword=USERPASS;

ConnectOptions sets the connect options for all client connections using these preconnected processes. Note that connect options passed from the client will be ignored.

ConnectOptions=READ

InitialConnectionCount sets the number of connection to automatically start when the odxsrvr listener starts.

InitialConnectionCount=5

ConnectionLimit sets the maximum number of connections to run for this environment.

ConnectionLimit=20

GrowthThreshold defines at what point more preconnected processes should be started. When the number of existing preconnected processes being used by clients reaches this percentage, more processes will start, up to the ConnectionLimit.

GrowthThreshold%=80

Growth defines how many processes are started when the GrowthThreshold is reached.

Growth%=20

ReUsePreconnections determines if a used client odxsrvr process should be reused. 0 = Don't reuse this process. Close it and start a new one. 1 = Reuse this process.

ReUsePreconnections=1

top

TCPSockets Section

[TCPSockets]

PortId sets the listener port id number. This number is defined in client datasource files and is where ODXSRVR listens for TCPSockets connection requests.

PortId=7444

MaxRequests defines the maximum number of concurrent client requests.

MaxRequests=64

MPE_SpawnQueue is valid only on MPE and indicates the priority queue conferred to sockets subprocesses. BS = linear queue priority (not advised), CS = session priority, DS = job priority, ES = lowest priority available.

MPE_SpawnQueue=CS

StartPortId and StopPortId define the beginning and end range of values that ODXSRVR can assign to socket subprocesses. This range can be used to set the maximum number of concurrent clients allowed for this listener. Required when running multiple ODXSRVR listeners on the same host. These settings are ignored in a Unix forking environment when no preconnected process are used.

StartPortId=7501
StopPortId=7599

top

Debug Section

[Debug]

Sets debugging options for client applications connecting through this listener.

FileSpec defines where the debug information should be output to. The filename must be valid according to operating system requirements (host) and ODXSRVR must have write access to it.

FileSpec=C:\TEMP\APIDBUG.txt

Compression specifies whether or not to display data compression information. 0 = Do not display, 1 = Display all data compression information.

Compression=0

PacketDriver specifies whether or not to display all communication packets sent/received. 0 = Do not display, 1 = Display all communication packets.

PacketDriver=0

TimeCalls indicates whether or not to display the CPU time required to complete each call to a routine. 0 = Do not display, 1 = Display elapsed time.

TimeCalls=0

The entries below are used to enable/disable debugging for individual routines. 0 = Disable debugging, 1 = Enable debugging.

oaassignvalues=0
oabind=0
oaclosecursor=0
oacolumnlistinfo=0
oacursorinfo=0
oacommand=0
oaconnect=0
oadatabaseinfo=0
oadelete=0
oadeletewhere=0
oadescribe=0
oadisconnect=0
oaenvironmentinfo=0
oaexecsql=0
oaexecdb=0
oaerror=0
oaexport=0
oaexternal=0
oafetch=0
oafetchkeys=0
oaform=0
oagetinfo=0
oaindexinfo=0
oainsert=0
oajoin=0
oalist=0
oaopencursor=0
oaqualify=0
oaselect=0
oatableinfo=0
oaupdate=0
oaversion=0

The routines shown below are used internally by OmniAccess. They should not be called directly by a Client application.

oacalc=0
oacalcbytelength=0
oaGetDBSetODX=0
oaGetDomainKeys=0
oaGetTables=0
oaGetTableColumns=0

 

top

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

DISC | Documentation Home