Run the Office Migration Planning Manager File Scanner for Office 2010
Published: May 12, 2010
After you configure the offscan.ini file, you can run the Office Migration Planning Manager (OMPM) file scanner from the command line. This article explains how to run the file scanner and describes the Offscan.ini settings and values. Offscan.ini is the configuration file that the OMPM File Scanner reads to obtain information about how to perform the scan. If you have not yet installed OMPM, see Set up the Office Migration Planning Manager File Scanner for Office 2010 to get started.
In this article:
The OMPM file scanner performs actions that are based on the settings that are configured in the offscan.ini configuration file. You must configure settings in offscan.ini before you run a scan. The settings in offscan.ini define the type, scope, and analysis of your scans. Offscan.ini is included in the OMPM Scan folder. For information about all available configuration options in the offscan.ini configuration file, see Office Migration Planning Manager Offscan.ini settings for Office 2010.
The configuration file must be named Offscan.ini to be recognized, and it must be in the same directory as the file scanner tool, Offscan.exe.
Run the OMPM File Scanner from an administrative client computer
To run the OMPM file scanner from an administrative client computer, put all of the OMPM required files on the administrative client computer and configure the Offscan.ini file to scan computers over the network. The Offscan.ini is in the same folder as Offscan.exe, which you run at a command line as described in the next section. Use the FoldersToScan and FoldersToExclude settings in Offscan.ini to control which network locations are scanned. For more information about how to set up the OMPM File Scanner, see Set up the Office Migration Planning Manager File Scanner for Office 2010.
The OMPM tool has been updated as of July 2011, The release is available at the Microsoft Download Center (http://go.microsoft.com/fwlink/p/?LinkId=199599). Numerous fixes and enhancements are available for the OMPM File Scanner, the Office File Converter (OFC) tool, and the Version Extraction Tool (VET). If you are using a previous 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.
To run OMPM File Scanner from an administrative client computer
Verify that the administrative client computer meets all OMPM requirements. For more information, see Administrative computer requirements..
Edit the settings in the Offscan.ini file that apply to the way that you want the scan to be performed.
From a command line, move to the directory where the OMPM File Scanner files is located, and then type: offscan.exe
To run the command in quiet mode, you can use the -q parameter; for example, offscan.exe -q
Run the OMPM File Scanner from a central share
To run the OMPM file scanner from a central share, put all required files on the share, and then configure the Offscan.ini file to scan computers over the network. When you run the file scanner from a central share, you must do so from a mapped drive location. The recommended syntax to invoke the scanner in this configuration is as follows:
Run the OMPM File Scanner on each client computer by using System Center Configuration Manager or a similar tool
You can use Microsoft System Center Configuration Manager 2007, a third-party software distribution program, or a script to distribute the OMPM File Scanner and run it locally on each computer in the environment.
System Center Configuration Manager 2007 encrypts the data that it transmits. If you use another software distribution package, refer to the product documentation for information about whether it encrypts the data. If you are not using System Center Configuration Manager 2007, be aware that scanning files over a network could lead to potential security issues, much like reading or editing any document over a network can create security issues.
For a sample script that runs the OMPM file scanner from a central share, see Sample script to run the Office Migration Planning Manager File Scanner from a file share for Office 2010.You can use System Center Configuration Manager 2007, another software distribution package, or a script to distribute the sample script.
You can also run the OMPM File Scanner from a central share by using a logon script. We highly recommend that you store the log files in a central destination that is geographically close to the computers that are running scans and one that is located on the same subnet. For example, if you are scanning files in New York and Beijing, you should have a server near New York and one near Beijing to collect the scan XML and CAB files. You can configure the store location by using the DestinationPath property in Offscan.ini and distributing different versions of Offscan.ini to the scan jobs at each site.
To run OMPM file scanner
Verify that each client computer contains the OMPM requirements. For more information, see Client computer requirements.
Edit the offscan.ini configuration file settings that apply to your scan requirements.
Save the OMPM scan components to a share folder for which client computers have permissions.
At a command prompt, type: pushd \\<server>\<share folder>
To run the command in quiet mode, use the –q parameter; for example: offscan.exe -q
At a command prompt, type: offscan.exe.
The scan log files are saved to the location that is specified in the DestinationPath setting in offscan.ini. This can be either a network share or local folder.
Run the OMPM File Scanner on each client computer
For computers that are not always connected to the network, such as portable computers and computers that are in branch offices, running OMPM locally is a good option. You can distribute all appropriate files via CD, user-initiated download, or logon script.
If you want to distribute the OMPM File Scanner by using a logon script, you can use IExpress 2.0 to create a distribution package. For more information, see Use IExpress 2.0 to create a distribution package for Office Migration Planning Manager File Scanner in Office 2010.
Important considerations for running the OMPM file scanner
Consider the following general points before you run the OMPM file scanner:
Files from Microsoft Outlook, Microsoft FrontPage, Microsoft OneNote, and Microsoft InfoPath are not included in either the light or the deep scan.
The OMPM File Scanner does not perform deep scans against documents that are password-protected or Information Rights Management (IRM)-protected. However, light scans are supported for these kinds of files.
The SkipOldAccessed and SkipOldModified settings are used only when deep scanning is enabled. These settings are ignored during light scans.
The network paths that you specify for scanning must be valid. Be sure to verify them. If a network path is invalid, a non-specific error message is logged: Unknown Error: 0x80070035.
Access databases that contain autoexec macros are not scanned.
Although OMPM reports on files that have embedded hyperlinks to Office files, the OFC does not resolve or update hyperlinks. Because converting files to OpenXML changes their file name extensions, any hyperlinks that point to converted files will be broken.
On computers that are running Windows 7, the OMPM File Scanner does not detect CTRL_CLOSE, CTRL_LOGOFF and CTRL_SHUTDOWN events. This means that, if the command windows is closed while the scan is running, or if you log off or shut down the computer, the scan is marked as complete and is not restarted.
The Offscan.exe time elapsed counter is off by a large percentage after moderate to large scans. The elapsed time that is shown is longer than the actual elapsed time of the scan.
You can use the /d parameter to prevent OMPM from changing the Last Accessed Date on files that the scanner has Write permission to. If you do not use this parameter, or if the scanner does not have Write access to scanned files, you might experience unexpected results when you use the SkipOldAccessedFiles and OldAccessDate settings in the offscan.ini file. Specifically, those settings are obeyed for the first scan and old files are skipped, but because Last Access Date property settings are updated for skipped files, the previously skipped files will be scanned during subsequent scans.
For local scans only (where offscan.exe and offscan.ini are accessed from the same computer), the following properties in offscan.ini support environment variables: [FoldersToScan], [FoldersToExclude], and [DestinationPath]. For example, you can specify %temp%, which resolves as the location in which to store temporary files. If the environment variable cannot be resolved because of a misspelling or another reason (for example, if you specified %temps% instead of %temp%), the OMPM File Scanner treats the entry as a folder name and not as an environment variable.
The OMPM File Scanner does not scan embedded objects within documents. However, it does report that the document contains embedded objects.
If you plan to use the Office File Converter (OFC) tool to convert files, the Microsoft Office Compatibility Pack must be located on the computer on which you run ofc.exe. Neither Office nor the Office Compatibility Pack is required to run a file scan. However, if you plan to perform a detailed file scan of Microsoft Access versions 97 through 2003, you must have Access 2007 or Access 2010 installed to be able to complete the scan of the Access files.
For more information about using the OFC and VET, see Convert binary Office files by using the Office File Converter (OFC) and Version Extraction Tool (VET).
ConceptsOffice Migration Planning Manager overview for Office 2010
Set up 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
Office Migration Planning Manager reference for Office 2010
Convert binary Office files by using the Office File Converter (OFC) and Version Extraction Tool (VET)