AppProfileSafe - Support Portal

Run Reports

AppProfileSafe generates a JSON run report after every export or import operation. These reports provide a complete record of what happened during the run, including timing, per-item results, errors, warnings, and preflight outcomes.


File Location and Naming

Reports are saved in the Report folder inside the AppProfileSafe installation directory. The file name follows this pattern:

report_{mode}_{machinename}_{timestamp}.json

Examples:

  • report_export_WORKSTATION1_20260213_143022.json
  • report_import_WORKSTATION2_20260213_151500.json

The Report folder is created automatically if it does not exist.


Report Structure

The JSON report is formatted with indented output and camelCase property names. It contains the following sections:

Metadata
Field Description
startedUtc UTC timestamp when the operation started
finishedUtc UTC timestamp when the operation completed
mode Export, Import, or Preflight
applications Array of application names that were processed
manifestPath Full path to the manifest file
mappingFilePath Full path to the mapping file (import only, null if not used)
Host Information
Field Description
machineName Name of the computer where the operation ran
userName Windows user who ran the operation
osVersion Operating system version string
appVersion AppProfileSafe version number
interface GUI or CLI
Timing and Counts
Field Description
durationMs Total duration of the operation in milliseconds
fileCount Number of file/folder operations
registryCount Number of registry operations
successCount Number of successful operations
errorCount Number of failed operations
skippedCount Number of skipped operations
Result
Field Description
exitCode Exit code (0=Success, 1=User Error, 2=System Error, 3=License, 4=SIEM, 5=Audit)
success Overall success: true or false
errors Array of error messages (may be empty)
warnings Array of warning messages (may be empty)
Steps (Detailed)

The steps array contains one entry for every individual operation performed during the run:

Field Description
application Application name
type Operation type (e.g. Registry, File, Folder)
source Source path
destination Destination path
result Result string (e.g. "Success", "Error", "skipped (not found)")

This array can be large for operations involving many files and registry entries.

Preflight (Embedded)

If a preflight validation was run as part of this operation, the full preflightResult object is embedded in the report, including individual check results, pass/warning/error counts, and total duration.


Example (Abbreviated)

{
  "startedUtc": "2026-02-13T14:30:22Z",
  "finishedUtc": "2026-02-13T14:30:45Z",
  "mode": "Export",
  "applications": ["Firefox", "Chrome"],
  "manifestPath": "C:\\Backup\\APS_Export_20260213143022.xml",
  "machineName": "WORKSTATION1",
  "userName": "Admin",
  "osVersion": "Microsoft Windows NT 10.0.19045.0",
  "appVersion": "1.0.0.0",
  "interface": "GUI",
  "durationMs": 23400,
  "fileCount": 142,
  "registryCount": 87,
  "successCount": 225,
  "errorCount": 4,
  "skippedCount": 0,
  "exitCode": 0,
  "success": true,
  "errors": [],
  "warnings": ["File export for 'Firefox': 4 item(s) skipped due to errors."],
  "steps": [
    {
      "application": "Firefox",
      "type": "Registry",
      "source": "HKCU\\Software\\Mozilla\\Firefox",
      "destination": "Firefox\\Registry\\Firefox.xml",
      "result": "Success"
    }
  ]
}


One-Line Summary

Each report can produce a human-readable one-line summary for quick overview:

[SUCCESS] Export — 2 app(s), 225 ok, 4 errors, 0 skipped (23400ms, exit 0)

This summary is logged and can be useful for monitoring and alerting in automated environments.


Using Run Reports

  • Troubleshooting: Review the steps array to find which specific items failed and why
  • Automation: Parse the JSON in scripts to check exitCode, success, and errorCount
  • Compliance: Archive reports as evidence of backup and restore operations
  • Diagnostics: Include run reports in diagnostics bundles for support


See Also