ODMA: Open Document Management API

FAQ Q980101

Configuring Microsoft Office for ODMA

ODMA>
FAQ>
1998>

Q980101>

0.25 2007-07-28 -11:14 -0700


This response addresses questions about integration of Microsoft Office applications in ODMA configurations:

Latest News [2005-01-07]: Microsoft Office 2003 Word and PowerPoint remain ODMA-aware.  The procedure in this FAQ continues to apply.  (If it is not performed, the ODMA API calls from Office 2003 will be performed incorrectly.)  Confirmation of operation with Microsoft Office 2003 can be done but it requires care in how the ODMA middleware and samples are installed so that logs can be produced for inspection.  Expanded FAQ on how to perform the installation will be produced in the next week near future.

Note that the Microsoft Office Binder is not supported in Office 2003, and the unbind utility for converting binders requires that any DMS-stored binder be retrieved to the user's local disk first.

We do not have support status information on Microsoft Office Visio 2003 and later at this point.

1. Microsoft Office ODMA Integration

2. Configuring Microsoft Office for ODMA

3. Other Conditions to Check

Contributors

Change History


1. Microsoft Office ODMA Integration

1.1 ODMA-Aware Components in Microsoft Office

Components of Microsoft Office have been ODMA-aware since Office 97 was released.

The components that have consistently supported ODMA are 

Other applications, such as Microsoft Excel, have not been integrated with ODMA as of Microsoft Office 2000.  

The implementation of ODMA-aware document access appears to be limited to the components that use the same shared implementation of file-access dialogs and code.

1.2 Assumptions about ODMA in Microsoft Office

see also:
X000600: Word 2000 + ODMA32 + SampleDMS

On Windows NT 4.0 and all recent versions of Win32 platforms (Windows 98, Windows 98 SE, etc.), Microsoft Office is configured to operate in Unicode by default.  

The ODMA Connection Manager and ODMA DMS Integrations are not Unicode-enabled.  This applies to all implementations of the ODMA specification from ODMA 1.0 to ODMA 2.0.

When a Unicode-based Microsoft Office application is also ODMA-aware, one of two symptoms will occur:

1.3 Reconciling Microsoft Office and ODMA

Microsoft provides registry settings that cause Microsoft Office applications to communicate over the ODMA API using the ANSI character code supported by ODMA.

Presence of the following Windows Registry key causes Microsoft Office to operate correctly with ODMA:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ODMA32\ANSIonNT

This registry key applies on any Win32 platform, not just Windows NT.

2. Configuring Microsoft Office for ODMA

Modification of a registry key is required to configure Microsoft Office to operate with ODMA in the ODMA-accepted character set.

On some configurations (e.g., Windows XP, Windows 2000) you will require administration privileges to perform the modifications.

The change, if correctly made, is harmless on a configuration where Microsoft Office does not require the registry information or where ODMA is not being used.  The change can be safely made anytime there are symptoms of the kind described above (section 1.2).

2.1 Automatic Configuration

2.1.1 Obtaining Registry Modification File

Download the short text file msodma.reg.

Or manually create the file with the following text and then save it with name msodma.reg:

REGEDIT4

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ODMA32\ANSIOnNT]

2.1.2 Changing the MS Office Registry Entry for ODMA Usage

  1. In Windows, find the file msodma.reg where you placed it.

  2. Double-click on the file name or icon.

The Registry should be updated automatically.

Restart your machine to ensure that the configuration of Microsoft Office will be adjusted the next time an Office application is started.

If difficulties persist, review the suggestions in section 3, Other Conditions to Check.

2.2 Manual Configuration

 To perform the registry adjustments automatically, perform the following steps:

  1. Open the Microsoft Windows Registry Editor, regedit:
    Open the Start Bar menu Start | Run ...
    Enter regedit
    Click OK

  2. When the registry tree is presented, expand down the path 
    HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ODMA32\ANSIonNT

  3. If the full path is not present, add new keys until it is.

  4. There is no default value required for ANSIonNT.  It is sufficient that there is the key.

3. Other Conditions to Check

see also:
Q000603: Latest ODMA Software

If Microsoft Office does not operate with ODMA after the registry key is set, check the following conditions:

  1. Make sure that there is a current version of ODMA32.dll in the Windows\SYSTEM directory (as named in your Win32 configuration).

  2. Make sure that a global default DMS is specified.

  3. Make sure that, if there is a separate default DMS assigned for the MS Office component, the registry entry for that assignment is correct and there is a correct registry entry for the ODMA32 DMS:

    • The ODMA Application ID for Microsoft Word is "MS Word"

    • The ODMA Application ID for Microsoft Powerpoint is "MS PowerPoint"

Check the Microsoft Knowledge Base (Using ODMA as a search key) for any new information about ODMA Support.  For example, the procedure of this FAQtip is described at http://support.microsoft.com/default.aspx?scid=kb;en-us;166865.

Check other resources for support information about Microsoft Office applications for tips and information about MS Office and ODMA.


Contributors

Robert Barham (0.10)
1999-01-28 contributed the procedure and an e-mail explanation for configuring Word97.
Jonathan Cecil (0.10)
confirmed, with Microsoft Knowledge Base reference, that Word 2000 and configurations on Windows 2000 tend to fail rather than just ignore ODMA when ANSI communication with ODMA is not selected in the registry.  This resolved X000600 too.
Jonathan Cohen (0.15)
requested clarification about the versions of Windows that this applies for, as well as requesting a tool to make the change
Dennis Hamilton (0.10)
(0.10) researched the question and compiled the FAQtip from the earlier contributions.  (0.20) Dennis later confirmed the Office 2003 behavior, how to troubleshoot the connection of Office 2003, and identified the Office 2003 components that are ODMA-aware.
Colin O'Brien (0.10)
provided the registry correction procedure through his first ActiveDoc ODMA FAQ page.
S. Ramanathan (0.10)
reported X000600 and confirmed that it is resolved by re-configuration of MS Office to use ANSI instead of Unicode.

History

0.25 2005-02-02 Touch Up as Part of ODMA Refresh
This tip is moved and renumbered, with format and organization in line with the on-going refresh.  A tombstone is introduced in the previous location.  A diary and job jar is added for capturing work items that apply to this FAQtip.
0.20 2005-01-07 Add Office 2003 Initial Findings
The examination of Office 2003 and confirmation of ODMA support is included as a bulletin until the response can be expanded and tied to additional materials.
0.16 2004-08-17 Refresh Links (orcmid)
Correct links to Microsoft Knowledge Base and Support pages.
0.15 2002-05-06-14:44 Confirm .reg Operation
Updated to confirm that the update is appropriate on all Win32 configurations, and that a .reg file can be used to make the change.
 0.10 2000-10-20-10:08 Provide Basic Information
Minimalist information providing a sketch to be reviewed and developed further.  The tips for this have been available and in circulation since Microsoft Office 97 supported ODMA, but the configuration requirements have not been consolidated in one place for reference until now.
   

Hard Hat Area (Construction Zone) You are navigating the
ODMA Interoperability Exchange.

created 2000-10-19-08:16 -0700 (pdt) by orcmid
$$Author: Orcmid $
$$Date: 07-07-28 11:15 $
$$Revision: 31 $