Before installing or running the User Metadata Importer, verify that your system meets the required software and configuration prerequisites. These requirements ensure the importer can connect securely to iManage Threat Manager and, if applicable, your SQL database.

  • 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. Separate packages are available for macOS and Linux, and Windows.

  • Access token and secret: These credentials can be generated by a Threat Manager user with the Integrations Manager role.
    For details, refer to System > Application Tokens for Utility Access.

  • SQL imports: Install the Microsoft ODBC Driver for SQL Server that matches your SQL Server version.

  • (Optional) Japanese language support: To run the application in Japanese, set the system environment variable LANGUAGE to value JA. To revert to English, change the value to EN.

Task: Install additional prerequisites for macOS and Linux systems

On macOS or Linux, you must install Python, pip, required dependencies, and environment variables before setting up authentication or running imports or removals.

  1. Python 3.6 or later. Download from https://www.python.org/downloads/.

  2. pip. Installation instructions are available at https://pip.pypa.io/en/stable/installation/.

  3. Installation dependencies. After unzipping the User Metadata Importer package:

    1. Open a terminal.

    2. Browse to the unzipped directory.

    3. Run the following command:

      pip install -r requirements.txt

NOTE: The requirements.txt file is included in the iManage Threat Manager User Metadata Importer package downloaded from iManage Help Center.

  1. Set PYTHONPATH. Add the root installation directory of the User Metadata Importer to the PYTHONPATH environment variable. For example:

  2. export PYTHONPATH="${PYTHONPATH}:/Users/<user.name>/Desktop/tm-user-metadata-importer"

  3. (Optional but recommended) Virtual environment: To avoid conflicts with system-wide Python packages, consider using a virtual environment. Installation instructions are available at https://virtualenv.pypa.io/en/latest/how-to/install.html.