Integrate HotDocs with iManage (without HotDocs InterConnect)

From HotDocs Wiki

Jump to: navigation, search

***HotDocs no longer supports ODMA as of 11.1+. Any integrations would be custom and be a billable service with a HotDocs Consultant.***


Note: HotDocs Interconnect, which provided a drop-in integration with iManage is no longer being sold or supported.

You can integrate HotDocs 6.1 and higher with iManage (server version 7, DeskSite version 6). This type of integration will manage your HotDocs answer files and assembled form and text documents.

CAUTION: To manage assembled text documents, you must also set up an integration that works with your word processor. Please refer to the iManage documentation for details about integrating other applications.

When integrating HotDocs 6.1+ with iManage, you must complete the following steps for both answer files as well as documents:

  • Create an application type.
  • Define the application.
  • Create a document class.
  • Define the registry keys on the client's computer.
  • Edit the iManage INI file.
  • Change the HotDocs Options.

Contents

Integrate Answer Files with iManage

In order to manage HotDocs answer files, you must complete the following steps in the iManage Database Administrator application:

Part 1: Create a new application type

  1. Open the Database Administrator and click a database icon to expand it.
  2. Click the Type button on the toolbar and select Add (Manage menu). The Add Type dialog box appears.
  3. In the Description box, type HotDocs 6.
  4. In the Alias box, type HOTDOCS.
  5. In the DMS Extension box, type %V.
  6. In the App. Extension box, type ANS or ANX to identify the answer file extension that iManage should add to the file name for the document when it is exported from iManage. (ANS represents a binary answer file, while ANX represents an XML answer file.)
  7. Click OK.
Note: Please see the iManage documentation for more information about other settings at this dialog box.

Part 2: Define the application

  1. At the Database Administrator, click the App Setup button and select Add (Manage menu). The Add App Setup Entry dialog box appears.
  2. In the Name box, type HotDocs 6.
  3. In the Path box, type or browse to the folder path of the HotDocs program executable (for example, C:\Program Files\HotDocs\hotdocs.exe).
  4. In the Type box, type HOTDOCS.
  5. At the Integration Mode drop-down list, select ODMA.
  6. Click OK.
Note: Please see the iManage documentation for more information about other settings at this dialog box.

Part 3: Create a new document class (optional)

  1. At the Database Administrator, click the Class button and select Add (Manage menu). The Add Class dialog box appears.
  2. In the Description box, type HotDocs Answer File.
  3. In the Alias, box, type ANSWER.
  4. In the Retain Days box, specify the number of days before iManage should mark documents of this class for archiving.
  5. At the Security drop-down list, select the security option you require.
  6. Click OK.
Note: Please see the iManage documentation for more information about other settings at this dialog box.

Integrate Form Documents with iManage

Note: If you have integrated previous versions of HotDocs with iManage, and have checked in HFD files with the old application ID HOTFORMS, you may want to continue using HOTFORMS as the HotDocs Filler application ID. To do this, you should replace each use of "HOTDOCSFILLER" in the following task steps with "HOTFORMS." Also, you must set the Advanced ODMA Settings in the HotDocs Options dialog box (see Part 3 in the section on setting up client computers).

In order to manage assembled form documents, you must complete the following steps in the iManage Database Administrator application:

Part 1: Create a new application type

  1. Open the Database Administrator and click a database icon to expand it.
  2. Click the Type button on the toolbar and select Add (Manage menu). The Add Type dialog box appears.
  3. In the Description box, type HotDocs Filler.
  4. In the Alias box, type HOTDOCSFILLER.
  5. In the DMS Extension box, type %V.
  6. In the App. Extension box, enter the default file name extension for the types of forms you're using. If you are using Envoy-based forms, enter HFD. If you are using PDF-based forms, you must set the default file name extension to HPD.
  7. Click OK.
Note: Please see the iManage documentation for more information about other settings at this dialog box.

Part 2: Define the application

  1. At the Database Administrator, click the App Setup button and select Add (Manage menu). The Add App Setup Entry dialog box appears.
  2. In the Name box, type HotDocs Filler 6.
  3. In the Path box, type or browse to the folder path of the HotDocs program executable (for example, C:\Program Files\HotDocs\hdfill.exe).
  4. In the Type box, type HOTDOCSFILLER.
  5. At the Integration Mode drop-down list, select ODMA.
  6. Click OK.
Note: Please see the iManage documentation for more information about other settings at this dialog box.

Part 3: Create a new document class (optional)

  1. At the Database Administrator, click the Class button and select Add (Manage menu). The Add Class dialog box appears.
  2. In the Description box, type HotDocs Form Document.
  3. In the Alias, box, type HDFORM.
  4. In the Retain Days box, specify the number of days before iManage should mark documents of this class for archiving.
  5. At the Security drop-down list, select the security option you require.
  6. Click OK.
Note: Please see the iManage documentation for more information about other settings at this dialog box.

Integrate Assembly Files with iManage

In order to manage HotDocs assembly files (.HDA), you must complete the following steps in the iManage Database Administrator application:

Part 1: Create a new application type

  1. Open the Database Administrator and click a database icon to expand it.
  2. Click the Type button on the toolbar and select Add (Manage menu). The Add Type dialog box appears.
  3. In the Description box, type HotDocs Assembly Files.
  4. In the Alias box, type HOTDOCSAA.
  5. In the DMS Extension box, type %V.
  6. In the App. Extension box, type HDA to identify the answer file extension that iManage should add to the file name for the document when it is exported from iManage.
  7. Click OK.
