Introduction to Office Migration Planning Manager (OMPM)
Updated: May 20, 2010
Applies To: Office Resource Kit
This Office product will reach end of support on October 10, 2017. To stay supported, you will need to upgrade. For more information, see , Resources to help you upgrade your Office 2007 servers and clients.
Topic Last Modified: 2016-11-14
In this article:
OMPM contents
Installing OMPM
OMPM requirements
How the OMPM File Scanner works
Log and CAB files generated by the OMPM File Scanner
Files scanned by the OMPM File Scanner
Filter for Excel, Word, or PowerPoint files that use macros
OMPM compatibility
Removing OMPM
Download this book
The Office Migration Planning Manager (OMPM) is a collection of tools that enables you to prepare your environment for migration to the 2007 Microsoft Office system. OMPM checks for, and reports on, file properties and contents to help you analyze your environment and determine any issues that you might experience converting from Office 97-Office 2003 file formats to the new 2007 Office system file format.
For the most part, documents created in Office 2003 and earlier open and behave the same way in the 2007 Office release. However, there might be instances where files require manual intervention or analysis to ensure consistent behavior. For example, a custom solution built in Microsoft Office Excel 2003 might require modification because it relies on legacy Office features that are no longer supported in Microsoft Office Excel 2007.
OMPM focuses primarily on converting old files to the new file formats. When OMPM shows an error or highlights a warning on a file, that does not mean the file will not open in the 2007 Office system (most older files can open in compatibility mode). It only means that saving it into the new OOXML format could cause problems.
OMPM includes the following features:
The OMPM File Scanner (offscan.exe), a command-line tool that scans files for conversion issues. You can easily deploy this tool by using an automated software deployment technology, such as Microsoft System Center Configuration Manager 2007, or a logon script. The OMPM File Scanner stores the scan results in XML log files on each computer that it scans, and optionally bundles these logs into CAB files. The OMPM File Scanner performs two kinds of scans:
A light scan that quickly identifies the Office documents on a user’s computer or network file system.
A deep scan that you can perform on Office documents to gather document properties that provide indicators of potential conversion issues.
A set of utilities that automates the creation of a new database (either Microsoft SQL Server 2000, SQL Server 2005, or SQL Express) and imports the XML log files generated by the OMPM File Scanner.
A Microsoft Office Access 2007–based reporting solution that provides different reports for your analysis and enables you to define file sets for automated processing.
The Office File Converter (OFC) that lets you convert specific files to the new 2007 Office release file formats in bulk.
The Version Extraction Tool (VET) that lets you extract saved versions of a file in Word 2003 (or earlier) to different files.
OMPM contents
OMPM is contained in a self-extracting executable file, MigrationPlanningManager.exe. OMPM Components are contained in redistributable subfolders:
Scan: The folder that contains the OMPM File Scanner.
Report: The folder that contains OMPM Reports. To export file lists from OMPM Reports, the database folder and related components must also be available.
Database: The folder that contains scripts to provision and populate the OMPM database.
Tools: The folder that contains tools such as the Office File Converter and Version Extraction Tool.
Installing OMPM
You can download OMPM from 2007 Microsoft Office System Migration Guidance: Microsoft Office Migration Planning Manager (https://go.microsoft.com/fwlink?linkid=75727).
To install OMPM, at a command prompt, type: MigrationPlanningManager /extract:c:\ompm. You can replace c:\ompm with another location.
For help with OMPM, at a command prompt, type: MigrationPlanningManager /?.
To view a video demonstration about how to use OMPM, see Using the Office 2007 Migration Planning Manager (https://go.microsoft.com/fwlink/?LinkID=191781\&clcid=0x409).
OMPM requirements
The following lists the requirements for running OMPM, both for the client systems that it scans and the administrator system from which it runs.
Client system requirements
The OMPM File Scanner requires the following programs on the computers that it scans:
Windows 2000 SP4, Windows XP SP3, or Windows Server 2003 SP1
Internet Explorer 5.0 or a later version
The following system components must exist on all computers that are running the OMPM File Scanner. If these files do not exist, install the files with a separate distribution job before you run the OMPM File Scanner.
Data Access Objects 3.5 or a later version (dao350.dll/dao360.dll). These files are included in Microsoft Access 97, Microsoft Windows 98, Microsoft Windows NT 4.0 Option Pack, and Windows NT 4.0 Service Pack 4.
Microsoft Scripting Runtime (sccrun.dll). This file is included in Microsoft Access 2000, Windows NT 4.0 Option Pack, Windows NT 4.0 Service Pack 5, and Windows Script Host.
Visual C Runtime (msvcrt.dll).
Kernel32.dll.
Msjet40.dll.
Crypt32.dll.
Ole32.dll.
Oleaut32.dll.
User32.dll.
Advapi.dll.
Msvcrt.dll.
All computers that contain files to convert are required by the Office File Converter (OFC) to install the Microsoft Office Compatibility Pack. For more information, see Deploying the Microsoft Office Compatibility Pack.
The Version Extraction Tool (VET) requires installation of Microsoft .NET Framework Version 2.0 Redistributable Package (x86) (https://go.microsoft.com/fwlink/?LinkId=81886) and Microsoft Word 2003.
Administrator system requirements
The administrator running OMPM requires the following:
Computer and operating system
A computer that is running Windows XP SP2 or Windows Server 2003 to use the database provisioning and data import tools in OMPM.
Optional: A computer that is running Windows XP to create a self-extracting package with IExpress 2.0.
Note
Use IExpress 2.0 to create a self-extracting package. Do not use a self-installing package.
Database software
SQL Server 2000 or SQL Server 2005 (recommended). SQL Server 2005 is recommended for enterprises working with large amounts of data. SQL Server 2005 provides enhanced database management and reports. The database should have a minimum of 4 GB available free disk space.
Microsoft SQL Server 2005 Express Edition. This free, redistributable version of SQL Server 2005 is ideal for client applications that require an embedded database. You can use SQL Server 2005 Express Edition, instead of SQL Server 2005, for smaller-scale data collection. The database should have a minimum of 2 GB available free disk space. SQL Server 2005 Express Edition is available as a free download at SQL Server 2005 Express Edition (https://go.microsoft.com/fwlink/?LinkId=95582\&clcid=0x409).
Database tools and utilities
Both SQL Server 2005 and SQL Server 2005 Express Edition include several command line utilities, such as Osql.exe and Bcp.exe. These must be available on the client computer from which the provisioning and import tools are run.
SQLXML 3.0 SP3. SQLXML enables XML support for your SQL Server 2005 database. This module allows XML files that are collected by the OMPM File Scanner to be imported efficiently into a database server. SQLXML is a free download available at SQLXML 3.0 Service Pack 3 (SP3) (https://go.microsoft.com/fwlink?linkid=52919).
Note
We recommend that you use the English editions of SQL Server 2005 or SQL Server 2005 Express Edition to use OMPM. Although there are no known issues involving international editions, only the English edition is supported for these tools at this time.
File share
A file share is required to stage the XML log files collected by the OMPM File Scanner before the log files are imported into the database. The file share should have a minimum of 1 GB available space. Any account that is operating the import scripts requires read/write/create access to the file share.
Note
For performance reasons, it is optimal to have the import tools, log file share, and database on the same server. If this is not possible, the log file share and the database server should be on the same subnet to reduce network traffic.
Other
OMPM Reports requires the installation of Office Access 2007 on the client computer from which the data will be examined. To export file lists from OMPM Reports, SQL Server Express or SQL Server and SQLXML 3.0 SP3 must be installed on the computer that runs OMPM Reports.
To perform a deep scan with the OMPM File Scanner, Access 2002 or a later version must also be installed on the computer that runs the OMPM File Scanner.
Note
Other than the requirement listed previously, the OMPM File Scanner does not require the installation of any version of Office on any computer it scans.
For scanning document storage systems such as Microsoft SharePoint Services, the OMPM File Scanner requires the Web-based Distributed Authoring and Versioning (WebDAV) interface. For more information about WebDAV, see About WebDAV (IIS 6.0) (https://go.microsoft.com/fwlink/?LinkID=81698). This is the only version of WebDAV that is supported for OMPM.
Note
Use either the Windows Vista WebDAV client or a third-party WebDAV client for document libraries that are SSL-enabled. If you use the WebDAV client from previous versions of Windows, the scan of the document library fails.
How the OMPM File Scanner works
The OMPM File Scanner collects information about the computer and recursively scans the designated path for Office files. The OMPM File Scanner then records the results in an XML log file to the designated destination path.
File formats from Office 95 and earlier are different enough from Office 97-Office 2003 file formats that we have listed specific issues Review migration issues for the 2007 Office system. For example, in Access 95, OMPM can identify that the database is Access 95, and generates Access error 19, “Unsupported legacy format – forms, reports, and module will be lost.” This means that Office Access 2007 can open and read the file, but any forms, reports, or modules will be unavailable and will be left out if you save the file in the new format. OMPM includes the latest Access Compatibility Toolkit. It uses it automatically when you scan an Access file with it, and shows the results on the Access Compatibility tab of the reporting tool.
Note
With the exception of those listed in Compatibility mode in the 2007 Office system, all Office 97-Office 2003 files are viewable in the 2007 Office system format, and can use all the 2007 Office system features.
The OMPM File Scanner performs the following tasks in a single scan:
Scans the computer for Office files within the folder structure that is defined by the SourcePath specified in the configuration file offscan.ini.
Scans the computer for properties such as operating system, memory, and language ID.
Scans for file property information such as file name, path, size, format, created date, modified date, and file owner.
If this is a deep scan, scans for compatibility issues.
Writes an XML log file to the destination path for each file that contains compatibility issues.
Adds the XML log files to a series of CAB files for later transfer to a SQL Server computer.
Logs failures to the XML log files.
Note
The OMPM File Scanner does not change file properties, except possibly Last Accessed Date.
Note
The OMPM File Scanner does not transmit data to Microsoft Corporation.
Log and CAB files generated by the OMPM File Scanner
On each computer that it scans, the OMPM File Scanner writes an XML log file to the destination folder that you specified in the accompanying offscan.ini file. This initial log file contains both scan and computer details. After this, the OMPM File Scanner creates an XML log file for each additional Office file that it scans. The file name for each log file is in the form of a GUID, with a prefix indicating the kind of log file.
The OMPM File Scanner creates four unique kinds of log files to record properties about the computer scanned, file scanned, scan summary, and errors. The following table shows a typical set of log files.
| File name | Description |
|---|---|
Scan_{40D1300A-F0BE-4D68-ADBF-36C78EE030A1}.xml |
Scan log (one per scan) |
File_{F575D370-1E7A-486E-9FC6-4BB83C7770DD}.xml |
File properties log (one per unique file scanned) |
Sum_{75C5A590-A789-4B16-A2EB-E3934BCB01B1}.xml |
Summary log |
Err_{61CF0E6F-71E1-4878-9E9F-C1D35EBA3506}.xml |
Error log (one per unique error occurrence) |
The individual log files are compressed into CAB files to make transport to the SQL Server database more efficient. To maximize disk space on the computer that is scanned, after OMPM File Scanner writes 10,000 log files, adds the log files to a CAB file, and then deletes the log files. Each CAB file contains up to 10,000 log files. When a CAB file reaches 10,000 log files, OMPM File Scanner creates a new CAB file for the next 10,000 files.
CAB files use the file name from the ScanID GUID, with an index number appended. Three CAB files generated on the same computer might generate names such as the following:
Computer1 {2FA87EDF-4393-4BCF-8829-8776F82DEDD5}00001.cab
Computer1 {2FA87EDF-4393-4BCF-8829-8776F82DEDD5}00002.cab
Computer1 {2FA87EDF-4393-4BCF-8829-8776F82DEDD5}00003.cab
Creating CAB files can be harmful to performance if log files are saved over a network. Use the setting CABlogs=1 in the Offscan.ini file to disable the creation of CAB files.
Files scanned by the OMPM File Scanner
The following table shows the file types that are scanned by the OMPM File Scanner, and file types that are included in the light scan only.
| Microsoft Office program | Light and deep scan file types | Light scan only |
|---|---|---|
Access |
|
|
Excel |
|
|
PowerPoint |
|
|
Project |
|
|
Publisher |
.pub |
|
Visio |
|
|
Word |
|
Files from Microsoft Office Outlook, Microsoft Office FrontPage, Microsoft Office OneNote, and Microsoft Office InfoPath are not included in either the light or deep scan.
Note
The OMPM File Scanner does not scan documents that are password-protected or IRM-protected. In addition, the OMPM File Scanner does not scan embedded objects within documents, but does report that the document contains embedded objects.
Filter for Excel, Word, or PowerPoint files that use macros
The Office Migration Planning Manager does not report on any macro conversion issues, but will find all documents that have VBA projects. Even if the VBA project is empty, it will still be reported as having a project. All this can then be imported into your scan results, in a new database, to filter specifically on macros.
Open OMPM\Database\Include\ProvisionDB.SQL (make a backup).
Insert the following line into the section that creates the osVBAProperty table (line 718). This adds a new column named NoVBAProject to osVBAProperty table.
[NoVBAProject] [bit] NULL,
Open OMPM\Database\Schemas\LogFileMapping.xml (make a backup).
Insert the following line at the end of the section that describes the other VBA project properties (line 95):
<ElementType name="NoVBAProject" dt:type="boolean" sql:datatype="bit"/>
Insert the following line into the element type description of the relation between VBA Properties and the osVBAProperty table (line 287):
<element type="NoVBAProject" sql:field="NoVBAProject" />
Create a new OMPM database.
Import Scan results. (You can re-import older scan results by moving them one level out of the \OMPM Imported folder.)
This new NoVBAProjects column is not exposed in the Reporting Tool. Therefore, you will need to run an SQL query directly against the OMPM database:
SELECT * FROM osScanFile WHERE scanfileID IN (SELECT scanfileID FROM osVBAProperty WHERE NoVBAProject = 0)(You can customize this query and join it with other tables for more information if you want.)
Note
If you have scanned the same files multiple times, you might consider taking advantage that the CSIDL will not change for a single file over multiple scans.
For example, the following query will not duplicate reporting if you have scanned files more than once:SELECT distinct filename,filepath,modifieddate,csidl FROM osScanFile WHERE scanfileID IN (SELECT scanfileID FROM osVBAProperty WHERE NoVBAProject = 0)
OMPM compatibility
When you use the Office Migration Planning Manager (OMPM) to determine the compatibility of Office 2003 files with the 2007 Office system, OMPM refers to links within Microsoft.com for assistance. These links are listed in the following table. If you change the values in the HelpURL column of the omIssue table in the OMPM database, the corrected links will appear in OMPM reports and SQL queries.
Article title |
Old link |
New link |
Affected IssueID’s |
Differences in the 2007 Office system |
https://technet2.microsoft.com/Office/en-us/library/0792e43a-3183-454a-8050-fe69790bf5c61033.mspx |
https://go.microsoft.com/fwlink/?LinkId=134560 |
1000, 1001, 1002, 1003, 1010, 1050 |
Changes in Word 2007 |
https://technet2.microsoft.com/Office/f/?en-us/library/e55b85c1-213f-47d5-809c-aba9331ae0331033.mspx |
https://go.microsoft.com/fwlink/?LinkId=134561 |
1100 |
Changes in PowerPoint 2007 |
https://technet2.microsoft.com/Office/f/?en-us/library/9f33abf2-99a8-4550-bebc-b4a8fbb1322b1033.mspx |
https://go.microsoft.com/fwlink/?LinkId=134562 |
1200, 1201, 1202, 1203, 1204, 1205, 1206, 1207 |
Changes in Excel 2007 (still works) |
https://technet2.microsoft.com/Office/en-us/library/bee594b4-01b1-4d17-90ca-d43735a7382a1033.mspx |
https://go.microsoft.com/fwlink/?LinkId=134563 |
1300, 1301, 1302, 1303, 1304, 1305, 1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313 |
Removing OMPM
Use the following procedure to completely remove the OMPM tools and data from your computer.
To remove OMPM
Run DeleteDB.bat. This batch file deletes one database at a time. Therefore, you might need to run DeleteDB.bat several times if you have created multiple OMPM databases.
At a command prompt, navigate to the OMPM\Database folder, and then type:
DeleteDB.bat <ComputerName>\<SQLServerName> <DatabaseName>
For example, if your computer name is COMPUTER1, the database server is SQLEXPRESS, and the database name is OMPM001, at the command prompt, type:
DeleteDB.bat COMPUTER1\SQLEXPRESS OMPM001
Optionally, you can manually delete the scan data (XML log files and CAB files) OMPM created. The scan files are in the folder that you specified in the DestinationPath setting in offscan.ini.
Delete the \OMPM folder.
Run regedit, and delete the HKLM\Software\Microsoft\OMPM key.
Download this book
This article is included in the following downloadable books for easier reading and printing:
See the full list of available books at Downloadable content for the 2007 Office Resource Kit.