Integrate HotDocs 6/2005 with Hummingbird's DM5

From HotDocs Wiki

Jump to: navigation, search

You can integrate HotDocs 6.1 and higher with DM5, a document management solution available from Hummingbird. This type of integration will manage your HotDocs answer files and assembled form and text documents.

CAUTION: If you are using DM5.1, you should install Hummingbird's Patch 1 before continuing. This patch corrects a DM5.1 error that causes HotDocs Filler to crash when you exit the program. If you cannot install this patch, you can also prevent these crashes by limiting the way HotDocs Filler checks files into DM5.1. To do this, start Regedit and add the following string key: HKEY_LOCAL_MACHINE\Software\HotDocs\HotDocs\File Mgt\Filler impersonates Acrobat. (For versions of HotDocs prior to 10, use ...\Software\LexisNexis\HotDocs 6\... instead.) Then set the value of this key to No.

When integrating with DM5, you must complete the following steps:

Contents

Part 1: To add the HotDocs application to DM5

Note: Please see the DM5 help files for more information about other settings at these dialog boxes.
  1. Log in to DM5 as an Administrator.
  2. At the DM5 application page, click the DM Admin tab, then the Validation Tables tab, and then the Applications tab.
  3. Click the Add button and enter the following information:
    • Application ID: HOTDOCS
    • Description: HotDocs 6
    • Filing Scheme: Enhanced.
  4. Click the Save button. The available applications page appears again.
  5. Click HOTDOCS, then click Launch Methods.
  6. Click the Add button and enter the following information:
    • Application: HOTDOCS
    • Description: HotDocs 6
    • Location: C:\Program Files\HotDocs\hotdocs.exe
      (For versions of HotDocs prior to 10, use C:\Program Files\HotDocs 6\hotdocs6.exe instead.)
    • Integration: ODMA Compliant
    • Enabled: (selected)
  7. Click the Save button. The launch methods page appears again.
  8. Click the Close button. The HOTDOCS application page appears again.
  9. Click File Types, then click the Add button and enter the following information:
    • File Extension: ANS
    • Description: HotDocs Binary Answer File
  10. Click the Save button. The file types page appears again.
  11. Click the Add button again, and enter the following information:
    • File Extension: ANX
    • Description: HotDocs XML Answer File
  12. Click the Save button. The file types page appears again.
  13. Click the Close button. The HOTDOCS application page appears again.
  14. Click the Save button. The available applications page appears again.
CAUTION: DM5.x requires a document type to be specified for each document you will be working with. If you haven't already defined a document type for HotDocs answer files, you should do so now. At the available applications page, click the Document Types tab. Click the Add button, then enter a type ID, such as HDAnswers and a description, such as HotDocs Answer File. Then click Save, and then the Applications tab.

Part 2: Add the HotDocs Filler application to DM5

