IDOL View Component 12.13

# Configure IDOL Components

To use document tracking with an SQL back end, you must use the IDOL document tracking library, which is included in the IDOL Server installer. You can store this library in any accessible location, and then configure the location in your IDOL components.

You must then configure your IDOL components to use the SQL document tracking back end. The DIH, IDOL Content component, Connector Framework Server (CFS), and CFS Connectors support document tracking.

After configuration, an IDOL component automatically adds itself to the `Source` table on startup.

NOTE: If you retire an IDOL component, Micro Focus recommends that you leave the entry in the `Source` table, because existing records might refer to the source of the retired component.

To configure an IDOL component for document tracking

1. Open the IDOL component configuration file in a text editor.

2. (DIH only) Turn on document tracking by setting the `DocumentTracking` parameter to `True` in the `[Server]` section of the DIH configuration file.

       [Server]
       DocumentTracking=True

   NOTE: If you are using DIH in a unified IDOL Server configuration, set the `DocumentTracking` parameter to `True` in the `[DistributionSettings]` section.

3. Create a `[DocumentTracking]` configuration section.

4. In this `[DocumentTracking]` section, set the `Backend` parameter to `Library`.

5. Set `LibraryPath` to the absolute path to your document tracking library. In the default IDOL installation, the library is located in `InstallPath/IDOL/modules/`, and the library name is `dt_odbc.dll` (on Windows), or `libdt_odbc.so` (on UNIX).

6. Set `ConnectionString` to the connection string to use, with subparameters set for your setup. For example:

       ConnectionString=Driver=PostgreSQL ANSI(x64); Server=sql-host.mycompany.com; Port=5432; Database=mydoctrackdb; UID=postgres;Password=password;

   You can also use a DSN instead of subparameters. For example:

       ConnectionString=DSN=MyDSN

   Set the parameters consistent with your environment. On Linux, the connection string cannot contain spaces.

   On Linux, you can set the `Driver` subparameter to the path to your SQL ODBC driver shared object (for example, `/usr/lib/x86_64-linux-gnu/odbc/psqlodbca.so` or `/usr/lib/odbc/psqlodbca.so`). Micro Focus recommends that you use the ANSI version of libraries.

   TIP: On Linux, if you use a DSN in your connection string, and you see `File not Found` errors in your IDOL logs, try specifying the driver explicitly in the `ConnectionString` configuration parameter:

       ConnectionString=Driver=/usr/lib/psqlodbca.so;DSN=mydsn;

7. Set any other configuration parameters for document tracking. For more information, refer to the IDOL Server Reference. For example:

       [DocumentTracking]
       MaxEventsPerFile=500
       TimeoutSeconds=20
       UIDFieldName=UID

   NOTE: Connectors generate the document ID strings, and add them to the `UIDFieldName` field, so you must not use a field that already exists for another purpose.

8. Save and close the configuration file.

   Restart the IDOL component for your changes to take effect.

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL IDOL View Component 12.13

Topic Title: Configure IDOL Components