XML Schema Reference

AppProfileSafe validates all XML configuration and data files against XSD schemas. Schema files are stored in the Schema\ subdirectory of the installation folder (next to AppProfileSafe.exe). This location is hardcoded and cannot be changed via settings.xml. Each schema uses a versioned target namespace.


Available Schemas

File Root Element Target Namespace Validates
AppProfileSafe.Settings-v1.0.0.xsd Settings urn:appprofilesafe:settings:v1 settings.xml — Application configuration
AppProfileSafe.UserSettings-v1.0.0.xsd UserSettings urn:appprofilesafe:usersettings:v1 User settings override files provided via --userSettingsFile (CLI only). See Configuration: settings.xml.
AppProfileSafe.Manifest-v1.0.0.xsd Manifest urn:appprofilesafe:manifest:v1 Manifest XML — Export/import metadata and entry list
AppProfileSafe.Mappings-v1.0.0.xsd Mappings urn:appprofilesafe:mappings:v1 Mapping files — Path translation rules for imports
AppProfileSafe.BlackList-v1.0.0.xsd BlackList urn:appprofilesafe:blacklist:v1 BlackList files provided via --blackListFile (CLI only). Defines items to skip during import. See Import via CLI.
AppProfileSafe.App-v1.0.0.xsd AppDefinition urn:appprofilesafe:app:v1 Application definitions — Per-app configuration of files, registry, and folders
AppProfileSafe.Siem-v1.0.0.xsd SiemConfiguration urn:appprofilesafe:siem:v1 siem.xml — SIEM connection and format settings
AppProfileSafe.Webhook-v1.0.0.xsd WebhookConfiguration urn:appprofilesafe:webhook:v1 webhook.xml — Webhook endpoints and authentication
AppProfileSafe.Redaction-v1.0.0.xsd RedactionConfig urn:appprofilesafe:redaction:v1 redaction.xml — Field redaction rules for event payloads
AppProfileSafe.EventPipeline-v1.0.0.xsd EventPipeline urn:appprofilesafe:eventpipeline:v1 eventpipeline.xml — Pipeline configuration
AppProfileSafe.Registry-v1.0.0.xsd RegistryExport urn:appprofilesafe:registry:v1 Per-app registry export XML files stored in the manifest data folder


When Validation Occurs

Schema validation is performed at these points:

  • Application startupsettings.xml is validated against the Settings schema.
  • CLI with --userSettingsFile — The user settings file is validated against the UserSettings schema before path overrides are applied. If validation fails, the CLI exits with code 1.
  • Export — App definitions are validated against the App schema. With --strictAppSchemaValidation (CLI), validation failures abort the export.
  • Import — The manifest XML is validated against the Manifest schema. Registry export files are validated against the Registry schema. Mapping files are validated against the Mappings schema. If --blackListFile is provided, it is validated against the BlackList schema; validation failure aborts the import with exit code 2.
  • Event pipeline startupsiem.xml, webhook.xml, redaction.xml, and eventpipeline.xml are validated against their respective schemas.
  • Preflight — Configuration schemas are validated as part of the preflight check sequence.

Validation errors produce error code APS-1101 with details about the specific element and line that failed validation.


Schema Location

All schema files are shipped with the application and stored in the Schema\ folder inside the installation directory. This path is hardcoded — it is not configurable via settings.xml or the --userSettingsFile parameter. Missing schema files cause validation to be skipped with a warning in the application log.