This Quickstart is for administrators performing a basic, one-time user metadata import into iManage Threat Manager. It walks through the minimum setup, data preparation, import execution, and result verification for a single CSV or SQL import on Windows, using safe, recommended defaults.

It's intentionally concise and task-focused, designed for a predictable, low-risk outcome. It uses HTTPS with SSL enabled, import-only operations (no removals), and encrypted SQL passwords. It also builds in a verification step before you proceed to automation or scheduling. This Quickstart doesn’t cover advanced security configuration, automation, scheduling, metadata removal, or error handling. If you plan to run imports regularly, automate jobs, or recover from mistakes, continue to the linked sections after completing these steps.

To complete a one-time user metadata import (CSV or SQL):

1. Meet the minimum prerequisites

  • iManage Threat Manager 10.2.3 or later: The latest version is recommended.

  • iManage User Metadata Importer: Download the User Metadata Importer package from iManage Help Center for your operating system.

  • Role: Integrations Manager to generate token and secret.

  • Server: URL/hostname and port 8090.

  • SQL file import only: Install the Microsoft ODBC Driver for SQL Server that matches your SQL Server version.

NOTE: To learn more, refer to Prerequisites and Saving token and secret (optional but recommended).

2. Review supported fields and limits

Metadata field

Max values allowed

Character limit

Practice Area

100

255

Manager

1

255

Telephone

100

255

Additional Locations

1

255

Department

1

255

Job Title

1

255

NOTES:

  • The first column (CSV) or a column in SQL must be named userid and must match the iManage Work user ID.

  • All values are strings.

  • Fields that allow multiples (for example, Telephone) are repeated as additional columns in CSV or repeated columns in SQL results.

3. Prepare your data for import

You can prepare your data as CSV or SQL.

CSV: minimal example

  • CSV header (single values):

userid,Practice Area,Manager,Telephone,Additional Locations,Department,Job Title

  • Row example:

RHETT_PULLMAN,M&A,Amanda Peake,+123456788,London,Legal,Junior Associate​

  • Row with multiple phones (repeat the column name):

userid,Practice Area,Manager,Telephone,Telephone,Additional Locations,Department,Job Title
RHETT_PULLMAN,M&A,Amanda Peake,+123456788,+123456789,London,Legal,Junior Associate​

TIP:

When working with CSV:

  • Enclose values that contain commas in double quotes (for example, “Atlanta, Georgia”).

  • 1.) ORIGINAL: Escape quotes inside values as /" (for example: /"HQ" imports as “HQ”).

    2.) SUGGESTED UPDATE: Escape double quotes within a value by doubling them (for example, “HQ ““Main”” Office” imports as HQ “Main” Office).

    3.) IF THREAT MANAGER USES NON-STANDARD ESCAPING:
    In Threat Manager CSV imports, escape double quotes using /" (for example, /"HQ/" imports as “HQ”).

SQL: minimal example

  1. Create a table (or view) that returns these columns with exact names:

SELECT
  userid,
  [Practice Area],
  Manager,
  Telephone,
  [Additional Locations],
  Department,
  [Job Title]
FROM [DatabaseName].[Schema].[TableName];

  1. Place the connection string and SELECT together in a .sql data source file:

Driver={ODBC Driver 18 for SQL Server};Server=SERVER_FQDN;Database=DBNAME;UID=SQL_USER;PWD=SQL_PASSWORD;
SELECT userid, [Practice Area], Manager, Telephone, [Additional Locations], Department, [Job Title]
FROM [DatabaseName].[Schema].[TableName]

TIP:

When working with SQL:

  • Database, schema, and table names may be case‑sensitive, depending on the database collation.

  • You can encrypt the SQL password and use the -e option during import. This is recommended, especially for repeat jobs. For details, refer to Encrypting SQL database passwords in Importing metadata.

4. Import user metadata (Windows example)

IMPORTANT: Imports overwrite existing values for the included fields. If you’re unsure, test with a small CSV or SQL result set first.

  1. Open Command Prompt in the folder with user-metadata-importer.exe.

  2. Run one of the following, depending on your data source:

CSV import

user-metadata-importer.exe import csv ^
-s https://<TM_HOST_OR_URL>:8090 ^
-f path\to\metadata.csv ^
--token <APP_TOKEN> --secret <APP_SECRET>

SQL import (with encrypted password recommended)

user-metadata-importer.exe import sql ^
-s https://<TM_HOST_OR_URL>:8090 ^
-f path\to\source.sql ^
-e ^
--token <APP_TOKEN> --secret <APP_SECRET>

Optional (recommended for repeat runs)

  • Save token/secret to your Windows account once, then omit --token/--secret on future runs. Refer to Saving token and secret (optional but recommended).

  • Task identifiers enable status in the console and email alerts. Add --task-identifier <NAME> for production jobs. Even for one-time imports, task identifiers are recommended if you want visibility in Configuration > Settings > Status or email alerts on failure. This prevents silent failures.

5. Verify the import results

  • In the Threat Manager console, check Configuration > Settings > Status (if you used a task identifier)

  • Open a user and verify fields under Extended Properties

  • In Compliance > Adoption, filter by your imported fields

Expected behavior:

  • Existing users are updated with new metadata.

  • If a user doesn’t exist yet, a disabled user record is created and is auto‑linked after ingestion (matching on userid).

6. Continue with next steps