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
​
​
​
calendar_display_hour_date
%H:%i
​
​
​
calendar_display_last_hour
19
​
​
Defines display on learner dashboard calendar
calendar_display_month_day
%d
​
​
​
calendar_display_rotations
0
​
1.20
used to control whether or not to show learners their rotation schedule in the event calendar view on the dashboard
calendar_display_rotations_clinical_event_threshold
​
​
​
​
calendar_display_rotations_excluded_courses
​
​
​
​
calendar_display_scroll_hour
7
​
​
Learner dashboard calendar?
calendar_display_start_hour
7
​
​
Defines display on learner dashboard calendar
calendar_display_weekend
0
​
​
Deleted in 1.18
calendar_excluded_days_dashboard
0,6
​
1.18
Set which days to exclude from dashboard calendar ( 0 is sunday, 1 is monday etc..)
calendar_excluded_days_events
0,6
​
1.18
Set which days to exclude from events calendar ( 0 is sunday, 1 is monday etc..)
calendar_separate_short_events_enabled
0
0,1
​
​
calendar_start_on_monday_dashboard
0
0,1
​
Start calendar from Monday on dashboard. Overridden by default by calendar_excluded_days_dashboard
calendar_start_on_monday_events
0
​
​
Start calendar from Monday on events page. Overridden by default by calendar_excluded_days_events
caliper_api_key
​
​
​
​
caliper_debug
​
​
​
​
caliper_endpoint
​
​
​
​
caliper_sensor_id
​
​
​
​
capture_calendar_id
​
​
​
​
capture_consent_enabled
1
0/1
1.19
used to allow org. to not require faculty to consent to lecture capture in personal profile
capture_enabled
​
​
​
Defines whether you use automated lecture capture feature for learning events.
capture_google_app_name
​
​
​
​
capture_google_calendar_sync_enabled
​
​
​
​
capture_google_sync_interval
​
​
​
​
capture_min_available_after_event
​
​
​
If using lecture capture, defines when videos will be available after a recorded learning event.
capture_resource_default_description
​
​
​
This is a recording of the event.
capture_resource_default_embed_code
​
​
​
​
capture_resource_default_title
​
​
​
Lecture Recording
capture_stream_file_format
​
​
​
{prefix}-{timestamp}-{channel}
capture_stream_time_format
​
​
​
Ymd-His
cases_enabled
1
1,0
1.15
​
cases_restrict_learner_view
1
1,0
1.15
Hide future Cases from learners
cbme_assessment_form_embargo
0
​
​
allows CBME org. to apply embargo conditions to Rubric forms so they are hidden from targets until specific conditions met
cbme_enabled
​
​
​
Defines whether an organisation is using the CBME module (will change learner view of dashboard)
cbme_enable_tree_aggregates
1
1,0
​
This defines whether the CBME Objective Tree abstraction layer will attempt to read from an aggregated version of the CBME objective tree table instead of the main CBME Objective Tree table. The aggregates are scoped to tree ID, user and/or course.
cbme_enable_tree_aggregate_build
1
1,0
​
This defines whether or not the CBME Objective Tree abstraction layer will attempt to build aggregate trees when needed.
cbme_enable_tree_caching
​
​
​
This defines whether or not the CBME Objective Tree abstraction layer will read/write CBME Objective tree datasets to cache.
cbme_enable_visual_summary
0
0,1
1.21
Enables CBME Visual Summary Dashboard added in https://elentra.atlassian.net/browse/ME-4557​
cbme_memory_table_publish
​
​
​
When creating a new CBME Objective Tree Version, the CBME Abstraction Layer will attempt to utilize a memory table when building a new version, instead of using the CBME objective tree table directly. Enabling this feature greatly improves version creation performance. It should only be enabled when the database user has access to create memory tables.
cbme_ondemand_expiry
0
​
1.19
allows on-demand tasks to have an expiry date added
cbme_ondemand_expiry_offset
+7 days
​
1.19
if using automatic expiry for on-demand tasks, set duration of time after which they should expire
cbme_ondemand_expiry_workflow_shortnames
[]
​
1.19
if using automatic expiry for on-demand tasks,
use to control which workflows have the automatic expiry applied
cbme_ondemand_start_assessment
​
​
1.17
​
cbme_ondemand_start_assessment_add_assessor
​
​
1.17
optional, if selected you will have the ability to add new assessors. By default these added assessor will be stored in the cbl_external_assessors table. If you want the added assessor to be an internal user you must also merge ME-1434 to get this complete feature
cbme_ondemand_start_assessment_director_as_staff_workflow
​
​
1.17
toggle whether faculty directors get the staff workflow view. Default is off (0) - all faculty get the faculty workflow view
cbme_ondemand_start_assessment_replace_admin_trigger
​
​
1.17
to toggle whether the “Trigger Assessment” button on /admin/assessments gets switched over to use the workflow view. Default is off (0).
cbme_ondemand_start_assessment_shortcut_button
​
​
1.17
optional, if selected a short cut icon will be displayed to learner in their cbme dashboard beside corresponding EPAs
cbme_standard_kc_ec_objectives
​
​
1.17
CBME specific. Defines whether or not you allow programs uploading CBME data to select between using standard key and enabling competencies or program-specific key and enabling competencies (Step 3 of data import?)
clerkship_housing_department_id
​
​
1.21
Stores a Housing Department ID for an organization
clinical_event_approval_enabled
​
​
1.16
Granular clinical events - allows learner to accept, reject or modify a scheduled granular clinical event
clinical_experience_default_filter
course
​
​
dictates which filter is the default when land on Admin > Clinical Experience
community_allow_leave_community
​
​
1.20
used to control whether users can leave communities they were added to by an admin
community_course_outline_hide_pcoordinators
​
​
​
Hides the user view of pcoordinators on a course page
community_display_guest_enrollment
1
​
1.20
​
community_share_show_file_versions
1
​
​
Defines whether or not you allow members of a community to view file versions (on Document pages only?)
course_objective_category_enabled
​
​
1.17
Enables the category select (primary, secondary, tertiary) in the new Curriculum Tag Selector
course_webpage_assessment_cohorts_count
4
​
​
​
course_webpage_open_to_groups
​
example: ["faculty:faculty","faculty:director"]
​
Enables automatic course website access to any specified group/role combination. Value must be a JSON object
course_website_autoenroll_audience
​
​
1.17
Enable/disable auto-enrolling course audience into a course website. You can still override this on a per-course basis, by adding a record in the course_settings table, using the course ID and the same shortname course_website_autoenroll_audience
course_website_associated_faculty_admins
0
​
1.19
option to have Associated Faculty on course setup tabs automatically made Administrators of the related course websites
curriculum_tagsets_allow_attributes
1
​
​
Defines whether you let users create hierarchical tag sets in Manage Curriculum
curriculum_tagsets_max_allow_levels
9
​
​
Sets the maximum number of hierarchical levels in a tag set in Manage Curriculum
curriculum_tags_default_status
2
​
​
​
curriculum_tracks_enabled
1
​
1.19
allows org. to disable Curriculum Tracks feature so it won't display in System Settings)
curriculum_weeks_enabled
1
​
​
Enables curriculum weeks which is required if you want to use Units or Cases
custom_course_contacts_enabled
1
​
1.21
​
default_stage_objective
​
​
​
​
disable_distribution_assessor_notifications
0
​
​
This goes hand in hand with unauthenticated_internal_assessments and enable_distribution_assessor_summary_notifications. When using unauthenticated distribution assessments, you probably want an single summary email with a link to each task rather than an email for each new task. This disables the per-task reminders.
disable_target_viewable_release_override
0
0/1
1.15
​
disclaimer_preamble_creation
0
0/1
1.21
​
duty_hours_options
on_duty,off_duty,on_call,absence
​
1.20
allows you to configure which duty hour options display to learners
enable_distribution_assessor_summary_notifications
​
​
​
This adjusts the emails for distribution assessments to have a nightly summary of all new tasks, and then a weekly summary of tasks that are still incomplete.
enable_prompted_responses_comments_and_reviews
0
0,1
1.18
Allows staff and faculty users to have a personalized A&E prompted responses tab where they can take action on prompted responses
eportfolio_can_attach_to_gradebook_assessment
1
​
​
​
eportfolio_entry_is_assessable_by_default
1
​
​
These settings define who can specify if an eportfolio is assessalbe (in the case that the eportfolio is attached to a gradebook).
eportfolio_entry_is_assessable_set_by_advisor
1
​
​
​
eportfolio_entry_is_assessable_set_by_learner
1
​
​
​
eportfolio_show_comments_in_gradebook_assessment
0
​
​
​
evaluation_data_visible
1
0/1
1.22
​
events_default_color
null
​
1.20
allows you to set a default color for events added to the calendar, can help with school branding
events_discussions_enabled
1
​
1.19
allows org. to hide discussion and comments section of learning event page
events_download_all_files
1
​
1.17
Defines whether you allow learners to bulk download events from their Events tab
events_freetext_objectives_enabled
1
​
​
Defines whether free text objectives can be entered on a learning event page
events_limit_color_update_trigger
0
​
1.20
used to control whether events with recently added or updated links change color
events_recently_updated_offset
-2 days
​
1.22
​
events_resource_access_code_default
0
​
1.21
​
events_resource_allow_no_timeframe
1
​
​
​
events_resource_bulk_upload
1
​
​
​
events_resource_display_time_estimate
1
​
1.19
Show learners the time estimates for event resources
events_resource_require_time_estimate
0
​
1.19
allows for admin/teaching faculty to enter estimated times to complete resource attached to events
events_sms_attendance_enabled
0
​
1.17
​
events_teaching_minutes_enabled
0
​
1.21
​
events_teaching_minutes_self_edit_enabled
0
​
1.21
​
event_objectives_filter_by_course
1
​
1.20
allows you to configure whether or not to automatically apply a course filter on the curriculum tag selector used on a learning event page
event_recurring_fields_content
1
​
1.18
​
event_recurring_fields_edit
1
​
1.18
​
event_resource_external_upload_default_timeframe
none
​
1.23
​
event_resource_requirement_labels
{"required":"Required","optional":"Optional"}
​
1.19
allows for easy renaming of learning event resource category 
exams_html_encode_import_questions
​
​
​
Defines whether to run html_encode when importing questions. Use when the questions you are importing contain HTML markup.
exams_purpose_mode
permissive
​
1.23
​
exams_student_submit_after_date_enabled
0
​
​
​
exam_security_options
basic,seb,rp_now,examity
​
1.22
​
export_calculated_grade
{"enabled":0}
​
​
​
export_weighted_grade
1
​
​
​
filesystem_chunksplit
8
​
​
​
filesystem_hash
sha256
​
​
​
flagging_notifications
1
​
​
​
gradebook_adjusted_grades_enabled
0
​
1.21
Add ability to enter an Adjusted Total to the Grading Spreadsheet for a Course Gradebook https://elentra.atlassian.net/browse/ME-4194​
gradebook_assessment_bonus_marks
0
​
1.20 
used to control whether to allow a course gradebook to accept values over 100%
gradebook_assessment_document_delivery_enabled
​
​
1.15
Allows you to provide documents to learners via a course gradebook
gradebook_assignment_show_form_options
graded,ungraded,graded_ungraded,hide
​
1.21
​
gradebook_include_ungraded_assessments
1
​
1.21
define whether an unentered grade in a Course Gradebook assessment is ignored or counts as 0 https://elentra.atlassian.net/browse/ME-4821​
gradebook_passing_grade
​
​
1.17
define a passing grade as used in System Report > Learner Report > Student Report Card
grading_scale_max_gpa
4.3
​
1.18
Sets the maximum value for the GPA, used in grading scales under admin - system settings - grading scales
housing_distributions_enabled
0
​
1.21
Enables Housing based distributions https://elentra.atlassian.net/browse/ME-2170​
include_name_in_flagged_notifications
1
​
​
defines whether or not to include names of users in prompted response notifications in Assessment and Evaluation items
language_supported`
{"en":{"name" : "English"}}
​
​
​
learner_explorer_enabled
1
1,0
1.18
Enable to turn on the Learner Explorer and allow faculty and admin staff to see an overview of a learner's performance across courses on gradebook assessments
learner_levels_enabled
0
1,0
1.15.3
sets whether or not users can see UI to manage learner levels on course enrolment tab *previously this was not currently added to Elentra by default, developers may need to manually add this setting
legacy_clerkship_events_enabled
0
​
​
(Only applicable to Queen's?)
location_attendance_active
0
0/1
1.19
Allows learners to mark their own attendance at events based on their physical location
logbook_active
​
​
​
Defines whether you are using the Logbook feature (i.e., getting students to log encounters).
logbook_log_inactive_rotations
0
​
​
used to control whether or not to allow learners to create logbook entries for courses where their enrolement in the curriculum period has passed
logbook_outstanding_percentage
50
​
​
Define the threshold for level of completion to trigger 'complete' status in Clinical Experience > Logbook
lor_objective_tagging
1
​
​
This defines whether or not you allow admin users to assign curriculum objectives to objects in the Learning Object Repository.
lottery_enabled
1
​
​
Defines whether you are using the Lottery module.
lrs_endpoint
​
​
​
Stores information if you're using a learner record service?
lrs_password
​
​
​
Stores information if you're using a learner record service?
lrs_username
​
​
​
Stores information if you're using a learner record service?
lrs_version
​
​
​
Stores information if you're using a learner record service?
lti_anonymous_username
anonymous
​
1.21
​
lti_anonymous_user_id
anonymous
​
1.21
​
lti_custom_parameter_prefix_token
custom_%s
​
1.21
​
lti_replacement_token_community
%CMID%
​
1.21
​
lti_replacement_token_course
%CID%
​
1.21
​
lti_replacement_token_course_code
%CCODE%
​
1.21
​
lti_replacement_token_course_name
%CNAME%
​
1.21
​
lti_replacement_token_event
%EID%
​
1.21
​
lti_replacement_token_user
%UID%
​
1.21
​
lti_replacement_token_username
%UNAME%
​
1.21
​
media_source_sync_attempt_retries
25
​
1.21
​
microsoft_teams_enabled
0
0/1
1.22
Enables the Microsoft Teams integration feature
microsoft_teams_event_sync_limit
+30 days
​
1.22
​
mobile_logbook_enabled
1
​
​
Defines whether or not logbook is active in mobile
notices_send_email
1
0,1
1.18
Enable to allow users to optionally send an email when they send a notice via Admin > Manage Notices
peer_assessment_target_release_enabled
0
​
1.18
Overrides default assessment behavior for peer assessments. Sets default release options(checkbox) for peer assessments (never release, immediately report)
people_display_group_role
​
​
​
used to control is users’ group and role are displayed in People Search results
personal_meeting_courses
​
​
1.18
Specify the Courses to include the web conference url
personal_meeting_event_types
​
​
1.18
Specify the Learning Event Types to include the web conference url
personal_meeting_event_types_excluded
​
​
1.18
Exclude any Learning Event Types that should never has web conferencing url provided
personal_meeting_intro_text
​
​
1.18
Provide any intro. text to appear before the url
personal_meeting_platform_provider
​
​
1.18
Provide the name of the web conference platform provider
personal_meeting_url_prefix
​
​
1.18
Define the web conference tool meeting id prefix
personal_meeting_window_minutes
​
​
1.18
Define how long before an event starts users can access the meeting url
personnel_api_curriculum_coord_show_all_faculty
0
​
​
Whether or not all faculty will show up when adding curriculum coordinators as course contacts? (Presumably anyone added gets full course and event access)
personnel_api_curriculum_coord_show_all_staff
0
​
​
Whether or not all staff will show up when adding curriculum coordinators as course contacts? (Presumably anyone added gets full course and event access)
personnel_api_director_show_all_faculty
0
​
​
Whether or not all faculty members will show up when adding Course Directors to Courses. Also note that non-faculty:directors will not be able to access the CBME Program Dashboard for learners.
personnel_api_program_coordinator_show_admins
0
0/1
1.18
​
personnel_api_reviewer_show_all_admin
0
​
​
Whether or not all faculty members will show up when adding Course Directors to Courses. Also note that non-faculty:directors will not be able to access the CBME Program Dashboard for learners.
podcast_display_sidebar
1
​
​
Controls whether the podcast link displays
prizm_doc_settings
​
​
​
​
profile_name_extensions
1
​
​
Allows for Post Nominal letters IE: Ph.D , MD
profile_pronoun_edit_enabled
0
0,1
1.22
Enables the ability to select and change the preferred pronoun using the field on the user profile
profile_pronoun_enabled
0
0,1
1.22
Enables the inclusion of a pronoun field in the user profile
reservation_cancel_url
​
​
1.19
settings for use with external room reservation tool
reservation_create_url
​
​
1.19
settings for use with external room reservation tool
reservation_enabled
0
​
1.19
settings for use with external room reservation tool
reservation_modify_url
​
​
1.19
settings for use with external room reservation tool
reservation_password
​
​
​
​
reservation_user_id
​
​
1.19
​
settings for use with external room reservation tool
respondus_download_lab
https://downloads.respondus.com/OEM/LockDownBrowserLabOEMSetup.exe
​
1.22
A download URL for a specific version of Respondus
respondus_download_macos
https://downloads.respondus.com/OEM/InstallLDBOEM.zip
​
1.22
A download URL for a specific version of Respondus
respondus_download_msi
https://downloads.respondus.com/OEM/LockDownBrowserLabOEM-MSI.zip
​
1.22
A download URL for a specific version of Respondus
respondus_download_win
https://downloads.respondus.com/OEM/LockDownBrowserOEMSetup.exe
​
1.22
A download URL for a specific version of Respondus
respondus_launch_prefix
na
​
1.22
​
respondus_secret_1
​
​
1.22
​
respondus_secret_2
​
​
1.22
​
show_evaluator_data
1
0/1
1.22
​
show_personal_meeting_links
​
​
​
Learning Events (link to web conference tool)
sites_enabled
​
​
​
Defines whether you use sites (aka Manage Locations)?
tbl_enabled
0
​
​
whether or not the TBL tools in Elentra are available
twilio_enabled
0
​
1.17
​
twitter_consumer_key
​