Create entities

Introduction

When navigating to a detail page, the entity properties determine which page renders the entity detail — for example, which page renders stories, albums, or any custom entity.

Entities can align to the Content Manager entities or being independent.

Entities from the Content Manager

Editorial teams need to create entities in the Page Builder based on the Content Manager.

Entities in the Page Builder must have the same structure as in the Content Manager, but including only the attributes that navigation rules use (for example, the title or content date are typically not relevant from a navigation rule perspective).

Automating the entity definition from the navigation rules

Navigation rules have the capability to implicitly define entities. Ask your project team for automating the explicit creation of those entities to make them easy to reuse.

Also, entities exist independently from the Content Manager. Producers can create them in the Page Builder to support the navigation from external sources to specific detail pages.

Navigation rules are the bridge between entities and the destination detail page.

Where can I create entities?

In the left menu, select the Entities item.

Step-by-step

1. In the Entities page, select New Entity Definition.
   

2. The Entity creation tab displays.
   

3. Define:

   1. Entity Name: The display name of the entity that you see when using it to define a navigation rule.

   2. Code: The unique code of the entity.

   3. Icon: The Google Material Design code for the entity icon.

   4. JSON Schema: The entity definition in terms of properties. It must be a valid JSON containing the properties object, which defines the entity properties.

      {
        "properties": {
          "property1": {
            ...
          },
          "property2": {
            ...
          },
          ...
      }

      A property can by a simple object, like slug:

      "slug": {
            "type": "string"
          }

      Also, a property can be an object with its properties, like context:

      "context": {
            "type": "object",
            "properties": {
              "slug": {
                "type": "string"
              },
              "neutralSlug": {
                "type": "string"
              }
            }
          }

      A full example of a properties object definition:

      {
        "properties": {
          "slug": {
            "type": "string"
          },
          "tags": {
            "properties": {
              "slug": {
                "type": "string"
              },
              "neutralSlug": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "context": {
            "type": "object",
            "properties": {
              "slug": {
                "type": "string"
              },
              "neutralSlug": {
                "type": "string"
              }
            }
          },
          "fields": {
            "type": "object",
            "properties": {
              "author": {
                "type": "string"
              },
              "category": {
                "type": "string"
              }
            }
          },
          "type": "object"
        }
      }