Set Up Document Tracking

Document tracking reports metadata about documents when they pass through various stages in the ingestion and indexing process. Document tracking can help you detect problems with the indexing process.

You can write document tracking events to a database, log file, or Content component. For information about how to set up a database to store document tracking events, refer to the Knowledge Discovery Administration Guide.

To enable Document Tracking

  1. Open the CFS configuration file.
  2. Create a new section in the configuration file, named [DocumentTracking].
  3. In the [DocumentTracking] section, specify where the document tracking events are sent.

    • To send document tracking events to a database through ODBC, set the following parameters:

      Backend To send document tracking events to a database, set this parameter to Library.
      LibraryPath The location of the ODBC document tracking library. This is included with Knowledge Discovery.
      ConnectionString The ODBC connection string for the database.

      For example:

      [DocumentTracking]
      Backend=Library
      LibraryPath=/path/to/modules/libdt_odbc.so
      ConnectionString=DSN=MyDatabase
    • To send document tracking events to the CFS import log, set the following parameters:

      Backend To send document tracking events to the logs, set this parameter to Log.
      DatabaseName The name of the log stream to send the document tracking events to. Set this parameter to import.

      For example:

      [DocumentTracking]
      Backend=Log
      DatabaseName=import
    • To send document tracking events to a Content component, set the following parameters:

      Backend Set this parameter to IDOL.
      TargetHost The host name or IP address of the Content component.
      TargetPort The index port of the Content component.

      For example:

      [DocumentTracking]
      Backend=IDOL
      TargetHost=content
      TargetPort=9001

    For more information about the parameters you can use to configure document tracking, refer to the Connector Framework Server Reference.

  4. Save and close the configuration file.