Note: If you have integrated previous versions of HotDocs with DM5, 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 5).
Note: Please see the DM5 help files for more information about other settings at these dialog boxes.
  1. At the DM5 web page, click the DM Admin tab, then the Validation Tables tab, and then the Applications tab.
  2. Click the Add button and enter the following information:
    • Application ID: HOTDOCSFILLER
    • Description: HotDocs Filler 6
    • Filing Scheme: Enhanced
    • MIME Type: application/x-hotdocs-hfd
    • Default Extension: HFD
    Note: If you have PDF Advantage installed, leave the MIME Type and Default Extension boxes empty.
  3. Click the Save button. The available application page appears again.
  4. Click HOTDOCSFILLER. The HOTDOCSFIILLER application page appears.
  5. Enter the following information:
    • Print Application: HOTDOCSFILLER
    • Viewer Application: HOTDOCSFILLER
  6. Click the Save button. The available application page appears again.
  7. Click HOTDOCSFILLER, then click Launch Methods.
  8. Click the Add button and enter the following information:
    • Application: HOTDOCSFILLER
    • Description: HotDocs Filler 6
    • Location: C:\Program Files\HotDocs\hdfill.exe
      (For versions of HotDocs prior to 10, use C:\Program Files\HotDocs 6\hdfill6.exe instead.)
    • Command Line Parameters: %FULLPATH
    • Integration: ODMA Compliant
    • Enabled: (selected)
  9. Click the Save button. The launch methods page appears again.
  10. Click the Close button. The HOTDOCSFILLER application page appears again.
  11. Click File Types, then click the Add button and enter the following information:
    • File Extension: HFD
    • Description: HotDocs Form Document
  12. Click the Save button. The file types page appears again.
  13. Click the Close button. The HOTDOCSFILLER application page appears again.
  14. Click the Save button. The available applications page appears again.
  15. In the list of applications, click MS WORD. (You may need to move to the second page of available applications.) The MS WORD application page appears.
  16. Click File Types, then click the Add button and enter the following information:
    • File Extension: RTF
    • Description: Word RTF Document
  17. Click the Save button. The file types page appears again.
  18. Click the Close button. The MS WORD application page appears again.
  19. Click the Save button. The available applications page appears again.
    CAUTION: DM5.x requires a document type to be specified for each document you will be working with. If you haven't already defined a document type for HotDocs form templates, you should do so now: At the available applications page, click the Document Types tab. Click the Add button, then enter a type ID, such as HDForms, and a description, such as HotDocs Form Templates. Then click Save, and then the Applications tab.
    Note: If you use HotDocs PDF Advantage, continue with the following steps:
  20. Click HOTDOCSFILLER. The HOTDOCSFILLER application page appears.
  21. Click File Types, then click the Add button again and enter the following information:
    • File Extension: HPD
    • Description: HotDocs PDF Document
  22. Click the Save button. The file types page appears again.
  23. Click the Add button again and enter the following information:
    • File Extension: PDF
    • Description: Portable Document Format
    Note: Adding this PDF file types entry may cause DM5.x to ask whether you want to use Adobe Acrobat or HotDocs Filler each time you use Filler to save a form document as a PDF file. DM5.x may not remember the application you used previously. To avoid re-selecting the application each time, do not add this PDF entry to the file types. This will cause DM5.x to suggest Acrobat each time.
  24. Click the Save button. The file types page appears again.
  25. Click the Close button. The HOTDOCSFILLER application page appears.
  26. Click Compatible Apps.
  27. Select ACROBAT from the Non-Compatible Apps list, then move it to the Compatible Apps list.
  28. Click the Save button. The HOTDOCSFILLER application page appears again.
  29. Click the Save button. The available application page appears again.
Note: HotDocs Filler is able to open PDF files that have been profiled under ACROBAT. To do this, add HOTDOCSFILLER to the list of applications that are compatible with Acrobat.

Part 3: Create a deployment package for clients using HotDocs

Note: Please see the DM5 help files for more information about other settings at these dialog boxes.
  1. At the DM Admin web page, click the DM WebTop Maintenance tab.
  2. At the Deployment Packages tab, click the Add button and type name for the deployment package (for example, ODMA INTEGRATION).
  3. Under the Components heading, click the blue arrow (>) next to Hummingbird DM Application Integration, and then click the blue arrow (>) next to Integration Options for Other Applications.
  4. Select ODMA Integration.
  5. Click the Save button. The deployment packages page appears again.

Part 4: To install the deployment package on each client computer

Note: Please see the DM5 help files for more information about other settings at these dialog boxes.
  1. Log on to DM5 at the client computer.
  2. At the DM5 application page, click My Options (located in the top-right corner of the page).
  3. Click the Optional Components tab.
  4. Select the deployment package created in the previous section (for example, ODMA INTEGRATION).
  5. Click the Install Components button, and follow the InstallShield directions.

Part 5: To change HotDocs Options to enable integration

  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 odma32.dll, commonly found in the Windows System folder or the program folder for the document management system).
  7. 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 for existing documents in DM5. 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
    • changing WORDPERFECT to WPF61
    • changing HOTDOCSFILLER to HOTFORMS
  8. Click OK. The template library appears again. (You must restart HotDocs before these changes will take effect.)
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. (For versions of HotDocs prior to 10, use ...\Software\LexisNexis\HotDocs 6\... instead.) 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: It is recommended you use HKEY_LOCAL_MACHINE for all registry settings related to document management. If some settings are applicable only 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.