Elentra Settings

Elentra Platform Technical Documentation
Search…
Elentra Settings
Elentra ME settings, are application settings stored in the elentra_me.settings table. These settings can be used enable/disable modules and features, as well as customize the Elentra experience. There are many settings that have been created over the years, while new ones get added with every release.
Creating New Settings
To create a new setting, you will need to create a migration that will run the query to insert your new settings. Click here to learn more about creating migrations.
Naming Convention
Please follow these rules when creating new settings. Additionally, settings should always reflect the positive state of an action. Use "enabled" not "disabled", "show" not "hide" and so on, and set the default values accordingly. 
1.When you need a setting to enable/disable a module/feature
Format:[module/feature]_enabled
Examples:
absence_enabled
calendar_assignments_enabled
2.When you need a setting to customize a feature
Format: [module/feature]_[action]_[detail]
Examples:
calendar_display_hour_date
calendar_display_weekend
cbme_enable_tree_aggregate_build
3.When you need to store information
Format: [module/feature]_[detail]
Examples:
api_reservation_class
cbme_ondemand_expiry_offset

List of Available Settings
Last updated: Elentra ME 1.23.0 release
Shortname
Default Value
Optional Values
Since
Notes
absence_enabled
0
0/1
1.18
Enable to use the Absence Management Module
allow_course_director_manage_stage
0
​
​
​
allow_program_coordinator_manage_booked_slots
1
0/1
1.15
When the setting allow_program_coordinator_manage_booked_slots is set to 0 in the settings table (by default it’s 1), the pcoordinators won’t be able to (1) delete slots that have off-service learners booked in them, (2) make any changes to the slot spaces
allow_program_coordinator_manage_stage
0
​
​
​
api_reservation_class
\Entrada\Modules\Reservations\Services\ReservationService
​
1.19
settings for use with external room reservation tool
assessment_delegation_auto_submit_single_target
1
​
1.20
​
assessment_display_tasks_from_removed_assessors
1
​
1.20
​
assessment_method_complete_and_confirm_by_pin
1
​
1.13/1.14?
These settings are about adhoc distributions and which form completion methods are allowed.
assessment_method_send_blank_form
1
​
1.13/1.14?
These settings are about adhoc distributions and which form completion methods are allowed.
assessment_reminder_by_target_enabled
0
0/1
1.23
Allow the target of an assessment task to send a reminder to the assessor
assessment_reminder_limit_enabled
1
0/1
1.23
​
assessment_tasks_show_all_multiphase_assessments
0
​
​
On A&E dashboard for admin? For all users?
assessment_triggered_by_assessor
1
​
1.13/1.14?
These settings are about adhoc distributions and who can trigger a task once the distribution has been created.
assessment_triggered_by_target
1
​
1.13/1.14?
These settings are about adhoc distributions and who can trigger a task once the distribution has been created.
bookmarks_display_sidebar
1
​
​
​
box_api_token
null
​
1.22
An API token from Box.com (for integrating folders and files within a Box.com account as Event Resources)
box_api_token_expiry
null
​
1.22
The expiration value for an API token from Box.com (for integrating folders and files within a Box.com account as Event Resources)
calendar_assignments_enabled
1
​
1.17
Defines whether or not assessments from a course gradebook are displayed on a learner's dashboard calendar
calendar_display_default_date
%j %M %Y
​
​
​
Elentra ME 1.22
Next - Developers
Elentra Deployment
Last modified 1mo ago
Copy link
Contents
Creating New Settings
Naming Convention
List of Available Settings