Appearance
Managing CMS Data Models
A Data Model is a data structure used for editing, storing and serving content. Data Models belong to Collections and a Record utilizes a Data Model to structure its content.
A Data Model is within the Atlas Experience Manager is based on relational database concepts and is analogous to a table within a relational database. A Data Model is comprised of Fields, which define the data structure for that Model (table).
Features
Entity Type
Within the CMS, there are three Entity Types for Data Models:
- Record: A Record is the most common data structure and emulates a relational database table with fields and relationships to other records. A Record Data Model in-effect creates a database table for that content.
- Page: A Page is similar to a Record, but Page Records may be structured into website page tree. Page records will have an associated record in the Collection Tree containing additional metadata such as title, SEO image, etc.
- Block: Blocks are data structures only and cannot be used to make Records. Blocks are used with the Block field type allowing for variable content types to be added to Record (comment in building Pages).
WARNING
The Collection Tree functionality for the Page model is still under development. Page Data Models are fully functional, but the tree organization and data models are not available.
List View Configuration
The Data Models list view in the CMS may be configured using the Record List Display and/or Record Title Fields.
The Record Title Display field indicates which field on the model should be used for the record title.
The Record List Display field allows you to add additional fields from the record into the Data Models list view making it easier for Editors to locate records or see pertinent information.
TIP
The Title and List display need to be added after the model has been created and you have added fields to the model.
Workflow
Data Models support two publishing workflows: Autopublish and Draft -> Publish.
By default, a model is set to Autopublish, providing only a save button on the Record. This is useful for simple metadata or pages where the the content is fixed and changes infrequently.
The Draft -> Publish Workflow enables draft editing. When creating/editing a record, a Draft version of the record is created. The Editor may edit this record until they are ready to publish the record. This is useful for drafing content in the CMS that may not be ready to go live yet.
Each Workflow will automatically version so that you may recover previous versions/changes.
Version Retention
Data Models are versioned and subject to a version retention policy. The retention policy determines how many pervious versions of the model to retain. By default, five versions will be retained.
- None (delete all previous versions)
- Last 5 (Default)
- Last 10
- Last 20
- For One Week
- For Two Weeks
- For One Month
- For Three Months
- Forever
Locked
The Locked toggle allows the data model to be locked so that it cannot be edited. This is useful for projects that are in production where data model changes may impact application functionality.
Archived
The Archived toggle allows for a data model to be marked as Archived so that it does not appear as a record that can be added, and the results will be removed from the API responses. This is useful in circumstances where a model is no longer needed or in-use, but you want to retain the content.
Data Model Fields
Managing Data Models
Building Models is a multi-step process which involves creating the Data Model, adding Fields and updating display settings.
TIP
After creating your
- Locate the + Add Collection button in the header and select it
- Complete the Collection details
- Name: Provide a Name for your collection
- Description: Provide a description for your collection
- Internationalization: Determine if you need to modify the default, or available languages for this collection.
- Permissions: Set the Administrator Role and Editors roles for this Collection
- Public: Select Enable Public Content API's if you need this Collection to be public
- Select Create or Save Collection
Edit a Collection
To Edit a Collection, locate the ... elipsis/three-dot menu next to the Collection you update and selecte Edit.
