Extra fields dictionary v1

Extra fields

This page provides a dictionary of the available extra fields usable in Chamilo 1.*.

Extra fields are a feature of Chamilo that allows the Chamilo administrator to extend the data stored with some of the important resources of Chamilo (users, courses, learning paths, quizzes, etc). You can find a list of all resources that have extra fields enabled by going to your Administration page -> Platform -> Extra fields.

The intention is for this page to be exhaustive, but please note:

that they are only all available in the latest of the v1.* versions
that they sometimes require the activation of a plugin to provide any useful feature/behaviour
that they might disappear or be abandonned over time
that they might get integrated into more "solid" table in later major versions (this is why this is a list for v1.* only)

Extra fields' fields naming

There is usually a lot of confusion happening when trying to understand the extra_field table or entity because two names are clashing: extra_field.extra_field_type and extra_field.field_type.

extra_field_type is, in fact, the resource type to which the extra field is attached. For example, "1" means "user", "2" means "course". You can find the meaning of each number at https://github.com/chamilo/chamilo-lms/blob/1.11.x/src/Chamilo/CoreBundle/Entity/ExtraField.php#L22-L41.
field_type is really the type of field, like you would find the type of input in a form. For example "text" or "date" or "radio". You can find the relationship between IDs and field types here: https://github.com/chamilo/chamilo-lms/blob/1.11.x/main/inc/lib/extra_field.lib.php#L14-L40

List of known extra fields

Although the following table shows a few exceptions, we recommend extra fields to be named in lower_camel_case (no uppercase, one underscore between each word).

Field's internal name	Related resource	Field type	Purpose	Related feature/page/plugin
acquisition	learning path view	Radio buttons	Adds a column "Acquisition" in student LPs table to enable teachers to mark a learning path as acquired and for the student to see which LPs are acquired by the student	Learning path tracking
address	user	text	User address	Reports plugin
advancedcourselist	exercise	Multiple selection drop-down	Enable to select the list of course to which the learner will be subscribe on exercise validation	Automatically created by Remedial and Advance Courses plugin
already_logged_in	user	checkbox	Available by default in Chamilo. Registers if the user already connected to the platform at some point
ask_for_revision	forum_post	checkbox	Enable the possibility to ask for the revision of a post to be translated by others it used in common with revision_language that indicates the language in which it will be translated.	// Hide forum post revision checkbox //$_configuration['hide_forum_post_revision_language'] = false;
ask_new_password	user	checkbox	Requires enabling $_configuration['force_renew_password_at_first_login'] to force the user to change his/her password when they first login. This is great for added security when pre-provisioning user accounts
attachment	scheduled announcements		Enable attachment for scheduled announcements in sessions	// Allow scheduled emails to session users. //CREATE TABLE scheduled_announcements (id INT AUTO_INCREMENT NOT NULL, subject VARCHAR(255) NOT NULL, message LONGTEXT NOT NULL, date DATETIME DEFAULT NULL, sent TINYINT(1) NOT NULL, session_id INT NOT NULL, c_id INT DEFAULT NULL, PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE = InnoDB; // sudo mkdir app/upload/scheduled_announcement // Uncomment and set the following setting to true before moving on //$_configuration['allow_scheduled_announcements'] = false; // Add "attachment" file upload extra field label in: main/admin/extra_fields.php?type=scheduled_announcement&action=add // Add "send_to_coaches" checkbox options field label in: main/admin/extra_fields.php?type=scheduled_announcement&action=add
authenticationDate	user		..	CAS authentication
authenticationMethod	user		..	CAS authentication
azure_id	user	text	User info necessary for Azure ID integration	Automatically created by Azure Active Directory plugin
birthday	user		Stores the birthdate of a user	Not really fixed to "birthday", but will appear in user's details
block_category	exercise	checkbox (Yes)	when using categories in an exercise, when finishing all the question of a category the user will be presented with a page that indicates that if he continues to the next category he will not be able to come back to the one he just finished, he will be blocked.	Requires enabling $_configuration['block_category_questions']. //ALTER TABLE track_e_exercises ADD COLUMN blocked_categories LONGTEXT; // Requires an exercise extra field "block_category" type checkbox (Yes) //$_configuration['block_category_questions'] = false;
buycourses_company	user	text	Company name to buy a product	BuyCourses plugin
buycourses_vat	user	text	VAT number to buy a product	BuyCourses plugin
buycourses_address	user	text	Company address to buy a product	BuyCourses plugin
categorie	user		French term for category, representing one of many extra information that can be saved in a user profile at import time through batch imports
captcha_blocked_until_date	text	user	Internal: string holding a date until which the captcha is blocked
cas_user	user		Stores the CAS user identifier
careerid	career	integer	External ID of career	CSV import & careers diagrams
career_urls	career	text	URLs of careers	CSV import & careers diagrams
career_diagram	career	text		CSV import & careers diagrams
categoria_profesional	user	text	Professional category of user	SEPE plugin
collapsed	session		Prevents users to see the full details of the session until extended	Goes with `$_configuration['allow_user_session_collapsable']`
comunidad_residencia	user	select	Community of residence of user	SEPE plugin
comunidad_trabajo	user	select	Community of residence of user	SEPE plugin
ConsideredWorkingTime	work / student_publication		Stores the amount of hours a user is considered to have worked on an assignment	Assignments time tracking
created_by	user		..	CAS authentication
credentialType	user		..	CAS authentication
dashboard	user	text
disable_emails	user	checkbox	Indicates whether the e-mails from the platform should be held in a training pause	Pause Training plugin
disable_import_calendar	course	13
downloaded_at	user_certificate	text	Holds the time of download of a given certificate for additional reporting	Reports plugin
drupal_user_id	user	text	The external user ID in Drupal	Create Drupal User plugin
edad	user	date	Birthdate of user	SEPE plugin
etat	user		French term for state or status, representing one of many extra information that can be saved in a user profile at import time through batch imports
end_pause_date	user	datetime	Indicates the date at which the pause ends in a training pause	Pause Training plugin
experiencia_anterior	user	textarea	Previous experience of user	SEPE plugin
external_*_id	*	text	In the context of automated imports, this can reference an ID from outside the Chamilo system
gdpr	user	checkbox	Whether the user accepted the specific gdpr terms in the inscription form	It goes with a configuration option // Show multiple conditions to user during sign up process // Example with a GDPR condition /*$_configuration['show_conditions_to_user'] = [

