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 0.9.8.
You can find more about our versioning in docs/introduction.md
- 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 XDMschemas: JSON schema files constituting the normative part of XDM*.schema.jsonis the schema file, e.g.event-envelope.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 theinvalidfile validates (false positive), the schema is too lax and the overall build will fail.invalidfiles will not be merged into documentation.*.description.mdis a description file that will be merged into the"description"field at the root of the schema, allowing the authoring of longer descriptions. The merge happens before publishing the schema file or creating a joint Markdown fileschemas/assets– for schemas related to the asset core concept, including image, video, documentschemas/audiences– for schemas describing audiences, segments, and groups of consumersschemas/campaigns– for schemas describing orchestrated experience campaignschemas/content– for schemas related to content, including visual, audible, and virtual reality contentschemas/context– for schemas related to the context of a digital experience, including profile, person, environmentschemas/data– for schemas describing collected data, metric, etc.schemas/external/*– for JSON Schema representation of externally defined standardsschemas/channels– for schemas describing experience channels and locations thereinschemas/common– for basic concepts like extensibility that are not covered inexternalschemas
*.ttl: legacy schema files in Turtle Syntax that have not yet been converted into JSON Schemapackage.json: a build file fornpmthat 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 WebsiteREADME.md: this fileCONTRIBUTING.md: guidelines for contributors, covering process, conventions and design guidelines
The tooling project (e.g. for generating Markdown documentation, example validation, JSON Schema documentation inlining) is located in the adobe/jsonschema2md git repository.
You need:
- Node.js and
npm curl
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 protected] 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
With all dependencies installed, run the following commands from the root directory of the local repository:
$ npm install
$ npm run packageThis 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 uploadupload will upload to the Adobe I/O Staging instance. To upload to production, use upload:prod instead.
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_PASSWORDThis is assuming $AEM_PASSWORD has been provided to your Continuous Integration system or set on the command line beforehand.
Running 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 activateThis will generate documentation, create an AEM package, install it on (stage) author, and activate it from there, so that visitors can read the documentation.
The 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.
- 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.
- 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.