1.877.833.1202

Instrumentation Utility for the FileHold Server

The FileHold Instrumentation Tool (FHIT) application, is an executable utility that is run by an IT administrator who is also a System Administrator.

To run this tool successfully, the IT administrator must be specifically:

  • A FileHold System Administrator
  • A local server administrator of the FileHold Web server / member of the local system administrators group for the server.
  • An administrator of the MS SQL Server database where the FileHold databases are stored
  • *A domain administrator (this depends on which tool in the utility is being run)

IMPORTANT: FileHold Instrumentation Tools are provided to end users on an as is basis without any express or implied warranties. Take all normal precautions, such as backing up vital data, verifying changes on a test server, ensuring all users on disconnected, etc. before using this tool.

The FH Instrumentation tool application can be executed from C:\Program Files\FileHold Systems\Application Server\FHInstrumentation.

Many of these tools contain Backup Settings and Restore Settings. This functionality allows you to easily backup all web.configs or restore from backups.

Service Account Change

Users Management (FileHold 15)

  • Merge local users with domain users – Used to migrate local accounts with their memberships, permissions, and access rights over to equivalent Active Directory accounts.
  • Export GUIDs – Used to get a list of GUIDs assigned to users and groups in the system. This is typically used to assign permissions in auto-filing scripts.
  • Change user password – Used to reset the system administrator password.
  • Merge local users with domain users – Used to migrate local accounts with their memberships, permissions, and access rights over to equivalent Active Directory accounts.

ADAM Objects Management (FileHold 14, 14.1, 14.2)

Tools not documented below are tools that should specifically be used by FileHold support staff or authorized FileHold certified resellers:

  • Install basic ADAM configuration – To install a basic ADAM instance so that user/group objects can be restored to this instance. For locally managed systems only.
  • Import users from database – Used to move information from the database to the ADAM instance during a migration.
  • Merge local users with domain users – Used to migrate local accounts with their memberships, permissions, and access rights over to equivalent Active Directory accounts.
  • Manage passwords ( For Locally Managed FileHold Users Only - not applicable to AD integrated user accounts, that is managed within Active Directory )
    • This provides the ability to mass reset all passwords
    • Force password change during next logon
    • Undo the Force password change during next login.
  • Export GUIDs – Used to get a list of GUIDs assigned to users and groups in the system. This is typically used to assign permissions in auto-filing scripts.
  • Change user password – Used to reset the system administrator password (FileHold 14.1, 14.2).

FileHold 12 and prior versions:

  • Export objects (FileHold 12 and prior releases) - exports user/group objects from the ADAM > Lightweight Directory Services Instance
  • Import Objects - (FileHold 12 and prior releases) imports user/group objects from the MS ADAM > Lightweight Directory Services Instance
  • Restore MS ADAM > LDS from Backup - (FileHold 12 and prior releases) — For Locally Managed Users Only
  • Change Emails - (FileHold 12 and prior releases) This tool allows you to change all user account's email addresses - as long as you are simply switching the domain names. For example user@abc.com is now user@xyz.com
  • Export GUIDs – Used to get a list of GUIDs assigned to users and groups in the system. This is typically used to assign permissions in auto-filing scripts. (FileHold 12.4)

Change port, Server Name or Protocol

Change DB Server instance

Changes the web.config files after you have moved the FileHold Databases to a different MS SQL server or MS SQL server\instance.

  • Change DB Server instance
  • Backup Settings
  • Restore Settings

Search Engine

Allows you to rebuild the full text search, re-index documents or delete orphan files.

  • Rebuild FTS
  • Index documents
  • Turn on Debug
  • Turn off Debug
  • Delete orphan documents from search queue

FDA Configuration

Create FDA installation template file which is useful for mass deploying FileHold Desktop Application

Active Directory (Version 12 and older only)

  • Get Partition Name - This tool allows you to retrieve the AD Partition name, which is useful for Active Directory Sync tasks. You will need to be logged into the FileHold server as a Domain administrator to use this tool.
  • Check Cycles - This tool looks for non standard cyclical group relationships within Active Directory.

FIPS Compatibility

For authorized US Government customers who need FIPS-140 compliance on the FileHold Server. Allows customers who are authorized to use this tool to both Turn on FIPS and Turn off FIPS compatibility. Do not run this tool unless given written authorization from FileHold Systems.

Health Checker

The Health Checker tool to validate a new Server installation, post Server upgrade or anytime to ensure that FileHold Server is correctly configured. This checks 250 server variables and configuration settings on the Server OS, .NET framework, Service Account, Database, Full Text Search and more.

Report Viewer (FileHold 14.1 and higher versions)

Allows you to view the logs of exported reports that may have been generated using the various FHIT wizards.

The Report Viewer also allows you to upload the report and view the list of entries with the severity (information, warning, or error) as well as any details about the error. The logs can be exported into an XML or text file.

FileHold Library Setup

The FileHold configuration (library structure, metadata, workflow templates, saved searches, etc.) and documents can exported and then reimported into another FileHold server instance using the following tools.

  • Export Configuration
  • Import Configuration
  • Export Documents (with metadata)

FileHold Repository Checker

Checks the integrity of the FileHold repository against the database. For example, if there are missing and/or orphan files, entries in the database that have no file association, or files that have no entries in the database.

AD Synchronization (FileHold 14 and higher versions)

Synchronizes Active Directory Domain using FileHold Active Directory synchronization system.

About FileHold

Displays the FileHold Version and Build Number.