Win32

UNIX

Variable Descriptions

SSADB_QUERY_TIMEOUT

Sets the timeout interval in seconds for a search request to query the database.

SSADB_RECID_INCREMENT

Sets the increment value for the record identifiers. The increment value is applicable only for the synchronization process. Default is 1.

SSA_IGNORE_ODBC_SQLSTATE

Specifies the types of errors to ignore based on the SQLSTATE value. You can also specify a message code number to ignore the specific error.

For example:

SSA_IGNORE_ODBC_SQLSTATE=S1000,29725

ignores the following error:

SQLSTATE='S1000' NATIVE_ERR=29275 Reason: [Oracle][ODBC][Ora]ORA-29275: partial multibyte character

SSA_LITEINDEX_DONOTSEARCHNULLKEY

Skips the null values when you use Lite Indexes to search. To skip the null values, set the environment variable to any whole number. For example,

SSA_LITEINDEX_DONOTSEARCHNULLKEY=1

.

SSA_LISTEN_FAILURES_ABORT

Indicates whether to perform a forced restart of a server after the server exceeds the allowed number of consecutive connection failures.

Use one of the following values:

1
. Performs a forced restart.
0
. Disable this option. Default is 0.

SSA_LISTEN_FAILURES_ALLOWED

Maximum number of consecutive connection failures allowed for a server. Set the environment variable to any whole number. For example,

SSA_LISTEN_FAILURES_ALLOWED=10

.

SSANOSORTIDX

Indicates whether to disable sorting when you run the Table Loader utility. To disable sorting, set the environment variable to 1.

For example:

SSANOSORTIDX=1

.

SSAOPTS

Sets various logging and trace options. You can use one or more of the following values:

+r
. Logs all the search records to the
idssrsv.dbg
file. Use
+r
to identify a particular search transaction that causes a server crash.
+T
. Logs search trace information to the
idssrsv.dbg
file. You can use the LOGTEST trace file in addition to the search trace information in the event of a server crash.
+u
. Logs process resource usage, such as the number of threads, sockets, and stack space to the
*.dbg
files. The value also logs database resource utilization when users connect or disconnect.

For example,

SSAOPTS=+rTU

.

SSAPR

Directory name that contains the SSA-NAME3 population files.

SSA_RB_ERROR_IS_NOT_FATAL

Converts a data integrity error to a warning. To convert errors to warnings, set the environment variable to any whole number. For example,

SSA_RB_ERROR_IS_NOT_FATAL=1

.

SSA_RESTRICTED_VARS

Specifies a colon-separated list of environment variables which cannot be set by the console client.

SSA_SEARCH_MAX_RETRY

Maximum number of times you want to retry a search request before it fails.

SSASQLLDR

Fully qualified name of the loader utility, which is specific to each database. Use one of the following values:

sqlldr
for Oracle
db2
for IBM DB2 UDB
bcp
for Microsoft SQL Server

SSA_SOCKET_MAXIMUM_ALLOWED

Maximum number of sockets that listen for connections. Set the environment variable to any whole number. For example,

SSA_SOCKET_MAXIMUM_ALLOWED=10

. By default, you do not have any restriction on the number of sockets.

SSA_SOCKET_TIMEOUTS

Specifies the timeout periods as a comma-separated list for all the

Identity Resolution

servers. The SSA_SOCKET_TIMEOUTS environment variable uses the following format:

SSA_SOCKET_TIMEOUTS=<Idle>,<Connection>,<Write>,<Read>

Configure the following parameters:

Idle

Time period for a client session to remain idle before the server cancels the session. The default timeout period is 86400 seconds.

Connection

Time period for a client to wait before an attempt to establish a connection to the server is terminated. The default timeout period is 15 seconds.

Write

Time period to wait for a write or send operation to complete successfully. The default timeout period is 7200 seconds.

Read

Time period to wait for a read or receive operation to complete successfully. The default timeout period is 7200 seconds.

If you configure the SSA_SOCKET_TIMEOUTS variable, you must specify the timeout periods for all the operations. For example,

SSA_SOCKET_TIMEOUTS=86400,15,7200,7200

SSA_THREAD_MAXIMUM_ALLOWED

Maximum number of threads that process the data. Set the environment variable to any whole number. For example,

SSA_THREAD_MAXIMUM_ALLOWED=10

.By default, you do not have any restriction on the number of threads.

SSATEMP

Some Identity Resolution programs and scripts require output to be written to a temporary directory. The location of this directory is controlled by the

SSATEMP

variable. The default location of this directory is

$HOME/tmp

in UNIX and

