Run Reports

A run report is a JSON file generated automatically at the end of every export or import operation. It captures the full context of the operation — which applications were processed, how long it took, what succeeded or failed, and step-by-step details for every file and registry operation. Run reports are useful for post-operation review, automation validation, and troubleshooting.


When Reports Are Generated

Run reports are created automatically — no configuration or user action is needed. In the GUI, the report is saved after the progress window closes. In the CLI, it is saved before the process exits. Reports are written to the report folder configured via <ReportFolder> in settings.xml.

The file name follows the pattern report_{mode}_{HOSTNAME}_{yyyyMMdd_HHmmss}.json, for example: report_export_WORKSTATION01_20260214_093000.json.


Report Structure

The JSON report contains the following top-level sections:

Section Fields Description
Metadata startedUtc, finishedUtc, mode, applications, manifestPath, mappingFilePath What was run, when, and with which input files
Host info machineName, userName, osVersion, appVersion, interface Machine, user, OS, app version, and whether the operation ran via GUI or CLI
Timing durationMs Total operation duration in milliseconds
Counts fileCount, registryCount, successCount, errorCount, skippedCount Aggregate counts of all file and registry operations by result
Result exitCode, success, errors, warnings Overall outcome, process exit code, and lists of error/warning messages
Steps Array of step objects (application, type, source, destination, result) Every individual file copy, registry write, or folder operation with its result
Preflight preflightResult (embedded PreflightReport) Full preflight validation results if preflight ran as part of the operation


Step Details

Each step in the steps array represents a single operation:

Field Description Examples
application Name of the application definition "Firefox", "Outlook"
type Operation type "File", "Folder", "Registry", "Key", "Value"
source Source path "C:\Users\jdoe\AppData\..."
destination Target path "\\server\share\manifest_data\..."
result Step outcome "Success", "Created", "Changed", "Unchanged", "Error", "Skipped"

Step results are classified automatically: Success, Created, Changed, and Unchanged count toward successCount; Error and Fail toward errorCount; and Skipped toward skippedCount. Types containing "registry", "key", or "value" increment registryCount; types containing "file" or "folder" increment fileCount.


Summary Line

Each run report also generates a human-readable one-line summary that is written to the application log. The format is:

[SUCCESS] Export — 3 app(s), 142 ok, 0 errors, 2 skipped (1250ms, exit 0)

This provides a quick at-a-glance result without opening the full JSON file.


Using Run Reports

Run reports are designed for several use cases:

  • Post-operation review — Open the JSON file to see exactly which files and registry keys were processed and whether each step succeeded.
  • Automation validation — Parse the JSON in scripts to verify that CLI operations completed successfully (check success and exitCode fields).
  • Troubleshooting — Filter the steps array for entries with result containing "Error" to identify which specific operations failed.
  • Support — Run reports are included in the diagnostics bundle (the 5 most recent reports).