Set up the Office Migration Planning Manager File Scanner for Office 2010
Applies to: Office 2010
Topic Last Modified: 2011-08-29
Setting up the OMPM file scanner is the first step in assessing documents for compatibility with Microsoft Office 2010. Download OMPM from the Microsoft Office Migration Planning Manager 2010 Update 1 download page (https://go.microsoft.com/fwlink/p/?LinkId=199599), and then use the guidance in this article to deploy and install OMPM and to become familiar with the OMPM components and the files that are generated by an OMPM scan.
In this article:
Downloading OMPM Update 1
Setting up the OMPM file scanner
Installing OMPM
Uninstalling OMPM
Files generated by an OMPM scan
Files scanned by the OMPM File Scanner
Downloading OMPM Update 1
The OMPM 2010 Update 1 installation package is available at the Microsoft Download Center (https://go.microsoft.com/fwlink/p/?LinkId=199599). Numerous fixes and improvements are available for the OMPM File Scanner, the Office File Converter (OFC) tool, and the Version Extraction Tool (VET).
Important
If you are using an earlier version of OMPM, you cannot re-use existing client scan results, databases, or any exported data with the new version of OMPM. You must create new databases and re-scan clients by using the new version.
Setting up the OMPM file scanner
To analyze your environment, you can configure the OMPM File Scanner in three ways:
Centrally-run scan The centrally-run method is the most often used method for distributing OMPM. It is typically employed to scan shared document repositories. To centrally run the file scan, put all required OMPM File Scanner files (which consist of the contents of the Scan folder) on an administrative client computer, and then run the OMPM File Scanner from that computer, scanning computers over the network. Specify the folders that you want to scan by configuring the value of the FoldersToScan setting in offscan.ini. By distributing the OMPM files centrally, you can change the OMPM file scanner configuration file (offscan.ini) on the administrative computer without having to redistribute it to every computer on the network.
Distributed scan from shared folder To use the distributed scan from the shared folder method, place the required OMPM File Scanner files (which consist of the contents of the Scan folder) on a central share. Then run the OMPM File Scanner from that share on the target client computers, scanning local computer hard drives or servers. This method also lets you change the OMPM File Scanner configuration file (offscan.ini) in the central location without having to redistribute it to every computer on the network. For this method, you also have the option of copying a script to each computer that starts the OMPM File Scanner from a file share. The scanner is invoked on a client computer by a command similar to the following:
Pushd \\<OMPM Admin Server>\<Scan shared folder>
Then, you execute offscan.exe from this newly mapped location. You must start offscan.exe from a mapped location to enable the scanner to recognize the scan configuration file. You can start the scan manually on clients or by using a script. Scanning can be performed silently on the client computers to keep the process transparent to the users.
Decentralized scan To use the decentralized scan method, distribute and run the OMPM file scanner files (the contents of the Scan folder) on each client computer and run the OMPM File Scanner locally. You can distribute the file scanner components by using your selected software installation tool, which includes logon scripts, Microsoft Deployment Kit Lite Touch, or System Center Configuration Manager. You can automatically save Cab files to the central log server by configuring the administrative client shared server location as the scan log destination in the
DestinationPathsetting in the offscan.ini configuration file. We recommend that you use this method if you plan to scan lots of files on each client computer.
When it runs, Offscan.exe silently installs itself on the client computer being scanned to ensure the executable file can be tracked. It also automatically uninstalls itself after it finishes a scan. If installations of Offscan.exe remain on computers on the network after you complete the scans, they can be safely removed.
The following files, which are contained in the Scan folder in the OMPM download package, are the required files for running the OMPM file scanner:
OFFSCAN.EXE OMPM File Scanner program
ACCSCAN.DLL Application library modules
OFFSCAN.INI Configuration file
MSVBVM50.DLL Visual Basic 5.0 runtime version
SYSTEM.MDW Access system database
When you run offscan.exe, it reads the offscan.ini configuration file for specifics about how to run the file scan. You must configure offscan.ini before you distribute OMPM file scanner files or run a file scan. For information about the settings that you can configure in the offscan.ini configuration file, see Office Migration Planning Manager Offscan.ini settings for Office 2010.
Installing OMPM
Where you install the OMPM files depends on the deployment method that you select. For more information, see the descriptions about the Centrally-run scan, Distributed scan from shared folder, and Decentralized scan methods.
To install OMPM
On the central administration computer, at a command prompt, type the following, and then press ENTER: MigrationPlanningManager2010Update1.exe
Review the usage terms, and then click Accept.
Confirm the location of the extracted files. The default location is c:\ompm. Change the location if you want, and then click Extract. Extraction is completed at the location that you specified.
Uninstalling OMPM
The following procedures provide steps for uninstalling OMPM from an administration computer and a client computer. The OMPM files are installed on the administration computer or client computers, depending on the deployment method that you chose. For more information, see the descriptions about the Centrally-run scan, Distributed scan from shared folder, and Decentralized scan methods.
To uninstall OMPM from an administration computer
At a command prompt, type: DeleteDB.bat <ComputerName>\<SQLServerName> <DatabaseName>
Delete the following folders (and their contents) from the original setup location (for example, c:\ompm): Catalog, Database, Report, Scan, and Tools.
Delete the OMPM 2010 scan log files from the location that is specified in the DestinationPath setting in the offscan.ini configuration file.
To uninstall OMPM on a client computer
Delete any distributed components from each client computer.
To safely track scanner executions, delete registry entries made by the scanner.
OMPM scan registry entries are stored in the HKCU\Software\Microsoft\OMPM key.
Do not delete RunID entries. Otherwise you might use the same RunID for another scan and duplicate the scan results.
Files generated by an OMPM scan
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 a set of XML log files in the folder that is defined by the Destination setting in the offscn.ini configuration file. Optionally, the logs can be compressed into a .cab file after the scan by configuring the CABLogs setting in the offsca.ini configuration file.
In addition, OMPM includes the latest Access Compatibility Toolkit, which it uses automatically when you scan Microsoft Access files together with it (provided you have set the AccessScan setting to 1 in the Offscan.ini file), and shows the results on the Access Compatibility tab of the reporting tool.
Log and .cab files generated by the OMPM File Scanner
For 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 that has a prefix that indicates the kind of log file.
The OMPM File Scanner creates four 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 can be compressed into .cab files to make transport to the Microsoft SQL Server database more efficient. Each .cab file can contain up to 10,000 log files. After the log files are added to the .cab file, the original log files are deleted. When a .cab file reaches 10,000 log files, the OMPM File Scanner creates a new .cab file for the next 10,000 files. You can disable .cab file creation by changing the CABLogs setting in Offscan.ini from the default setting, 1, to 0 (not recommended, for performance reasons, if you scan more than several thousand files).
The .cab files use the file name from the ScanID GUID and they are appended by an index number. 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. Log files should generally be stored on computers that are geographically close to scanned computers and on the same subnet. 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, together with file types that are included in the light scan and macro scan only.
Note
The OMPM file scanner does not scan files in the OpenXML format (.xlsx, .pptx, .docx) unless you explicitly add them to the Ext setting in Offscan.ini.
| Microsoft Office 97 – 2003 programs | Light and deep scan file types | Light scan only | Macro scan only |
|---|---|---|---|
Access |
|
||
Excel |
|
|
|
PowerPoint |
|
|
|
Project |
|
||
Publisher |
.pub |
||
Visio |
|
||
Word |
|
|
See Also
Concepts
Office Migration Planning Manager overview for Office 2010
Run the Office Migration Planning Manager File Scanner for Office 2010
Import Office Migration Planning Manager log files into a database
Analyze Office Migration Planning Manager Reports for Office 2010
Convert binary Office files by using the Office File Converter (OFC) and Version Extraction Tool (VET)