Install and configure OMPM File Scanner
Updated: March 5, 2009
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
You have two options for distributing and running the OMPM File Scanner:
Place all of the necessary OMPM File Scanner files on a central share and run the OMPM File Scanner from that share, scanning local computer hard drives or servers. This method lets you change the OMPM File Scanner configuration files in the central location without having to redistribute them to every computer on the network.
Create a distribution package that contains all the necessary OMPM File Scanner files and distribute the package to every computer to be scanned.
Before running the OMPM File Scanner, you must first edit the offscan.ini file by using the appropriate parameters. For a list of file types that are scanned by the OMPM File Scanner, see Introduction to Office Migration Planning Manager (OMPM).
The command to run the OMPM File Scanner is as follows:
offscan.exe
The parameters for this command are as follows:
| Parameter | Description |
|---|---|
/q |
Run the OMPM File Scanner in quiet mode. Optional. |
/d |
Run the OMPM File Scanner while preserving the Last Accessed Date for scanned files. This applies to the latest hotfix version. See Microsoft Knowledge Base article 956137: Description of the Office Migration Planning Manager (OMPM) hotfix package (Offscan.exe): October 28, 2008 (https://go.microsoft.com/fwlink/?LinkID=143353). This works only for files in which the account that is running the scan has read/write access and will take longer than the /q scan. |
Offscan.ini settings
The following table shows the settings and values in offscan.ini.
| Setting | Description | Possible values | If value is missing | If value is not valid |
|---|---|---|---|---|
RunID= |
Tracking number for the current scan. Use this to group scans from different computers in the Reports. Required. |
Alphanumeric. |
End scan. |
End scan. |
Description= |
Text used to describe the current scan. Optional. |
Free-form text, truncated to 255 characters. |
Ignore |
|
DestinationPath= |
Path where log files are placed. Supports environment variables (see Note below). Required. |
Physical or mapped drive or UNC For example, c:\scan\logs Environment variables are also supported. |
End scan and display usage information to console |
|
ScanMyDocuments |
Ensures the user's My Documents folder is scanned whether My Documents is within the path specified in SourcePath or redirected to another hard disk drive or network share. Optional. |
1 - Scan My Documents wherever the folder is 0 - do not scan My Documents if the path is not under that indicated by SourcePath. |
No special handling for My Documents folder. |
Ignore. |
ScanDesktop |
Ensures the user's Desktop folder is scanned, whether Desktop is within the path specified in SourcePath or redirected to another hard disk drive or network share. Optional. |
1 - Scan Desktop wherever the folder is 0 - do not scan Desktop if the path is not under that indicated by SourcePath. |
No special handling for Desktop folder. |
Ignore. |
DeepScan= |
Specify whether this is a deep scan. Optional. |
0 - perform a light scan 1 - perform a deep scan |
Performs a light scan. |
Performs a light scan. |
CABLogs= |
Disable creation of CAB files. Optional. |
0 – do not allow creation of CAB files 1 – allow creation of CAB files. |
Will not create CAB files. |
Will not create CAB files. |
Verbose= |
Specify whether to print output to the screen. Optional. |
0 - do not print output to the screen 1- print output to the screen |
Does not print output to the screen. |
Does not print output to the screen. |
Recovery= |
Restart a failed scan when you run the OMPM File Scanner again. Optional. |
0 - do not restart failed scans 1 - restart failed scans |
Does not attempt to restart failed scans. |
Does not attempt to restart failed scans. |
LogOutput= |
Specify whether to write output to a file. Optional. |
0 - do not write output to a file 1 - write output to a file |
Does not write output to a file. |
Does not write output to a file. |
[FoldersToScan] |
Section lists folder trees to scan. Sub-folders will also be scanned. If ScanAllLocalDrives is specified, folders on local drives will be ignored (all folders on all local drives will be scanned unless excluded by [FoldersToExclude]). Supports environment variables (see Note below). Optional. |
Section Head. |
If missing and ScanAllLocalDrives<>1, only tblScans and tblComputers information will be written and the scan will end. |
|
[FoldersToExclude] |
Section lists folders to exclude from the scan. Sub-folders will also be excluded. If [FoldersToExclude] contains folders that don't exist on the computer, the scan will stop. Supports environment variables (see Note below). Optional. |
Section Head. |
No folder will be excluded from the scan. |
If FoldersToScan and FoldersToExclude include the same folders an error will be written to tblErrors and the scan will end. Error is: "The same folder is listed in FoldersToScan and FoldersToExclude in OFFSCAN.INI. Aborting scan." |
Folder= |
Lists a folder to be included in the scan. All files within this folder and sub-folders will be scanned. Optional. |
Valid folder path. |
OMPM File Scanner scans all local physical drives. |
OMPM File Scanner scans all local physical drives. |
[Application] |
Sections containing specific settings for each Office application. Optional. |
[Access] [Excel] [PowerPoint] [Project] [Publisher] [Visio] [Word] |
If section is missing, the application document files will not be scanned. |
If [Application] is not a known value, the section is ignored. |
RetryCount |
Number of retries per file before moving to the next file. Optional. |
Integer. |
||
RetryInterval |
Number of milliseconds to wait between retries. Optional. |
Integer. |
||
RetryTimeout |
The number of sequential files to retry before stopping the scan. Optional. |
Integer. 0 - infinite number of files. |
||
Ext= |
List of extensions to be scanned for the application. Required, if [Application] is present. For a list of file types that are scanned by the OMPM File Scanner, see Introduction to Office Migration Planning Manager (OMPM). |
For example, "doc" or "dot" (a comma-separated list without the preceding "." character). You can add additional extension types if you use other extensions for particular document types, such as .LET for Word letter documents. |
Store error nn0001 to tblErrors (where nn = Module Number) If there are no values in Ext= in any [Application] section, the OMPM File Scanner will write tblScans and tblComputers to log file and end). |
If extension is not valid, write error 010014 to tblErrors. |
ScanDAO= |
Specify whether to collect data access object (DAO) properties from the Access databases that are scanned. Optional. |
0 - do not collect DAO properties 1 - collect DAO properties |
Collect DAO properties. |
Collect DAO properties. |
AccessScan= |
Specify whether to collect Access properties from the Access databases that are scanned. To collect Access properties, the OMPM File Scanner must be running on a computer that has Access 95 or later installed on it. Optional. |
0 - do not collect Access properties 1 - collect Access properties |
Do not collect Access properties. |
Do not collect Access properties. |
DisableConvDialog= |
Specify whether to prevent the conversion dialog box from appearing the next time a user opens a version of an Access database that is earlier than Access 2002 or Access 2003 in either Access 2002 or Access 2003. If you set DisableConfDialog=1, the LastModified date of the Access database changes. Optional. |
0 - do not prevent the conversion dialog box from appearing 1 - prevent the conversion dialog box from appearing |
Do not prevent the conversion dialog box from appearing. |
Do not prevent the conversion dialog box from appearing. |
MaxCopyFileSize= |
Specify the maximum file size in megabytes (MB) that the OMPM File Scanner copies for the collection of Access properties. When collecting Access properties, the OMPM File Scanner makes a copy of the database, which it opens and scans. This preserves the LastModified date for the database. You can use this setting to limit the file size that is copied. Optional. |
Integer. 0 - infinite file size |
Defaults to 50 MB. |
Defaults to 50 MB. |
TempPath= |
Specify the folder path where the OMPM File Scanner copies Access databases before scanning them. Optional. |
Drive letter or UNC path. |
Use the folder path that is specified for the TEMP variable in the Microsoft Windows operating system that is running on your computer. |
Use the folder path that is specified for the TEMP variable in the Microsoft Windows operating system that is running on your computer. |
Note
The following properties support environment variables: [FoldersToScan], [FoldersToExclude], and [DestinationPath]. For example, you can specify %temp%, which resolves as the location to store temporary files. If the environment variable cannot be resolved due to a misspelling or other reason (for example, if you specified %temps% instead of %temp%), the OMPM File Scanner treats the entry like a folder name and not an environment variable.
Download this book
This article is included in the following downloadable book for easier reading and printing:
See the full list of available books at Office Resource Kit information.