%TEMP%

in Windows installations. It is recommended that a separate location is created for each user (each instance or running servers). This directory must have write and execute permissions.

SSA_TREAT_C_TYPE_AS_LATIN1=1

Converts the Latin-1 character set to the UTF-8 character set.

SSA_USE_SQLDRIVERCONNECT

Indicates whether to use the

SQLDriverConnect

or

SQLConnect

function to connect to the target database. When you use the

SQLDriverConnect

function, you can specify multiple connection attributes.

To use the

SQLDriverConnection

function, set the environment variable to 1. By default, Identity Resolution uses the

SQLConnect

function.

The

SQLDriverConnect

function uses the following format for the connection string:

DSN=<Data source name>;UID=<User ID>;PWD=<Password>;<Parameter 1>=<Value 1>;<Parameter 2>=<Value 2>

.

For example, the following sample connection string sets the minimum and maximum pool size:

DSN=<datasourcename>;UID=<userid>;PWD=<password>;Pooling=true;Pool Size Min=10;Pool Size Max=50

.

SSA_USE_SQLDRIVERCONNECT_ATTRIBUTES

Specifies the additional attributes for the

SQLDriverConnect

function. Applicable only when you set

SSA_USE_SQLDRIVERCONNECT=1

.

For example, when

SSA_USE_SQLDRIVERCONNECT=1

and

SSA_USE_SQLDRIVERCONNECT_ATTRIBUTES=Pooling=true;Pool Size Min=10;Pool Size Max=50;Connection Lifetime=120;Connection Timeout=60;Incr Pool Size=5;Decr Pool Size=2

, Identity Resolution uses the following connection string:

DSN=<datasourcename>;UID=<userid>;PWD=<password>;Pooling=true;Pool Size Min=10;Pool Size Max=50;Connection Lifetime=120;Connection Timeout=60;Incr Pool Size=5;Decr Pool Size=2

.

SSA_WSTIMEOUT

Specifies the timeout periods as a comma-separated list for the XML Search Server. The SSA_WSTIMEOUT environment variable uses the following format:

SSA_WSTIMEOUT=<Idle>,<Connection>,<Write>,<Read>

Configure the following parameters:

Idle

Time period for a client session to remain idle before the server cancels the session. The default timeout period is 86400 seconds. If you want to use the default timeout period, set the value as 0.

Connection

Time period for a client to wait before an attempt to establish a connection to the server is terminated. The default timeout period is 15 seconds. If you want to use the default timeout period, set the value as 0.

Write

Time period to wait for a write or send operation to complete successfully. The default timeout period is 7200 seconds. If you want to use the default timeout period, set the value as 0.

Read

Time period to wait for a read or receive operation to complete successfully. The default timeout period is 7200 seconds. If you want to use the default timeout period, set the value as 0.

If you configure the SSA_WSTIMEOUT variable, you must specify the timeout periods for all the operations. For example,

SSA_WSTIMEOUT=1200,0,0,0

If you configure both the SSA_SOCKET_TIMEOUTS and SSA_WSTIMEOUT environment variables, the SSA_WSTIMEOUT variable takes precedence over the SSA_SOCKET_TIMEOUTS variable for the XML Search Server.

SSA_ZOO_HOST=<Host Name1>:<Port1>[,<Host Name2>:<Port2>,<Host Name3>:<Port3>…, <Host NameN>:<PortN>]

Indicates a list of ZooKeeper servers based on the host name of the ZooKeeper server and the port on which the host listens for connections.

If you configure the ZooKeeper servers during the

Identity Resolution

installation, the SSA_ZOO_HOST environment variable is set with the ZooKeeper host details.

Ensure that you specify 1, 3, or more ZooKeeper servers. You cannot achieve high availability with two ZooKeeper servers.

SSA_ZOO_PORT=<Port>

Indicates the port on which you want to start the ZooKeeper server.

If you specify the ZooKeeper port for the local host during the

Identity Resolution

installation, the SSA_ZOO_PORT environment variable is set with the ZooKeeper port.

ZOOCFGDIR=<Configuration File Directory>

Applicable only if you use an ensemble of ZooKeeper servers. Indicates the directory path to the configuration file of ZooKeeper named

zoo.cfg

. By default, you can find the

zoo.cfg

file in the following directory:

On Windows:
<Identity Resolution Installation Directory>\bin
On UNIX.
<Identity Resolution Installation Directory>/bin

ZOO_LOG_DIR=<Log File Directory>

Applicable only if you use an ensemble of ZooKeeper servers. Indicates the directory path to the log file for the ZooKeeper server.