This page only applies to Threat Manager on an iManage on-premises deployment.

In Configuration > Settings > System > Load Data, the Libraries section is where you connect the iManage Work Server SQL Database to iManage Threat Manager to ingest data for threat monitoring. This page covers tasks specific to on-premises deployments: prerequisites, and adding, editing, and removing libraries.

NOTES:

In this section:

Prerequisites

Before configuring ingestion (data loading), ensure you have SQL sign-in details for the iManage Work Server database. To understand how iManage Threat Manager handles user and group enablement across unsynchronized libraries, refer to How user and group processing works across libraries.

WARNING: If your Microsoft SQL Server compatibility level designation is lower than 110, you must follow the steps in the ATAIMPORTER_USERSIMPORTBATCHSIZE section of Advanced configuration before performing initial ingestion.

Task: Add an iManage Work library 

You need the Configuration Manager role to complete this task.

To add an iManage Work library for ingestion (data loading) in an on-premises deployment, you connect to the iManage Work Server database (SQL Server or Oracle) to enable threat monitoring.

When configuring a new library in the Add Library dialog of iManage Threat Manager, always set the Library field to the production database name. This ensures all data is treated as coming from the production database, allowing you to start with a backup database and later switch to the production database for regular updates.

Depending on your database type, you’ll configure the backup or production database as follows:

  • For SQL Server:

    • For a backup database, enter the backup’s name in the Database field, which will differ from the Library name.

    • For the production database, use the same name for both Library and Database fields.

  • For Oracle:

    • For a backup database, enter the backup’s connection details in the TNS Descriptor field.

    • For the production database, enter the production database’s connection details in the TNS Descriptor.

To add an iManage Work library to an on-premises deployment:

  1. In Configuration > Settings > System > Load Data, select Add Library

  2. In the Add Library dialog, set the following:

    • For SQL Server:

      • Library: Enter a name for the production database. Use this name for all ingestion, whether from a backup or the production database. This ensures that Threat Manager treats all data as coming from the production database, allowing you to start with a backup and later switch to the production database for regular updates.

      • Database type: Select SQL Server or Oracle based on your Work Server database.

      • Ingestion start date: Choose the date to start ingesting data. The default is one month before the current date.

    • For Oracle:

      • Library: Enter a name for the production database. Use this name for all ingestion, whether from a backup or the production database. This ensures that Threat Manager treats all data as coming from the production database, allowing you to start with a backup and later switch to the production database for regular updates.

      • Database type: Select SQL Server or Oracle based on your Work Server database.

      • Ingestion start date: Choose the date to start ingesting data. The default is one month before the current date.

NOTE: For typical installations, we recommend at least 13 months of historical data be ingested.

  1. Configure database settings:

    • For SQL Server:

      • Host: Enter the server’s IP address or hostname (use the backup server’s details if starting with a backup).

      • Port: Enter the port number (optional; defaults to 1433 if blank).

      • Database: Enter the backup database name if using a backup (different from the Library name) or the production database name if loading directly (same as the Library name). (For more details on switching from a backup to a production database, refer to the Upgrading iManage Threat Manager section in iManage Threat Manager Installation Guide.)

      • User: Enter the SQL account with database access (explicit credentials required).

      • Password: Enter the password for the user account.

    • For Oracle:

      • User: Enter the account with database access (explicit credentials required).

      • Password: Enter the password for the user account.

      • TNS Descriptor: Enter the backup database’s Oracle connection string details if using a backup, or the production database’s connection details if loading directly, for example: (DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=my-oracle-host)(PORT=1521))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=MY_WORK_DB))).

  2. Select Save to add the library. Threat Manager tests the database connection. If successful, the library is added, and ingestion (data loading) starts within minutes. If the test fails, an error message is displayed, and you’ll need to correct the settings.

  3. Check the Data Loading Progress Bar to track the status. To confirm loading is complete, go to Settings > Status and look for a green checkmark next to the library.

  4. (If using a backup) Switch to the production database:

    1. After the backup ingestion is complete (confirmed by a green checkmark in Settings > System > Status), go to Configuration > Settings > System > Load Data section.

    2. Select Edit next to the library.

    3. Update the database connection.

      • For SQL Server:

        • Change the Host field to the production SQL Server’s IP address or hostname.

        • Change the Database field to the production database name.

      • For Oracle:

        • Change the TNS Descriptor field to the production database’s connection details, for example: (DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=my-oracle-host)(PORT=1521))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=MY_WORK_DB))).

    4. Keep the Library name unchanged.

  5. Select Save to apply the changes. iManage Threat Manager will begin loading new data from the production database going forward. When you select Save, iManage Threat Manager performs a connectivity test to verify that it can access the specified database:

    • If the test is successful, the library is added.

    • If the test fails, an error message is displayed.

TIP: You can confirm ingestion (data loading) is complete by checking the status of the library in Configuration > Settings > Status tab. When data has been fully loaded, a green checkmark is displayed.

Task: Edit an iManage Work library 

After adding at least one library in Configuration > Settings > System > Load Data section, you can modify its settings, such as the database connection or start date.

To edit a library:

  1. In Configuration > Settings > System > Load Data section, select edit icon (library).PNGEdit next to that library's name.

  2. Update the fields as needed, such as the Host, Database, or TNS Descriptor (Oracle) for the database connection, or the Start Date for ingestion (data loading).

  3. Select Save to accept your changes. iManage Threat Manager will test the new settings, and if successful, the library will use the updated configuration.

Task: Remove an iManage Work library

You need the Configuration Manager role to complete this task.

You can remove a library from Configuration > Settings > System > Load Data section to delete its data from iManage Threat Manager. This action removes all activity data for the library, but keeps monitoring rules and report data. You can’t remove a library while it's actively loading data.

NOTE: You can’t delete the last remaining library from Threat Manager. To ensure continued monitoring, at least one must always remain connected.

Similarly, you can’t remove yourself from your last assigned library. At least one library assignment is required to maintain access. For example, if Threat Manager has 6 libraries and you are assigned to 3, you can’t remove all 3—at least one assignment must remain to maintain access.

To remove a library:

  1. In Configuration > Settings > System > Load Data section, select Remove (X) next to the library you want to delete.

  2. A warning message appears: “Removing a library can take a long time. It can also result in the loss of information from existing reports. Are you sure you want to remove library <name>?” Select Remove to continue.

  3. While the library is being removed, the Remove button is disabled, and the library remains visible. After it is fully removed, the library disappears from the list.

NOTE: You can’t remove a library while ingestion is underway for that library.