In this article, we cover the possibility of extending the built-in editorial entities and creating new ones.
Topics covered here:
Overview
When it comes to structuring content creation, defining the building blocks of the content is critical to success: entities meet that need.
As mentioned in Entity types, there are two ways to extend the built-in entities:
- Adding new fields — called extended fields — to built-in entities
- Creating brand new custom entities
As a producer, you need to collaborate with an administrator for both tasks mentioned above.
Extended fields
In FORGE → Administration → Configurations → Extended Fields, edit the existing extended fields and create new ones.
The definition of an extended field is made up of two mandatory fields:
- Scope: The editorial entity that the extended field belongs to.
- JsonSchema: The JSON definition of the extended field
Custom entities
In FORGE → Administration → Configurations → Custom Entities, you can edit the existing extended fields and create new ones.
The definition of an extended field is made up of six fields (see their description in the picture below):
- Code
- Distribution API Code
- Name
- Menu Label
- Icon
- JsonSchema
And six toggle fields:
- This entity is enabled: Toggle on/off to enable/disable the custom entity availability.
- Can be used for tagging: Toggle on/off to enable/disable the custom entity as a tag.
- Visible in Menu: Toggle on/off to enable/disable the custom entity visibility in the left menu of the FORGE Back Office.
- Visible as Story Part: Toggle on/off to enable/disable the custom entity availability as a part of the story.
- Can be created: Toggle on/off to enable/disable the possibility of creating the custom entity.
- Can be mentioned: Toggle on/off to enable/disable the possibility of mentioning the custom entity in a story.