Introduction
OpenAccess SDK Server System Administration
Local System Administration
Remote System Administration
Using the OpenAccess SDK Manager
Administrative Requests
Monitoring Requests
OpenAccess SDK Manager Implementations
About OpenAccess SDK Services and Data Sources
Data Sources
Server Data Sources
Client Data Sources
Service Attributes
OpenAccess SDK Service Templates
Monitoring OpenAccess SDK Service Activity
Event Handling
About Threading Models
Allocating the Number of Threads to the Thread Pool
Returning Threads to the Thread Pool
Using the OpenAccess SDK Management Console
Working with the OpenAccess SDK Management Console
Connecting to OpenAccess SDK Agents
Displaying OpenAccess SDK Service Attributes
Refreshing Active Information
Using the OpenAccess SDK Management Console Toolbar
Configuring Services Using the OpenAccess SDK Management Console
Configuration Differences in OpenAccess SDK Manager
Configuring Services in a Client/Server Configuration
Starting and Stopping Services
Creating a Service
Deleting a Service
Viewing Service Attributes
Changing a Service Attribute
Adding a Service Attribute
Deleting a Service Attribute
Enabling Windows Standard Users to Start and Stop OpenAccess SDK Services
Configuring Services in a Local Configuration
Creating a Service
Deleting a Service
Viewing Service Attributes
Changing a Service Attribute
Adding a Service Attribute
Deleting a Service Attribute
Configuring Server Data Sources Using the OpenAccess SDK Management Console
Creating a Server Data Source
Deleting a Server Data Source
Renaming a Server Data Source
Viewing Server Data Source Attributes
Adding a Server Data Source Attribute
Changing the Value of a Server Data Source Attribute
Deleting a Server Data Source Attribute
Configuring Monitoring in a Client/Server Configuration
Creating a Monitoring Profile
Changing an Existing Monitoring Profile
Deleting a Monitoring Profile
Integrating OpenAccess SDK Monitoring with the Windows Performance Tool
Configuring Event Tracing in a Client/Server Configuration
Creating an Event Trace Profile
Changing an Existing Event Trace Profile
Deleting an Event Trace Profile
Managing a Remote Service Using the OpenAccess SDK Management Console
Managing Data Access Activity Using the Management Console
Killing a Session
Viewing Event Tracing Information
Viewing Details About an Active Service
Viewing Active Sessions and Details About an Active Session
Using the OpenAccess SDK Management Command Line
Using the OpenAccess SDK Management Command Line
Direct Command Execution
Batch Command Execution
Interactive Command Execution
General Rules
Invoking the OpenAccess SDK Management Command Line in a Client/Server Configuration
Invoking the Command Line in a Client/Server Configuration
Invoking the Command Line Tool in a Local Client Configuration
Invoking the Management Command Line Silently
Displaying Help for a Command
Commonly Used OpenAccess SDK Manager Commands
Starting a Service
Stopping a Service
Creating a Service
Deleting a Service
Viewing Service Attributes
Changing a Service Attribute
Adding a Service Attribute
Deleting a Service Attribute
Creating a Server Data Source
Deleting a Server Data Source
Changing a Server Data Source Attribute
Adding a Server Data Source Attribute
Deleting a Server Data Source Attribute
Killing a Session
Viewing Event Tracing Information
Viewing Active Services
Viewing Details About an Active Service (Including Active Sessions)
Viewing Details About an Active Session
Configuring the OpenAccess SDK SQL Engine
Configuring Services and Data Sources
Configuring Attributes for an IP Written in C/C++
Configuring Attributes for an IP Written in Java
Configuring Attributes for an IP Written in .NET
Configuring Disk Cache
Configuration Parameters
When Query Results Are Cached to Disk
How Query Results Are Cached to Disk
CacheData File Size
Queries That Are Not Cached to Disk
Configuring Row Cache
Migrating Views to OpenAccess SDK 8.1 and later
Before Using OAViewgen
Generating View Definitions
Examples
OpenAccess SDK SQL Engine Configuration Parameters
IP Parameters
SQL Engine Parameters
Logging Parameters
Configuring an OpenAccess SDK IP for a Third-Party SQL Engine
Configuring Services and Data Sources
Configuring Attributes for an IP Written in C/C++
Configuring Attributes for an IP Written in Java
Configuration Parameters
Configuring an IP Written in C/C++ for a Third-Party SQL Engine
Configuring an IP Written in Java for a Third-Party SQL Engine
Configuring the ODBC Client
About ODBC Connections
Using the ODBC Administrator
Configuring ODBC Client Data Sources on Windows
Configuring ODBC User and System Client Data Sources
Configuring ODBC File Client Data Sources
ODBC Connection Dialogs
Stage 1: Establishing a Network Connection
Stage 2: OpenAccess SDK Server Authentication
Testing ODBC Connections on Windows
Configuring Data Sources for the Local ODBC Client on Windows
Configuring ODBC User and System Client Data Sources
Configuring ODBC File Client Data Sources
ODBC Connection Dialogs
Testing ODBC Connections on Windows
Configuring ODBC Client Data Sources on Linux and UNIX
Configuring System Information Files
Example: odbc.ini for Solaris
Example: odbc64.ini for Solaris
Setting Environment Variables
Using a Centralized System Information File
Configuring Local ODBC Client Data Sources on Linux and UNIX
Configuring System Information Files
Example: odbc.ini for Solaris
Example: odbc64.ini for Solaris
Setting Environment Variables
Using a Centralized System Information File
Connecting Using a Connection String
Configuring Connection Failover for the ODBC Client
Specifying Alternate Servers
Connection String Example
odbc.ini File Example
odbc64.ini File Example
Using Connection Retry
Using Client Load Balancing
Authentication
Using SSL Encryption
Unicode and Code Page Support
Using Interactive SQL for ODBC
Starting and Stopping Interactive SQL (ODBC)
Interactive SQL Command-line Syntax
Commands for Interactive SQL (ODBC)
Redirecting Output from Interactive SQL (ODBC)
Example of an Interactive SQL Session
Configuring the ADO Client
About ADO Connections
Using the Configuration Manager
Configuring ADO Client Data Sources
Creating an ADO Client Data Source
Modifying an ADO Client Data Source
Deleting an ADO Client Data Source
Changing Data Source Directories
Connecting to an ADO Data Source
Testing ADO Connections
ADO Connection Dialogs
Stage 1: Establishing a Network Connection
Stage 2: OpenAccess SDK Server Authentication
Stage 3: Data Store Logon
Connecting with a Provider String
Configuring Connection Failover and Client Load Balancing for the ADO Client
Using Connection Failover
Using Connection Retry
Connection String Example
Using Client Load Balancing
Authentication
Using SSL Encryption
Using Interactive SQL for ADO
Starting and Stopping OLEDBISQL
Interactive SQL Command-line Syntax
Interactive SQL Commands for OLEDBISQL
Redirecting Output from OLEDBISQL
Example of an Interactive SQL Session
Configuring the JDBC Client
About JDBC Connections
Connecting to a Data Source
Setting the Classpath
Registering the JDBC Client
Specifying Connection URLs
JDBC Connection Properties
Configuring Connection Failover for the JDBC Client
Specifying Primary and Alternate Servers
Using the AlternateServers Property
Specifying Connection Retry
Specifying Load Balancing
Connection Failover Properties
Testing JDBC Connections
Authentication
Using SSL Encryption
Code Page Support
Using Interactive SQL for JDBC
Starting and Stopping Interactive SQL
Interactive SQL Command-line Syntax
Redirecting Output from JDBCISQL
Interactive SQL Commands for JDBCISQL
Example of an Interactive SQL Session
Configuring the ADO.NET Client
Understanding Assemblies
Specifying Connection Properties
Connecting to a Database
Example 1: Using the Provider-Specific Objects
Example 2: Using the Common Programming Model
Using Connection Failover with the ADO.NET Client
Specifying Alternate Servers
Using Connection Retry
Using Client Load Balancing
Using SSL Encryption
Code Page Support
Starting and Stopping OpenAccess SDK Services for Windows Standard Users
Starting and Stopping Services in a Client/Server Configuration
Starting and Stopping Services in an Embedded Server Configuration
Configuring Security for OpenAccess SDK
About OpenAccess SDK security
Authentication
Authorization
Data store logon
Application IDs
ReadOnly
Data encryption
Configuring OpenAccess SDK security
Configuring authentication for data access activities
Configuring authentication for administrative activities
Configuring single sign-on security
Configuring Kerberos authentication
Configuring Kerberos authentication for OpenAccess SDK Server
Configuring Kerberos authentication for the ODBC Client and ADO Client
Configuring Kerberos authentication for the JDBC Client
Obtaining a Kerberos Ticket Granting Ticket
Configuring authorization for a data access service
Configuring ServiceUser
Configuring ServiceUserGroup
Configuring authorization for an OpenAccess SDK agent service
Configuring ServiceAdministrator
Configuring ServiceAdministratorGroup
Configuring SSL
Configuring SSL data encryption
Example 1: SSL-enabled service using a DSA private key and defaultcipher suites
Example 2: SSL-enabled service using a RSA private key and aspecific cipher suite
Example 3: SSL-enabled service using an EC private key and defaultcipher suites
Configuring SSL server authentication
Configuring LDAP settings for OpenAccess SDK Clients that use SSL data encryption
Configuring data source logon
Storing client credentials
Storing credentials in the Windows registry
Storing client credentials in the odbc.ini file
Security attribute defaults for Linux, UNIX, and Windows
Defaults for an OpenAccess SDK agent service
Defaults for a Data Access Service
Required permissions for the Java 2 platform
Permissions for establishing connections
Granting access to temporary files
Permissions for Kerberos authentication
Service attributes that affect security
Using LDAP with the OpenAccess SDK Clients
What is LDAP?
Retrieving Connection Information from LDAP Directories
Creating LDAP Entries for OpenAccess SDK Services
Updating LDAP Entries for OpenAccess SDK Services
OpenLDAP Support
OpenAccess SDK LDAP Schema Definitions
Example: LDAP Entry for ODBC
Connecting Using LDAP and JNDI
Using an LDAP Server as Your JNDI Service Provider
OpenAccess SDK Manager Commands
Command Overview
OpenAccess SDK Manager Commands
About | a
ActivateLocalConfig | alc
ActivateOfflineConfig | aoc
ActivateRemoteConfig | arc
ActivateSecureRemoteConfig | asrc
CloseConfig | cc
DataSourceAttributeAdd | dsaa
DataSourceAttributeDelete | dsad
DataSourceAttributeReplace | dsar
DataSourceCreate | dsc
DataSourceDelete | dsd
DataSourceInfo | dsi
DataSourceList | dsl
Echo | e
EventList | el
EventExport | ee
Exit | e
Help | ?
NoOperation | noop
ProfileEventTraceCreate | petc
ProfileEventTraceDelete | petd
ProfileEventTraceEdit | pete
ProfileEventTraceInfo | peti
ProfileMonitorCreate | pmc
ProfileMonitorDelete | pmd
ProfileMonitorEdit | pme
ProfileMonitorInfo | pmi
Quit | q
SaveConfig | save
ServiceActiveDebugLogLevel | sadll
ServiceActiveInfo | sai
ServiceAttributeAdd | saa
ServiceAttributeDelete | sad
ServiceAttributeReplace | sar
ServiceCreate | sc
ServiceDebugLogLevel | sdll
ServiceDelete | sd
ServiceInfo | si
ServiceList | sl
ServiceRegister | sr
ServiceStart | ss
ServiceStop | sst
ServiceTemplateList | stl
ServiceTemplateInfo | sti
ServiceUnregister | su
SessionDebugLogLevel | sesdll
SessionInfo | sesi
SessionStop | sess
Set | s
OpenAccess SDK Service Attributes
Defining Service Attributes
DataSourceAllowPrefetch
DataSourceApplID
DataSourceAutoApplId
DataSourceBlockFetchForUpdate
DataSourceCurrentCatalog
DataSourceDescribeParam
DataSourceDescribeVarcharAsLongvarchar
DataSourceDescribeWcharAsChar
DataSourceDescription
DataSourceDisableStaticCursor
DataSourceDisableWarnings
DataSourceEnableAccess
DataSourceFetchNextOnly
DataSourceFetchTimeStampAsString
DataSourceFixCharTrim
DataSourceIPClass
DataSourceIPCustomProperties
DataSourceIPProperties
DataSourceIPSchemaPath
DataSourceIPType
DataSourceKeySetDataType
DataSourceKeySetName
DataSourceKeySetOptions
DataSourceKeySetSize
DataSourceLimitParamBindSize
DataSourceLogoffBehaviour
DataSourceLogonMethod
DataSourceName
DataSourcePadBlanksUpToColumnSizeInBytes
DataSourceQueryTimeOut
DataSourceReadOnly
DataSourceSchemaFilterList
DataSourceSessionToken
DataSourceSLKStcCrsrLngCLBuff
DataSourceSSLDataEncryption
DataSourceTableTypeFilterList
DataSourceThreadMaxRpc
DataSourceThreadRpcTimeOut
DataSourceTransactionIsolation
DataSourceWorkArounds
DataSourceWorkarounds2
DataSourceWorkaroundsXliteration
ServiceAdminAuthMethods
ServiceAdministrator
ServiceAdministratorGroup
ServiceAdminKerberosPrincipalName
ServiceAuthMethods
ServiceAuthorizedAdminClient
ServiceAuthorizedClient
ServiceCancelEnabled
ServiceCatchExceptions
ServiceCodePageMap
ServiceConnectInfo
ServiceConnectionModel
ServiceDeadClntDetInt
ServiceDebugLogLevel
ServiceDebugLogPath
ServiceDescription
ServiceDetailedOSLogonErrors
ServiceEnvironmentVariable
ServiceEventTraceLocation
ServiceEventTraceSize
ServiceEvQGetNrEventsMax
ServiceEvQPingTimeout
ServiceEvQShmMonitorSize
ServiceEvQShmQMaxResend
ServiceEvQShmQSize
ServiceEvQShmQWaitResend
ServiceEvQType
ServiceExecPath
ServiceExecPath2
ServiceHost
ServiceIdentification
ServiceIdleTimeInt
ServiceIIOPObjectKey
ServiceIIOPOperationTarget
ServiceInternalTimeout
ServiceIPConfigFile
ServiceIPEPath
ServiceIPLogCLR
ServiceIPLogFileClose
ServiceIPLogFileMaxSize
ServiceIPLogJVM
ServiceIPLogOption
ServiceIPModule
ServiceIPPath
ServiceIPSqlEngineModule
ServiceJavaIPByteBufferSize
ServiceJavaIPCatalogTablePrefix
ServiceJavaIPCatchSigSegv
ServiceJavaIPDBMSName
ServiceJavaIPStringBufferSize
ServiceJavaIPUseBasicGetColVal
ServiceJavaIPUseBulkFetch
ServiceJavaIPUseCatalogQueries
ServiceJVMClassPath
ServiceJVMLocation
ServiceJVMOptions
ServiceKerberosPrincipalName
ServiceLanguage
ServiceMaxSessions
ServiceMaxThreads
ServiceMessageFile
ServiceMinThreads
ServiceName
ServiceNetworkBufferSize
ServiceRegisterTCPPort
ServiceResolveHostNames
ServiceSQLBinarySchemaCacheSize
ServiceSQLBulkByteBufferSize
ServiceSQLBulkStringBufferSize
ServiceSQLCheckConnectionAlive
ServiceSQLConfigureSQLLimits
ServiceSQLCustomErrorFile
ServiceSQLDiskCacheBlockSize
ServiceSQLDiskCacheDataBlockSize
ServiceSQLDiskCacheIncrementSize
ServiceSQLDiskCacheInitialSize
ServiceSQLDiskCacheMaxSize
ServiceSQLDiskCacheMemSize
ServiceSQLDiskCachePath
ServiceSQLEngineMessagePrefix
ServiceSQLEngineVerboseLogLevel
ServiceSQLEngineVerboseMode
ServiceSQLFetchBlockSize
ServiceSQLHideQualifierOwner
ServiceSQLIPMessagePrefix
ServiceSQLJoinBlockSize
ServiceSQLJoinInQueryOrder
ServiceSQLJoinOrderUsingSearchCondition
ServiceSQLLocaleDecimalInQuery
ServiceSQLQueryCancel
ServiceSQLQueryMaxSize
ServiceSQLResultBufferCacheMaxSize
ServiceSQLResultCacheRowBlockSize
ServiceSQLResultCacheValBlockSize
ServiceSQLSchemaUpdateAllowed
ServiceSQLSetLocale
ServiceSQLCorrelatedSubQueryTransform
ServiceSQLSubQueryTransform
ServiceSQLTranslatedQueryMaxSize
ServiceSQLViewToSubQueryTransform
ServiceSQLXmPageSize
ServiceSQLXmUsePages
ServiceSSLCipherSuites
ServiceSSLEnabled
ServiceSSLKeyStore
ServiceSSLKeyStorePasswordFile
ServiceSSLSessionCacheSize
ServiceSSLSessionCacheTimeout
ServiceSSLVersions
ServiceTCPBindSpecific
ServiceTCP1stRecvTimeLimit
ServiceThreadLockThreshold
ServiceThreadStackSize
ServiceType
ServiceUnixSyslogFacility
ServiceUser
ServiceUserGroup
OpenAccess SDK Events
OpenAccess SDK Events and their Attributes
OpenAccess SDK Event Attributes
Filtering Events
Internationalization, Localization, and Unicode
Internationalization and Localization
Locale
Unicode Character Encoding
Background
Unicode Support in Databases
Unicode Support in ODBC
Unicode Support in JDBC
Unicode Support in .NET
For More Information
Values for IANAAppCodePage Connection String Attribute
Using the ivcheckcp Utility
IANAAppCodePageValues
Supported Code Pages on Solaris
Supported Code Pages on HP-UX
Supported Code Pages on AIX
Supported Code Pages on Linux
Supported Code Pages on Windows
Introduction
Supported Code Pages on Windows