Skip to main content

1. Configuring entities

Based on how editorial teams shape the content to deliver to meet business goals, developers define entities in the Content Manager.

Developers can:

1.1 Extend the out-of-the-box entities

For example, you may want to add the Author field to the built-in story entity.

To add the Author field, in the Content Manager:

  1. Go to the Administration panel
  2. In the Extended fields section, edit the Story's extended fields
  3. In the JSON Schema field, write the following JSON:
    {
    "properties": {
    "author": {
    "type": "string",
    "title": "Author",
    "description": "The author of the story",
    "filter": true,
    "bulk": true
    }
    },
    "type": "object"
    }
  4. Select Update extended fields. Then, save the new configuration.
  5. Go to the edit details of a story and verify that editors now have the Author field available.

If extending the out-of-the-box entities isn't enough for the editorial teams goals, you need to define custom entities.

1.2 Define custom entities

For example, editors may want to deliver information about sports seasons, relate stories and photos to a season. So, they need a Season custom entity to manage this concept.

To add the Season custom entity, in the Content Manager:

  1. Go to the Administration panel
  2. In the Custom entities section, add the Season custom entity by entering mandatory fields and the following JSON
    {
    "type": "object",
    "properties": {
    "source_1_Id": {
    "description": "Season ID from Source 1",
    "localized": false,
    "title": "Source 1 Season ID",
    "type": "string",
    "tagextradata": true,
    "filter": true
    },
    "source_2_Id": {
    "description": "Season ID from Source 2",
    "localized": false,
    "title": "Source 2 Season ID",
    "type": "string",
    "tagextradata": true,
    "filter": true
    },
    "year": {
    "description": "Year",
    "localized": false,
    "title": "Year",
    "type": "integer",
    "tagextradata": true
    }
    },
    "indexes": {
    "yearIndex": {
    "year": 1
    }
    }
    }
  3. Select Add a new custom entity. Then, save the new configuration.
  4. If you set the custom entity as Visibile on the menu and set an icon, in the Content Manager left menu the new item displays, which is the entry point for editors to create and manage seasons.

1.3 Iterate

Validate with the editorial teams that the extended fields and custom entities meet their needs.

If needed, refine the extended fields and custom entities by editing the in the Content Manager's Administration panel.