How do I use the Print Scout or Tracker Diagnostic Tool called DiagTool.exe?

Goal:

How to use the Print Scout & Tracker Diagnostic Tool.

Environment:

Blueprint Tracker
Blueprint Print Scout
Beacon Print Scout

Information:

Turn Logging On

DiagTool –LoggingOn [-DebugLevel:X]

The tool will enumerate through the PharosSystems registry keys looking for a ‘Log’ key name.
Under this it will enable the TraceLog entry, set the FileName to be a log file named after the parent registry key, which will be stored in the Pharos Logs directory. It will also set other registry logging settings to their default values.
The Profiler will have the ‘Enabled’ log key set to 1.
The optional Debug level command line parameter can be used to override the default value. Valid values of X are from 0 to 10.

Turn Logging Off

DiagTool –LoggingOff

The tool will enumerate through the PharosSystems registry keys looking for a ‘Log’ key name.
Under this it will disable the TraceLog entry and remove the logging FileName value.
The Profiler log key will have ‘Enabled’ set to 0.

Uninstall the Profiler

DiagTool –UninstallProfiler

This command line option will unhook the Profiler from the Print Spooler, effectively removing our software from the printing pipeline on the machine. Print jobs will no longer be captured.
The tool will first save the current state of the Profiler logging settings then turn on the logging for the Profiler component.
It will attempt to locate the ProfUtil.dll file. If this is unavailable it will try the older Profiler.dll file.
The Profiler Uninstall method will be executed using the command line RunDll32 utility to unhook the profiler.
Logging for the profiler will revert to the previous state.

Install the Profiler

DiagTool –InstallProfiler [-Enable]

This command line option will hook the Profiler into the Print Spooler so that jobs will be captured by our sotware.
The tool will first save the current state of the Profiler logging settings then turn on the logging for the Profiler component.
It will attempt to locate the ProfUtil.dll file. If this is unavailable it will try the older Profiler.dll file.
The Profiler Install method will be executed using the command line RunDll32 utility to hook the profiler.
Logging for the profiler will then revert to the previous state.
The optional ‘Enable’ argument will also reenable the profiler as it is installed.

Zip Log files

DiagTool –ZipLogs

This command line option will create a zip archive of all *.log files stored within the Pharos Log directory. A Zip file will be created in the users temp directory with a date stamped filename in the format of
PharosLogs_YYMMDDhhmmss.zip

Machine Information

DiagTool –PCInfo

This command line option will access the PCInfo COM object, if it has been installed, to obtain the complete set of machine info. This will then be written to a PCInformation.xml file located in the Blueprint Logs directory.

Report Tracker Status

DiagTool –Status

This command line option will output the current status of the Print Tracker showing the following information:
Application installation path
Application Data path
Tracker component version number
Profiler Installed registry key
Profiler Enabled registry key
Profiler Faulted registry key
Counts of the number of files in each of the file Stores

Print Server Shortcuts

A Blueprint tracker that was installed with the /PrintServer option is treated as a special case by the Blueprint Tracker. For these machines we will add DiagTool shortcuts to Enable/Disable the Tracker and turn logs On/Off. These shortcuts will not be available under a normal tracker installation.

As some of these commands will be run from a shortcut the user will be informed of the operations success or failure via a pop up message box. This message box can be disabled by adding the command line option below at the end of the command.
/Silent