'conditions' => [         [             'variable' => 'gdpr', // internal extra field name             'display_text' => 'GDPRTitle', // checkbox title will be translated with get_lang('GDPRTitle')             'text_area' => 'GDPRTextArea', // this will be translated using get_lang('GDPRTextArea')         ],         [             'variable' => 'my_terms',             'display_text' => 'My test conditions',             'text_area' => 'This is a long text area, with lot of terms and conditions ... ',         ],     ], ];*/  |

Miscellaneous references

In app/config/configuration.php (or if you are upgrading from an older Chamilo, in main/install/configuration.dist.php for the template), you may find a series of settings that are dependent on arbitrary named extra fields, or that apply to all extra fields of a particular type of resource. These sometimes require to be combined with database changes to be enabled (if so, those changes are documented in configuration.php):

// Allow to show users in a map, users need to have a coordinates extra field BT#15176
//$_configuration['allow_social_map_fields'] = ['fields' => ['terms_villedustage', 'terms_ville']];

// Allow add one column by each user extra field indicated to the Gradebook Flatview for each user.
// $_configuration['gradebook_flatview_extrafields_columns'] = ['variables' => []];

// In Scorm comunication use a specific extra field instead of the user_id
//$_configuration['scorm_api_extrafield_to_use_as_student_id'] = '';

// Search user by extra field in the user list.
//$_configuration['user_search_on_extra_fields'] = ['extra_fields' => ['variable1', 'variable2']];

// Course catalog show extra fields (visible and filtered)
//$_configuration['allow_course_extra_field_in_catalog'] = false;

/*
$_configuration['course_catalog_settings'] = [
    'link_settings' => [
        'info_url' => 'course_description_popup', // course description popup page
        'title_url' => 'course_home', // Course home URL
        'image_url' => 'course_about', // Course about URL
    ],
    'hide_course_title'
    'redirect_after_subscription' => 'course_home', // or 'course_catalog' to stay in the page
    'extra_fields_in_search_form' => ['variable1', 'variable2'],
    'extra_fields_in_course_block' => ['variable3', 'variable4'],
    'standard_sort_options' => [
        //  1 means allow sorting in ascending order
        // -1 means allow sorting in descending order
        'title' => 1,
        'creation_date' => -1,
        'count_users' => -1, // subscription count
        'point_info/point_average' => -1, // average score
        'point_info/total_score' => -1, // score sum
        'point_info/users' => -1, // vote count
    ],
    'extra_field_sort_options' => [
        'variable5' => -1,
        'variable6' => 1,
    ],
];
*/

// Page "My Courses" shows specific course extra fields (CourseManager::getExtraFieldsToBePresented)
/*$_configuration['my_course_course_extrafields_to_be_presented'] = [
    'fields' => ['mots_cles', 'duree_en_min', 'format'],
];*/

// After a user updates his profile, send notifications.
/*$_configuration['user_notification_settings'] = [
    'notification1' => [ // Notification label
        'email' => 'admin1@example.com,admin2@example.com', // multiple emails allowed
        'sender_email' => 'sender@example.com',
        //'if_extra_field_changes' => ['variable1', 'variable2'],
        'if_field_changes' => ['phone', 'email'],
        'subject' => 'User profile update',
        'content' => '/mail/user_profile_update.dist.tpl',
    ],
];*/

// Block question categories BT#17789
//ALTER TABLE track_e_exercises ADD COLUMN blocked_categories LONGTEXT;
// Requires an exercise extra field "block_category" type checkbox (Yes)
//$_configuration['block_category_questions'] = false;

// Allow time per question. BT#17791
// Requires a question text extra field called "time", value in seconds.
// ALTER TABLE track_e_attempt ADD COLUMN seconds_spent INT;
//$_configuration['allow_time_per_question'] = true;

Chamilo LMS

Home
- Tools and sessions
- Quiz: Importing
  - IMS/QTI
Releases
Community support strategy
- Estrategia de soporte comunitario
Translation management
How to report issues
- Comment rapporter une erreur
- Cómo reportar errores
Development
Integration
- Chamilo APIs
  - Rest WebServices
  - GraphQL API / API v3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extra fields dictionary v1

Extra fields

Extra fields' fields naming

List of known extra fields

Miscellaneous references

Clone this wiki locally