Integration mapping files

Integration mapping files contain one or more integration mappers. Each mapper describes how to transform a specific root object type into a specific JSON schema definition.

You can group an arbitrary number of integration mappers together into a single integration mapping. By grouping the mappers, you can allow them to easily reference each other and to be versioned and extended as a unit rather than just individually.

File names

Write integration mapping files in JSON. Place these files in a subdirectory of the config/integration/mappings directory. Any subdirectories of /mappings become parts of the fully-qualified name of the mapping file. This behavior is similar to the Java package structure.

Name the files themselves with the format, <name>-<version>.mapping.json:

The <name> portion cannot contain the hyphen character or any other character that would render the file name invalid on some file systems.
The <version> portion consists of one or more sequences of digits. Separate these sequences of digits with the period character. Optionally follow each sequence of digits with a hyphen and an arbitrary string.

Examples:

config/integration/mappings/gw/pl/admin/user-1.0.mapping.json defines the mapping named gw.pl.admin.user-1.0.
config/integration/mappings/gw/pc/productmodel/productmodel-10.0.1-alpha.mapping.json defines the mapping named gw.pc.productmodel.productmodel-10.0.1-alpha.