Note: Please see the iManage documentation for more information about other settings at this dialog box.

Part 2: Create a new document class (optional)

  1. At the Database Administrator, click the Class button and select Add (Manage menu). The Add Class dialog box appears.
  2. In the Description box, type HotDocs Form Document.
  3. In the Alias box, type HOTDOCSAA.
  4. In the Retain Days box, specify the number of days before iManage should mark documents of this class for archiving.
  5. At the Security drop-down list, select the security option you require.
  6. Click OK.

Set Up Each Client Computer

After installing the iManage DeskSite application on the client computer, you must make the following changes to the registry settings, the iManage INI file, and the HotDocs Options:

Part 1: Create the following registry keys

*For DeskSite 8.x / MailSite 8.x you will need to add the following registry values:

[HKEY_CLASSES_ROOT\HOTDOCS]

[HKEY_CLASSES_ROOT\HOTDOCS\ODMA32] ="MHODMA"

[HKEY_CLASSES_ROOT\HOTDOCSFILLER]

[HKEY_CLASSES_ROOT\HOTDOCSFILLER\ODMA32] ="MHODMA"

[HKEY_CLASSES_ROOT\WORD]

[HKEY_CLASSES_ROOT\WORD\ODMA32] ="MHODMA"

[HKEY_CLASSES_ROOT\WPF]

[HKEY_CLASSES_ROOT\WPF\ODMA32] ="MHODMA"

[HKEY_CLASSES_ROOT\ODMA32\MHODMA] ="Mhdll32.dll"

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ODMA32\AnsiOnNT]


*For DeskSite 6.x / MailSite 3.x, 4.x you will need to add the following registry values:

[HKEY_CLASSES_ROOT\HOTDOCS]

[HKEY_CLASSES_ROOT\HOTDOCS\ODMA32] ="MHODMA"

[HKEY_CLASSES_ROOT\HOTDOCSFILLER]

[HKEY_CLASSES_ROOT\HOTDOCSFILLER\ODMA32] ="MHODMA"

[HKEY_CLASSES_ROOT\MS WORD]

[HKEY_CLASSES_ROOT\MS WORD\ODMA32] ="MHODMA"

[HKEY_CLASSES_ROOT\WORDPERFECT]

[HKEY_CLASSES_ROOT\WORDPERFECT\ODMA32] ="MHODMA"

[HKEY_CLASSES_ROOT\ACROBAT]

[HKEY_CLASSES_ROOT\ACROBAT\ODMA32] ="MHODMA"

[HKEY_CLASSES_ROOT\ODMA32\MHODMA] ="Mhdll32.dll"

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ODMA32\AnsiOnNT]

Part 2: Edit the iManage INI file

  1. Open the NRT.INI file (usually found in C:\WINDOWS).
  2. Create the following entries:
[HotDocs]
.ans=HOTDOCS
.anx=HOTDOCS
.hda=HOTDOCS
SHOW_PROFILE_FOR_ODMA_NEWDOC = N
[HotDocsFiller]
.hfd=HOTDOCSFILLER
.hpd=HOTDOCSFILLER
.pdf=ACROBAT
SHOW_PROFILE_FOR_ODMA_NEWDOC = N
CAUTION: When saving a word processor or other file at the document manager, the Save as Type drop-down list may either be empty or may show UNKWN as the file type. If this happens, add similar entries to the NRT.INI file. Use the file type information used at HotDocs Options > File Management > Advanced ODMA Settings.)

Part 3: Change the HotDocs Options

  1. Run HotDocs and at the template library, select Options (Tools menu). The HotDocs Options dialog box appears.
  2. Click the File Management folder.
  3. At the Manage answer files using drop-down list, select Document Manager.
  4. At the Manage assembled documents using drop-down list, select Document Manager.
  5. At the drop-down lists for answer file and document save formats, select the desired options.
  6. At the Document manager ODMA DLL location box, provide the folder path for the ODMA DLL you are using (usually C:\Program Files\iManage\odma32.dll or C:\Windows\SysWOW64\Odma32.dll).*
  7. Click OK. The template library appears again. (You must restart HotDocs before these changes will take effect.)

*Optionally, if you have already integrated HotDocs with your document management system, you can use the application IDs and format names you have already specified. Click the Advanced ODMA Settings folder, then enter the IDs and names currently used in your DM system, such as:

  • changing MS WORD to WORD97 (for Interwoven 8, the ID is WORD)
  • changing WORDPERFECT to WPF61 (for Interwoven 8, the ID is WPF)
  • changing HOTDOCSFILLER to HOTFORMS
Note: HotDocs also includes a set of debug messages you can use to help troubleshoot the integration process. You can use these messages by creating two additional entries in the registry. Open the registry editor and browse to HKEY_LOCAL_MACHINE/SOFTWARE/HotDocs/HotDocs/File Mgt (HotDocs 10 or higher) or HKEY_LOCAL_MACHINE/SOFTWARE/LexisNexis/HotDocs 6/File Mgt (pre-HotDocs 10). Create a string called "Answer Debug" and one called "Document Debug." Set the value of both strings to "Yes." During the document assembly process, messages will appear. Before allowing users to work with the integrated applications, remember to either remove these strings or set their values to "No."
Note: This document recommends using HKEY_LOCAL_MACHINE for all registry settings related to document management. If some settings are only applicable for a single user, you could use HKEY_CURRENT_USER instead. Keys set in HKEY_CURRENT_USER will override the corresponding keys in HKEY_LOCAL_MACHINE.