Comprehensive Parameters List for Oracle Server Wire Protocol (ODBC) in Policy Server

Products

• CA Single Sign-On
• SITEMINDER

Issue/Introduction

When configuring an ODBC Data Source on a UNIX/Linux operating system to connect the SiteMinder Policy Server to an Oracle database, the oraclewire.ini template is used to populate the system_odbc.ini file.

By default, the template files are located in:

<Siteminder_home>/db

The standard oraclewire.ini provides only a basic configuration. To utilize advanced features (such as encryption, failover, or performance tuning), the appropriate attributes must be manually added to the Data Source section of your system_odbc.ini.

Basic Configuration Sample:

[SiteMinder Data Source]
Driver=<SiteMinder_home_directory>/odbc/lib/NSora27.so
Description=DataDirect 7.1 Oracle Wire Protocol
HostName=nete_servername
PortNumber=1521
ServiceName=nete_serverid
#SID=nete_serverid
CatalogOptions=0
ProcedureRetResults=0
EnableDescribeParam=0
EnableStaticCursorsForLongData=0
ApplicationUsingThreads=1
DMCleanup=2
EnableTimestampWithTimeZone=1

Resolution

The following table contains the full list of available Data Source attributes for the DataDirect Oracle Wire Protocol driver.

Note:

The values listed below reflect the driver's hardcoded defaults.

Adding an attribute to your .ini file and modifying its value will override these defaults.

| Attribute               | Default Value | Description                                                |
|-------------------------+---------------+------------------------------------------------------------|
| AccountingInfo          |       (Empty) | Identifier for Oracle's client accounting.                 |
| Action                  |       (Empty) | Specifies the action for the connection.                   |
| AlternateServers        |       (Empty) | List of servers for connection failover.                   |
| ApplicationName         |       (Empty) | Name of the application for auditing.                      |
| ApplicationUsingThreads |             1 | Enables/Disables thread safety.                            |
| ArraySize               |         60000 | Number of bytes to fetch in a single network round trip.   |
| AuthenticationMethod    |             1 | Method used to authenticate the user.                      |
| BulkLoadBatchSize       |          1024 | Number of rows to load in a single batch.                  |
| ConnectionRetryCount    |             0 | Number of times to retry connection attempts.              |
| CryptoProtocolVersion   |       (Empty) | Specifies the SSL/TLS version to use.                      |
| EncryptionMethod        |             0 | Method used to encrypt data (0 = No encryption).           |
| FailoverMode            |             0 | Type of failover (0 = None, 1 = Connect, 2 = Select).      |
| LoginTimeout            |            15 | Seconds to wait for a login request to complete.           |
| QueryTimeout            |             0 | Seconds to wait for a statement to execute (0 = No limit). |
| ValidateServerCert      |             1 | Determines if the driver validates the SSL certificate.    |

For advanced tuning, the following parameters are also supported within the driver:

| Aspect              | Main parameters                                                                                                      |
|---------------------+----------------------------------------------------------------------------------------------------------------------|
| Performance         | ArraySize, BatchMechanism, EnableServerResultCache, MaxPoolSize, MinPoolSize                                         |
| Security/Encryption | AuthenticationMethod, EncryptionLevel, EncryptionTypes, DataIntegrityLevel, TrustStore, TrustStorePassword, KeyStore |
| Oracle Specific     | ServiceName, SID, TNSNamesFile, EditionName, ServerType                                                              |
| Compatibility       | EnableNcharSupport, FetchTSWTZasTimestamp, WireProtocolMode                                                          |

Important Considerations

Driver Path:

Ensure the Driver= path points to the correct shared library location for your OS (e.g., .so for Linux/Solaris, .sl for HP-UX, or .dylib for macOS).

Case Sensitivity:

While ODBC is generally forgiving, it is best practice to match the casing provided in the oraclewire.ini template.

Environment Variables:

Ensure LD_LIBRARY_PATH (or equivalent) includes the SiteMinder ODBC library directory so the Policy Server can load the driver specified in your .ini file.

This is usually done in the Policy Server ca_ps_env.ksh.

Full Attribute Reference List:

  AccountingInfo=
  Action=
  AlternateServers=
  ApplicationName=  
  ApplicationUsingThreads=1
  ArraySize=60000
  AuthenticationMethod=1
  BulkBinaryThreshold=32
  BulkCharacterThreshold=-1
  BulkLoadBatchSize=1024
  BulkLoadFieldDelimiter=
  BulkLoadOptions=0
  BulkLoadRecordDelimiter=
  CachedCursorLimit=32
  CachedDescLimit=0
  CatalogIncludesSynonyms=1
  CatalogOptions=0
  ClientHostName=
  ClientID=
  ClientUser=  
  ConnectionReset=0  
  ConnectionRetryCount=0
  ConnectionRetryDelay=3
  CryptoProtocolVersion=
  DataIntegrityLevel=0
  DataIntegrityTypes=
  DefaultLongDataBuffLen=1024
  DescribeAtPrepare=0  
  Description=
  Driver=<SiteMinder_home_directory>\\bin\\NSORA27.DLL
  EditionName=
  EnableBulkLoad=0
  EnableDescribeParam=0
  EnableNcharSupport=0
  EnableScrollableCursors=1
  EnableServerResultCache=0  
  EnableStaticCursorsForLongData=0
  EnableTimestampWithTimeZone=0
  EncryptionMethod=0
  EncryptionLevel=0
  EncryptionTypes=
  ExtendedOptions=
  FailoverGranularity=0
  FailoverMode=0
  FailoverPreconnect=0
  FetchTSWTZasTimestamp=0
  GSSClient=native
  HostName=
  HostNameInCertificate=
  InitializationString=
  KeepAlive=0  
  KeyPassword=  
  KeyStore=
  KeyStorePassword=
  LoadBalanceTimeout=0
  LoadBalancing=0
  LocalTimeZoneOffset=
  LockTimeOut=-1
  LoginTimeout=15  
  LogonID=
  MaxPoolSize=100
  MinPoolSize=0
  Module=  
  Pooling=0
  PortNumber=
  ProcedureRetResults=0
  ProgramID=  
  QueryTimeout=0
  ReportCodepageConversionErrors=0
  ReportRecycleBin=0
  ServerName=
  ServerType=0
  ServiceName=
  SID=
  TimestampEscapeMapping=0  
  TNSNamesFile=
  TrustStore=
  TrustStorePassword=
  UseCurrentSchema=1
  ValidateServerCertificate=1
  WireProtocolMode=2