Experience Data Model (XDM) Schema
The Experience Data Model (XDM) is the language of digital experiences. XDM is a publicly documented specification, driven by Adobe to improve the interoperability, expressiveness, and power of digital experiences. This repository contains the source code for the formal specification of the XDM model, using the JSON Schema language.
XDM is at version
You can find more about our versioning in docs/introduction.md
Read the XDM Spec
- Chapter 1: Introduction
- Chapter 2: Related Standards
- Chapter 3: Terminology
- Chapter 4: Extending XDM
- Appendix A: Reference – this contains all the schemas defined by XDM
The project is laid out in the following way:
docs: Markdown files that contain front-matter, introduction, and non-normative parts of XDM
schemas: JSON schema files that define out of the box cross user schemas
components: JSON schema files that define the AEP components used in the composition model to create schemas usable within UPS
extensions: JSON schema files that define vendor or solution specific components used within the composition model of AEP
package.json: a build file for
npmthat allows the generation of Markdown from the JSON Schema source files and (later) the generation of an AEM package to be deployed on the Adobe I/O Website
README.md: this file
CONTRIBUTING.md: guidelines for contributors, covering process, conventions and design guidelines
*.schema.jsonis the schema file, e.g.
profile.schema.json– we pick the
.jsonfile extension for easy syntax highlighting in editors
*.example.*.jsonis an example file that will be validated against the
*.schema.jsonfile, and if successful, merged into the
*.schema.jsonfile as an
"example"field at the root of the schema before it is converted into Markdown or published
*.invalid.*.jsonis an invalid example file that will be validated against the
*.schema.jsonfile. If the
invalidfile validates (false positive), the schema is too lax and the overall build will fail.
invalidfiles will not be merged into documentation.
The tooling project (e.g. for generating Markdown documentation, example validation, JSON Schema documentation inlining) is located in the adobe/jsonschema2md git repository.
- Node.js and
Validation of local changes prior to creating any Pull Requests to adobe/xdm
This project contains a minimal validation script that depends on NPM. You can use it to validate the JSON example files against the JSON Schema files after making changes to either.
From the root directory of the local repository run:
$ npm install $ npm test > email@example.com test /Users/fmeschbe/src/platform/xdm > mocha ... $ npm run lint ...
If you see warnings or error messages (or an non-zero exit code), fix them before making a pull request.
- see the Contributor's guide
AEM Package Generation (optional)
With all dependencies installed, run the following commands from the root directory of the local repository:
$ npm install $ npm run package
This will fetch all dependencies, then generate Markdown in the
docs/reference directory and then generate an AEM package under
xdm-docs.zip. The package can be uploaded using the command
$ npm run upload
upload will upload to the Adobe I/O Staging instance. To upload to production, use
The AEM password is not saved in this repository (of course), but you can set it using this command:
$ npm config set xdm-models:aem_password $AEM_PASSWORD
This is assuming
$AEM_PASSWORD has been provided to your Continuous Integration system or set on the command line beforehand.
upload will only make the documentation visible on the "author" instance, this means visitors to the site cannot see any of the documentation. To publish it, run the
npm run activate or
npm run activate:prod commands.
A full process would then look like this:
$ npm config set xdm-models:aem_password $AEM_PASSWORD $ npm install $ npm test $ npm run package $ npm run upload $ npm run activate
This will generate documentation, create an AEM package, install it on (stage) author, and activate it from there, so that visitors can read the documentation.
A Note on Dependencies
package.json script will fetch a released version of the AEM Markdown Importer JAR using curl.
Copyright 2017 Adobe Systems Incorporated. All rights reserved. This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license.
You are free to:
- Share — copy and redistribute the material in any medium or format.
- Adapt — remix, transform, and build upon the material for any purpose, even commercially.
This license is acceptable for Free Cultural Works.
The licensor cannot revoke these freedoms as long as you follow the license terms.
Under the following terms:
- Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
- No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.