JSON Data Mapping

Configures which Data Elements are included when exporting JSON Metadata for a Content Type.

Remarks

The JSON Data Mapping behavior customizes the structure and content of exported JSON metadata by allowing you to select specific Data Elements—such as fields, tables, and sections—from one or more Data Models. This mapping is primarily used by the JSON Metadata export format, enabling precise control over which data is included for integration, reporting, or downstream processing.

Role and Usage

When a Content Type is configured with a JSON Data Mapping, the JSON Metadata export format uses this mapping to determine which Data Elements are included in the exported JSON. This allows you to:

• Limit the exported data to only the fields, tables, or sections required by your target system.
• Combine or nest data from multiple Data Models for advanced integration scenarios.
• Ensure the exported JSON structure matches the needs of external APIs, validation tools, or documentation.

If no mapping is present, all data from the Data Model is exported by default. If a mapping is present, only the selected Data Elements (and their descendants) are included in the output. The mapping can include elements from multiple Data Models, supporting scenarios where data from related or inherited models must be combined.

Multiple Data Models and Merge Modes

When elements from more than one Data Model are included, the 'Merge Mode' property controls how the resulting JSON objects are combined: Choose the merge mode that best matches the requirements of your integration or target system.

Configuration Workflow

1. Add a JSON Data Mapping behavior to a Content Type.
2. Select the Data Elements to include in the mapping.
3. Configure the merge mode if exporting from multiple Data Models.
4. Use the JSON Metadata export format to generate the tailored JSON output.

Integration with Schema Generation

When used with the Data Field Container - Generate Schema command, the JSON Data Mapping determines which Data Elements are included in the generated JSON schema. This ensures that the schema matches the structure of exported JSON Metadata, supporting seamless integration and validation.

Properties

{
  "InvoiceNumber": "12345",
  "TotalAmount": 100.00,
  "VendorName": "Acme Corp",
  "VendorAddress": "123 Main St"
}

{
  "Invoice": {
    "InvoiceNumber": "12345",
    "TotalAmount": 100.00
  },
  "Vendor": {
    "VendorName": "Acme Corp",
    "VendorAddress": "123 Main St"
  }
}

{
  "InvoiceNumber": "12345",
  "TotalAmount": 100.00,
  "Vendor": {
    "VendorName": "Acme Corp",
    "VendorAddress": "123 Main St"
  }
}

See Also

Data ColumnData FieldData ModelData SectionData TableContent CategoryContent ModelDocument TypeForm TypePage Type