Administrate offers a robust standard data model to support your training operations. However, it is common that you may want to store data on Administrate entities that aren't part of the stock configuration. Using Custom Fields, you can add your own fields directly onto many of the common data entities which you can view on the left side of the screen. All of these fields will be available in reporting, communication merge fields and through the API just like the standard fields. Custom fields are one of the many ways Administrate can be flexible to meet your unique processes and data requirements.
Administrators can find the setup for Custom fields in the Control Panel, titled "Custom Fields". The available entities are listed down the left-hand side of the screen, along with how many current custom fields are currently configured for that entity. The "Create Field" button in the upper right will allow you to add a new Custom Field, and give you a variety of options.
The setup will allow you to name the field, mark the field as required, choose a data and field type, and add permissions to the field. You can also add a tooltip, which will provide a longer description for the field presented when the user hovers over it. In addition, the "unique API name" for the field can provide an easier way for developers to refer to the field when accessing it through the API.
A single Custom Field can be added to multiple entities. In addition, associating a Custom Field with both Course Template and Event entities will allow any created Events to automatically default its Custom Field values to that of its Course Template.
Restricted Permissions will allow you to restrict access for this field for each user role in the system to:
"None" - No visibility or access to this field
"View" - User can view the field but not edit it
"Edit" - User can view and edit the field
Once configured, you can always edit these field setups or delete them entirely from this screen as well. Keep in mind if you delete a custom field, all the data stored in that field will be deleted too, so proceed with caution!
Article is closed for comments.