Custom entities may be created whenever there is a need to keep data points grouped together. For example, one student enrolled in their upcoming semesters coursework, each with their own unique characteristics (such as name, status, Midterm Grade, etc.). Because of their one-to-many nature, custom entities enable for storing of the history for these grouped data points. Common custom entities created include scholarships, extracurricular involvement, volunteer activities, and schedules.
Entities are built using a combination of custom entity-scoped fields and forms, and are meant to appear on Person and Dataset records. Using forms to construct the entity widget, institutions can use conditional logic and calculations directly within the widget.
Entities require the following configurations:
- Create the object (entity).
- Create entity-scoped fields that will be associated with the entity.
- Create an entity widget form to collect data associated with the entity.
- Refresh the Configurable Joins Library.
- Return to your entity widget form and add your Custom List Fields within the Edit Properties menu.
- Embed the entity widget form. The widget form can be embedded in Slate forms such as a custom tab or inside of a Slate application.
Because an entity is entirely custom built by the end-user, there are limitless use cases for creating and configuring entities. Before creating a new entity, first, consider if there is a standard way to capture and store data elements. Course information is a good example of a standard data point stored in Slate via the Courses tab on the Profile, whereas a custom entity for courses allows for additional display options.