Private Access Only
This feature is currently in Private Access stage and only available upon request from the Tovuti Support Team.
Private Access Features are fully supported and functional features that require additional feedback and development before a public release.
Similar to User Profile Fields, Custom Fields allow Administrators to assign custom field values to different data types, providing greater LMS customization and more granular reporting.
This article outlines the following concepts:
- Create a Custom Field
- Course Custom Fields
- Event Custom Fields
- User Object Custom Fields
- Object Type Custom Fields
- Purchase Order Custom Fields
- API Endpoints for Custom Fields
Create a Custom Field
Go to Configuration > click Custom Fields > click New
Give this Custom Field a Name and, if applicable, assign it to an Object Type, and select a Field Type.
Object Type refers to what the Custom Field is attached to within the LMS. Custom Fields can be applied to Courses, Events, User Objects, Object Types, and Purchase Orders.
Field Type refers to the different types of data that custom fields can support, including:
- Text Box
- Text Area
- Select*
- Multiple Select**
- Radio Buttons*
- Checkbox**
- Country
- Date
- URL
*Single-select
**Multi-select
Course Custom Fields
Custom Fields set to Courses become a field in the Advanced Settings tab of the Course editor.
Duplicated Courses retain the Custom Field values from the original course.
Event Custom Fields
The Events list is enabled with an Advanced Search function that includes filters for Custom Fields.
Custom Fields set to Events are shown in the Basic Information tab of the Event editor.
Event Custom Field Reporting
When creating an Event Report in the Report Builder, scroll down to include Event Custom Fields in the Report.
User Object Custom Fields
Custom Fields set to User Objects become an included field when configuring a User Object.
Object Type Custom Fields
Custom Fields set to Object Types become an included field when configuring an Object Type.
Purchase Order Custom Fields
Custom Fields set to Purchase Orders become an included field in the Settings tab of the Purchase Order editor.
API Endpoints for Custom Fields
Utilizing API endpoints with Custom Fields allows Admins to automate the importing and management of custom user data. This is especially helpful when the LMS has a large number of users.
Full CRUD (create, read, update, delete) capability is available through the Profile Field endpoints in the Tovuti API documentation.
The Custom Field endpoints listed in the documentation only include Read capability. Admins can recreate their previous Custom Fields endpoints to the full capability of Profile Fields endpoints.