Configuring the FTS Exporter

The FTS Exporter requires configuration parameters for connecting to Content Manager OnDemand, its database, and the FTS Server. These parameters can either be specified on the command line or written into a configuration file. It is recommended that you use the configuration file because your JDBC connection password is part of the required parameters and stored with the other password parameters that are encrypted in the configuration file.

To create the configuration file, run the FTS Exporter with the configure parameter:

Java -jar ODFTIExporter.jar configure -configFile <file>
<all configuration parameters>

The following parameters are required unless indicated as optional:

-dbEngine <db engine>: DB engine (Db2, MSSQL, or ORACLE)
-dbHostname <server>: Database server host name
-dbPort <port>: Database port
-dbUser <user>: Database user ID
-dbPassword <passwd>: Database password
-dbName <db name>: Database name
-dbOwner <db owner>: Database owner
-odInstance <instance>: Content Manager OnDemand instance name
-odUser <user>: Content Manager OnDemand user ID
-odPassword <passwd>: Content Manager OnDemand user password
-odInstallDir <path>: Where Content Manager OnDemand is installed
-pollDelay <seconds>: Number of seconds between polling (optional)
-ftiToken <FTI authentication token>: Authentication token used to communicate with FTS server (optional)
-ftiTokDef <server>,<port>,<token>: Used to specify the authentication token for a specific FTS server (optional)
-tempDir <path>: Temporary work directory (optional)
-command RESET_ERROR,IGNORE_DOC_ADD_ERRORS: Used to specify one or more commands which affect the processing of work items (optional)
-docFailThreshold: Used to specify the percentage of documents allowed to fail during the full text index of a load (optional)
-traceDir <path>: Directory to store trace files (optional)
-traceLevel <export trace level>: (optional)

Table 1 describes the purpose of each parameter.

Table 1. FTS Exporter parameters
Parameter	Purpose
dbEngine	The engine of the database that is being used. This parameter defines the JDBC class that is used by the FTS Exporter. It must be either Db2, MSSQL, or ORACLE.
dbHostname	The host name of the database server that runs the Content Manager OnDemand instance database.
dbPort	The port number of the database server.
dbUser, dbPassword	The user and password combination that is used to connect to the database.
dbName	For Multiplatforms systems, this value is the database name of the instance database to which to connect. For Db2 on z/OS, this value is the database location. For IBM i, the dbName is the instance name.
dbOwner	The database owner (used to open the correct `ARSFTIWORK` table).
odInstance	The Content Manager OnDemand instance to which to connect. This parameter must match the Content Manager OnDemand instance name that is in the ARS.INI file (or registry in Windows).
odUser, odPassword	The user and password of a Content Manager OnDemand user. This user is used to retrieve the documents for full text indexing.
odInstallDir	The installation directory of the Content Manager OnDemand server. This server contains the ARS.CFG file, which is used to look up the instance name.
pollDelay	Optional. A polling interval in seconds in which the FTS Exporter checks the `ARSFTIWORK` table for new work items.
ftiToken	Optional. The Full Text Index (FTI) authentication token that is used to communicate with the FTS Server.
ftiTokDef	Optional. When multiple FTS servers are implemented, this parameter can be specified multiple times to list the authentication token for each FTS server.
tempDir	Optional. Temporary directory.
command	Optional. Used to specify one or both of the following commands: RESET_ERROR - Attempt to reprocess rows marked as ERROR. IGNORE_DOC_ADD_ERRORS - Ignore existing and new document add errors. The failed rows will not be deleted from the work table.
docFailThreshold	Optional. Used to specify the percentage of documents allowed to fail during the full text index of a load. When performing a full text index on a load without specifying this parameter, all documents in that load must succeed or else they all fail. This parameter allows a percentage of overall failures to occur. If the number of failures remain below this percentage, then the load is successful. The failed documents will be logged by the FTS Exporter and also marked in the Content Manager OnDemand data table as 'not indexed'. These failed documents can then be easily queried and resubmitted for full text indexing by using the ARSDOC program.
traceDir, traceLevel	Optional. The location of trace files and the tracing level. If the tracing level is specified, it must be any of the following tokens: OFF, SEVERE, WARNING, INFO, FINE, FINER, or FINEST.

A call to configure the FTS Exporter is similar to this call, where Vx.y is your Content Manager OnDemand version:

java -jar ODFTIExporter.jar configure -configFile odfts.cfg -dbEngine DB2
-dbHostname localhost -dbPort 60004 -dbUser ondemand -dbPassword ondemand 
-dbName ondemand -odInstallDir /opt/ibm/ondemand/Vx.y -pollDelay 60 
-tempDir /tmp -traceDir /tmp -ftiToken "fIqBxTQ=" -odUser admin 
-odPassword ondemand -dbOwner ondemand -odInstance ONDEMAND

The example call writes the configuration file called ODFTS.CFG and configures a connection to the Content Manager OnDemand instance named ONDEMAND with the user admin and to the Content Manager OnDemand instance Db2 database named ondemand. The FTS Exporter polls for work items in the ARSFTIWORK table every 60 seconds and processes them against the FTS Server that is configured with this Content Manager OnDemand instance.

Content Manager OnDemand supports running the FTS Exporter on a system other than your Content Manager OnDemand server. In certain instances, this separation is highly recommended. If the FTS Exporter is installed on a remote system, the Content Manager OnDemand server code must be installed on this system because the FTS Exporter requires part of the binary and supporting files from the Content Manager OnDemand server installation. The FTS Exporter also gets part of its connection information from the ARS.INI file that is installed with the Content Manager OnDemand server or from the Windows registry.

The JDBC connection user that is used by the FTS Exporter must have SELECT, UPDATE, and DELETE authority on the ARSFTIWORK table and SELECT authority on the ARSSEG table of each Content Manager OnDemand instance with which it works.

To connect to your Content Manager OnDemand database by using JDBC, additional driver JAR files are required. The FTS Exporter is built to reference two additional JAR files in its directory by default: jdbc1.jar and jdbc2.jar. To use JAR file execution capability, you must link (or copy) your required JDBC driver JAR files to these locations so that they are automatically loaded by the FTS Exporter.

For example, when you use Db2 on AIX or Linux, you can issue the following commands in the jars subdirectory of the server to create these two links:

ln -s /opt/IBM/db2/V9.7/java/db2jcc4.jar jdbc1.jar
ln -s /opt/IBM/db2/V9.7/java/db2jcc_license_cu.jar jdbc2.jar

For the connection with Content Manager OnDemand, the FTS Exporter automatically references the Java API called ODApi.jar.

Note: Each instance of the FTS Exporter can connect to one Content Manager OnDemand instance. Only a single instance of the FTS Exporter for each Content Manager OnDemand database is supported.