Docebo Guide
Docebo Guide
Documentation_eng.html
Docebo documentation
1. Introduction 1. Question about open source 2. Who is behind Docebo 2. Installation 1. Download and SVN 2. Server configuration 3. php.ini special settings 4. Install Docebo on Windows systems (local installation) 5. Install Docebo on a Mac (local installation) 6. Install Docebo in a server 7. Upgrade, patch and Backup 8. Phpmyadmin usage 9. Server prerequisites 10. Learning object prerequisites 11. Manage languages 12. Backup, security and shared authentication 13. Template customization 14. If something goes wrong ... 3. Usage documentation 1. Admin documentation 1. First login 2. System configuration 3. User management 4. Sub administrators 5. Public administrator (Docebo 3.6) 6. Advanced functions 7. Courses 8. Report 9. New reporting system (Docebo 3.6) 10. Physical classroom management (beta) 11. LMS advanced functions 12. CMS Pages 13. CMS Blocks 14. Statistics 15. CMS advanced functions 16. E-Commerce (beta) 17. E-Portfolio 18. PDF Certificates 19. PDF Meta-Certificates (Docebo 3.6) 20. IO Task 21. Competences module (Docebo 3.6) 2. Teachers documentation 1. How to start 2. Course list and course catalog 3. User profile 4. Organizing a course, how to define usage rules 5. Menu management 6. Manage learning object and lessons repository 7. User's groups 8. Learning Object FAQ 9. Learning Object Glossary 10. Learning object HTML page 11. Learning object "Upload file" 12. Learning Object Link 13. Learning Object Test 14. Advanced test functions (Docebo 3.6) 15. Learning Object Poll 16. Learning Object Scorm 17. Sequencing of learning objects 18. The forum 19. The wiki 20. The instant messenger 21. Internal message system 22. The project management 23. Events reservation
1/126
28/10/2008
Documentation_eng.html
24. Chat 25. My grade 26. Gradebook 27. General stats 28. User stats 29. Lesson stats 3. Students documentation 1. Welcome page 2. Self learning functions 3. Collaborative learning functions 4. Reporting functions 5. E-Portfolio for students 4. Videoconference 1. How to schedule a virtual classroom 1. DimDim 2. Teleskill 5. Programmers documentation 1. Writing PHP code 2. Changing database structure 3. Create CMS Blocks 4. Interfacing with Docebo rest API (ver. 3.6) 6. Scorm tutorial 1. Introduction to scorm standard 2. Scorm glossary 3. Difference bitween create Sco and Scorm Packages 4. Create sco with Adobe Captivate 5. Create sco with Exelearning 6. Create sco with Coursebuilder 7. Create scorm package with Reload editor 8. Manage scorm package in Docebo
2/126
28/10/2008
Documentation_eng.html
Introduction
1. The Docebo suite is a completely free content management (CMS) and e-learning (LMS) platform released under Open Source license; 2. The e-learning platform supports SCORM 1.2 (and from docebo 3.6 scorm 2004 too) and manages more than 50 functions, the CMS ;
Main Docebo Functions
1. E-Learning administration 1. E-learning lessons can be organized in a tree 2. You can insert different functions inside the learning management system page 3. E-learning user can be stored and organized in tree 4. Users can be organized in group 5. Users can receive notification via SMS 6. Sub administrators 7. You can add infinite additional catalogation fields 8. LMS languages can be customized via web interface 9. E-Leaning user subscription can be free or moderated 10. E-Learning course subscription can be free or moderated 11. Course curricula 12. Course catalog 13. Report by user, groups or tree 2. CMS administration 1. User catalogation by tree 2. User groups 3. Additional catalogation fields 4. CMS and E-Mail notification policy 5. Sub administrators 6. Optimization for search engine trough the mod_rewrite function 7. Language customization and import/export via web interface 8. Subscription to groups or system can be free or moderate 3. E-Learning functions 1. LMS levels are: Super administrator, tutor, mentor, student, supervisor, guest 2. Double e-learning access with accessibility features enabled disabled 3. Course presentation page 4. Learning objects are stored and organized in a tree 5. Chat, Accessiblke chat version 6. Video Conference 7. Forum 8. Test, random answer, time answers, 7 kind of answers supported 1. Single answer 2. Multiple answer 3. Choose right/wrong word 4. Association 5. Open answer (Text) 6. Upload file 7. Fill the blank space 9. Poll, FAQ, help upload files 10. Collaborative e-learning through project manager 11. Report by learning object or user 12. Test result table 13. Prerequisites on learning objects 14. Messages 15. Teacher advice 16. E-Learning classroom can be divided in groups 4. CMS functions 1. Pages are organized in a tree view 2. A single page can contain different functions 3. Topics 4. News archive 5. Images and Movie archive 6. Documents archive 7. Links archive 8. Content archive 9. Forum 10. Banner 11. Polls 12. Contact form building 13. Chat
3/126
28/10/2008
14. 15. 16. 17.
Documentation_eng.html
Video Conference Image Gallery Statistics Newsletter (also useful for sending large number of emails)
4/126
28/10/2008
Documentation_eng.html
5/126
28/10/2008
Documentation_eng.html
6/126
28/10/2008
Documentation_eng.html
7/126
28/10/2008
Documentation_eng.html
Server configuration
As written "everywhere", the LMS works under several Operating Systems, but in order to use SCORM functions a specific configuration is required. Component versions: PHP 4.3.8 or higher (Note, from docebo 3.7 only php5 will be supported, in docebo 3.6 RestAPI module is available only for php5) MySQL 4.1 or higher Apache 1.3.x or 2.0.x or iis6 Server suggested configuration To use SCORM components you have to enable the domxml library (a PHP extension that you can activate from php.ini) For security reasons we suggest to set the php.ini configuration safe_mode to ON and the register_global to OFF (Note, if safe_mode is configured to ON you are forced to use the FTP upload function to transfer SCORM packages) File upload suggested configuration The filecourses folder and all subfolders have to be CHMODed to 777 (for windows system you need to have write permission for the current user). The max_upload_filesize is defined by the server. If you can configure it you should tune the following parameters: Max Upload filesize Max Post Filesize Max execution time Memory limit (Useful higher than 8 Mb to use unzip functions) We noticed that in some installations of Linux Red Hat, the Apache configuration regarding the max filesize is overridden by Apache. In these cases you have to change the LimitRequestBody parameter located in the httpd.conf file. File can be uploaded through 2 methods. The one to be used has to be configured in the config.php file.
"FS" means file system, this is the old method that doesn't work with safe_mode enabled or in your local Windows machine (the "ftp" option will not work in your Windows machine!) "FTP" uses the PHP FTP functions, this is more secure and powerful. You have to configure the FTP options in the config.php file with the same data you use in your ftp account. An example of config.php correctly filled:
$ftphost = "127.0.0.1"; // usually this setting is ok $ftpport = "21"; // same as above $ftpuser = "[email protected]"; $ftppass = "mypassword"; $ftppath = "/var/www/html/";
8/126
28/10/2008
Documentation_eng.html
Before starting to edit the file, please notice that the ";" symbol stands for a comment, so any change to a commented line will have no effect! For example, if you want to edit the error_reporting parameter, you have to edit the last line and not the first one because it is commented! ;error_reporting = E_ALL & ~E_NOTICE ;; - Show only errors ;; error_reporting = E_COMPILE_ERROR|E_ERROR|E_CORE_ERROR ;; - Show all errors ; error_reporting = E_ALL & ~E_NOTICE OK, let's analyze the parameters that can be changed: error_reporting: if set to E_ALL will also show NOTICEs, which are not errors. If you face problems please change this setting from: error_reporting = E_ALL to error_reporting = E_ALL & ~E_NOTICE upload_max_filesize: set the maximum size of the files you can upload. If you will upload big learning object please change it from: upload_max_filesize = 2M to: upload_max_filesize = 24M This parameter works together with another one: post_max_size: set the maximum data size that can be stored through the "post" method. You have to specify the same size of upload_max_filesize, please change this setting from: post_max_size = 8M to: post_max_size = 24M max_execution_time: if you want to upload large files or run intensive queries (such as database backup, report and so on) please change this setting from:
9/126
28/10/2008
max_execution_time = 30 to: max_execution_time = 300
Documentation_eng.html
memory_limit: if you have errors related to the amount of memory allocated for the process during some operations please change this setting from: memory_limit = 8M to: memory_limit = 16M The last issue is related to the DomXml() function and extension. It is used to work with XML data (currently adopted by the doceboLMS only for SCORM support, but we will add more import/export functions that will use XML). To enable DomXml() on your easyphp installation please proceed as follows: Right click on black E Stop easyphp Right click on black E Configuration/Extension Flag domxml
If during the Apache startup phase you see some error messages please: Search for a dll called iconv.dll Copy it on system32 Restart apache If you have a previous installation of easyphp 1.6, please uninstall it and manually delete all the folders related to the old easyphp 1.6. If you don't use easyphp, you have to configure your php.ini as follows (the example is for Windows). Please change from: ;extension=php_domxml.dll to extension=php_domxml.dll
10/126
28/10/2008
For security reason set:
Documentation_eng.html
allow_url_include = Off
11/126
28/10/2008
Documentation_eng.html
Click on continue until the end of the installation. Then, click on finished and EasyPHP will be installed. Lets suppose that you install it in c:/easyphp. Into that directory there will be many folders, but the one you need is called www. There are few other elements to explain you how to use EasyPHP. In the bottom-right part of the screen you will find a black E with a red point. If the point is flashing the server is active, otherwise it is stopped. To manage EasyPHP and show the administration menu you just need to click on the black E with the right mouse button. Left clicking will show the information console. To check if Apache and PHP are correctly working, we will use the phpinfo() function. It will test the server, collecting information about the PHP configuration. If the result is like this, everything is ok:
How to build this file to check PHP and Apache status? It is very simple, you just have to create a text file called info.txt, with this code inside: <?phpinfo();?> save the file and change the name from info.txt to info.php, put it into the www directory and open your Browser on this page: http://localhost/info.php. To enable DomXml() on your EasyPHP proceed as follows: Right click on the black E located on the bottom-right part of your desktop Stop EasyPHP Right click on the black E Configuration/Extension Flag domxml
12/126
28/10/2008
Documentation_eng.html
If during the Apache startup phase you encounter some problems, proceed as follows: Search your computer for a dll called iconv.dll Copy it in the system32 directory Restart apache If you have a previous (older) installation of EasyPHP 1.6 please uninstall it and manually delete all its folders. Before proceeding with DoceboLMS installation you have to create an empty database with PHPMyAdmin.
13/126
28/10/2008
Documentation_eng.html
2. Open the .dmg file and copy the MAMP folder inside application. The folder contains the following sub folders:
htdocs is the Apache home directory. 3. Launch the MAMP application, you will see the following screen:
14/126
28/10/2008
Documentation_eng.html
Inside Preferences it is possible to modify Apache and MySQL listening ports and to choose between PHP4 and PHP5 (for DoceboLMS we suggest PHP4).
15/126
28/10/2008
Documentation_eng.html
After uploading the files you will find the following items in the root directory: doceboCms doceboCore doceboKms doceboLms doceboScs files install upgrade admin.php config.php index.php If you are in a Linux server you have to set permission in this way after the installation (on windows this is not required) all files permissions must be set to 644 all folder permissions must be set to 777
16/126
28/10/2008
Documentation_eng.html
before the installation these files and folders should have 777 permission: [file] config.php (after installation set to 644) [folder] files and all the subfolders (after installation keep 777) and if you use the DoceboCMS, in order for statistics to work, you have to make writable (777) the folder and all the files located in: /doceboCms/addons/bbclone/var
For security reason after you have installed everything you should: Delete the install/ folder Delete the upgrade/ folder Set to 644 permission the admin.php, config.php and admin.php files Set to 644 permission the .htaccess located in the files/ folder Set to 644 permission the .htaccess located in the root folder Set to 644 permission the .htaccess located in the root folder /doceboCms/addons/bbclone/var folder Path for home installation: let's suppose you have installed all Docebo files in a directory called docebo you have to call the Docebo installation page in this way: http://localhost/docebo/install Path for server installation: let's suppose you have to install on the main page of a website called www.website.com/install/ As you know you now can reach the 3 Docebo sections and admin areas through these links: www.website.com/doceboLms/ www.website.com/doceboCms/ www.website.com/doceboCore/ or you can reach the same page with www.website.com/admin.php You can also configure which will be the main page (LMS, CMS or KMS). After launching the installer through the /install/ area you will be asked the language interface and then proceed with all the steps.
17/126
28/10/2008
Documentation_eng.html
18/126
28/10/2008
Documentation_eng.html
Database backup using phpMyAdmin (see the next chapter) you can do a complete backup of the database, in this case you will save only the data Total backup: Download all the files and proceed to a database backup We suggest to plan complete periodic backups and when upgrading to major releases first try on a backup version (and not on the production version).
19/126
28/10/2008
Documentation_eng.html
If you are working on a local machine don't worry about the warnings.
We are interested in the 3 first menu voices: Structure: Shows the table list and allows us to: Browse table content Select table values Insert new data in the tables Properties: Show table structure Drop: Delete table (ATTENTION!!!) Empty table content (ATTENTION!!!) SQL: This part of the menu allows us to change data in the database structure, doing that is easy, you only need to browse your PC directory and choose the right file
The export function is important for backup. Structure Only: Saves only the database structure but not the data
20/126
28/10/2008
Structure and data: Saves structure and data Data Only: Saves only data XML: Exports in XML format
Documentation_eng.html
DATABASE IMPORT USING THE SHELL mysql database -u user -h host .p pass < file.sql database = database name user: user name pass: password file.sql: file name DATABASE BACKUP USING THE SHELL mysqldump -c -hlocalhost -uusername -ppassword nome_db > dump.sql hlocalhost = db HOST uusername = USERNAME ppassword = password nome_db =database name dump.sql = name of the file saved The -h, -u and -p parameters and data don't have spaces. User mike -> -umike
21/126
28/10/2008
Documentation_eng.html
Server configuration
Opertaing System: Linux, Windows, Mac, BSD, Sun Web server: Apache or IIS (IIS supported from docebo 3.5 and not 3.0.6 or lower) PHP Version: 4.3.11 or higher or php5:
(Note, from docebo 3.7 only php5 will be supported, in docebo 3.6 RestAPI module is available only for php5)
Active domxml(); library active (Not necessary for php5) Extension overload(): attiva (please check this in particular on redhat and mandriva, it's strange but they didn't install by default) Dom extension , in some Fedora and CentOS distro we experienced some php5 compile without dom included Max Upload filesize configured at least of the size you need to upload Max Post Size also configured at least of the size you need to upload Max Execution time configured for the time you take to upload a single big file PHP Memory configured with enogh memory to "unzip" the scorm package MySQL and FTP modules activated SMTP installed and configured to work with PHP FTP server installed and configured with, at least, localhost permissions Availability to assign directory permission in recursive mode
22/126
28/10/2008
Documentation_eng.html
23/126
28/10/2008
Documentation_eng.html
Manage languages
In Docebo managing languages means different things: Creating a new one Upgrading an existing language Create a new language key Edit an existing language key Mass language editing for a single page
24/126
28/10/2008
Documentation_eng.html
Template customization
Docebo's layout is essentially based on style sheets, and the output is xhtml 1.1 and css2 compliant: Docebo's graphical engine is based on templates, in which stylesheets and icons are handled. The template directories are stored in : DoceboLms/templates/ DoceboCms/templates/ DoceboCore/templates/ The main stylesheets containing color combinations, size of the interface, the scorm player, main page and other graphical elements are: doceboLms/templates/standard/style/style.css doceboLms/templates/standard/style/style_scormplayer.css doceboLms/templates/standard/player_scorm/default/def_style.css doceboCore/templates/standard/style/style_table.css doceboCore/templates/standard/style/style_form.css Docebo is also a multi-template system, i.e. after the login, groups or categories of users can be presented with a different layout and different contents, both for functions and training offer. In very advanced scorm content supply scenarios, it is also possible to associate a different template to each scorm player that handles the display of the didactic packet.
25/126
28/10/2008
Documentation_eng.html
When i'm using scorm object I receive error like: xmldoc has no proprerties or other "strange" javascript POPUP First turn off the debug mode in admin area/config/config/main option If continue to display error: It's a server issue regarding pear inclusion (Experienced, for example, in xampp) Please go on doceboCore/addons/soap/pear.php and empty the file from all the code without deleting.
Server become so slow and sometimes freeze when i have lot of connections
Maybe apache have some connection limit and generate this error in error.log: [error] server reached MaxClients setting, consider raising the MaxClients setting You have to edit apache configuration files and rise connection limit to 150 or higher.
26/126
28/10/2008
Documentation_eng.html
First login
URL to connect to the site for the first login: http://www.yoursite.com/admin.php Introduction to the activity: At the first login after the installation procedure, you will face some steps that allow you to configure the system. Some examples of the variables that are configurable are: the complexity of your organization number of users to manage number of courses to activate (This activity can take from a few seconds to several minutes) Once you have entered the address, the system will recognize your web client's language and you will be redirected to the interface with the appropriate language. If your language is not available, you will be redirected to English. For the first access to the Admin area you have to use the password created during the installation process (or given to you by the system installer). Workflow: System configuration User creation and catalogation
27/126
28/10/2008
Documentation_eng.html
System Configuration
Introduction to the activity: During the first access you have to set up the administration area. Through the configuration interface you can enable advanced functions for specific needs. Before creating users in the database, you can choose to create additional category fields, create groups, Sub-Administrator (if needed) and so on ... Workflow: Choose functions to activate Definition of category rules and roles Creation of custom category fields Creation of category tree Creation of groups and roles User creation Sub-Administrator creation Choose functions to activate: Inside the configuration area it is possible to manage the setup of each Docebo section. In the administration menu you will see only the activated functions, configuration stored inside global menu is shared by all the sections (CMS, LMS, KMS)
Definition of category rules and roles: Docebo allows to categorize users for better filtering and searching policy and also for permission management. You can choose to adopt a tree structure. Creating roles using the groups functions will make most of the common activities easy. Creation of custom category fields: custom fields (that can be used for searches and the cataloging of users) can be assigned to all the users (if included in main root) or can be assigned to one or more levels (parts of the tree) or to groups.
Creation of categorization tree: In case of complex organizations, it is possible to create a schema through the tree and link the users to one or more sub levels. Note: All the users can be seen inside the main tree (root). User editing and deletion MUST be done there, placement inside a sub-tree is only a logical placement, and deleting a user from a sub tree IS NOT EQUAL to deleting and editing from the main tree (root).
28/126
28/10/2008
Documentation_eng.html
Creation of groups and roles: It is possible to create boxes to put users in. These boxes are the "Groups" to be used in a dynamic way. This module is also useful to manage roles that work together with the tree schema, e.g. Managers (group) of Marketing office (sub tree). Groups can be associated to one or more applications and can be distinguished in 4 types: Groups only visible to the administrator Groups visible to the users that can also subscribe to them Groups visible to the users that can be subscribed but require Administrator approval Groups visible to the users but with subscription permission reserved to the Administrator User creation: According to the policies chosen inside the configuration options you can now populate your user database. This activity can be done through the user categories by filling the category fields. Associated category fields can have following characteristics: Mandatory / Non mandatory User can change it / Can not change it Regarding the user registration policies: Are created by the administrators Can subscribe Can subscribe but they need administrator moderation.
Sub-Administrators creation: Super Administrators can delegate part of the activity to Sub-Administrators with limited rights. The limitations are: Functions to manage Groups or sub tree visible by the Sub-Administrator
29/126
28/10/2008
Documentation_eng.html
User management
Introduction to the activity: User creation is divided in 2 steps, the start-up phase, where you have to populate the database for the first time and the update step in which you have to maintain your database of users. In the start-up phase is important to define the cataloging policies, the parameters to use and the policies. Based on your organization complexity you can choose from: Standard cataloging fields Cataloging with additional fields Cataloging with additional fields + Groups Cataloging with additional fields + Groups + Tree
Workflow: Choose cataloging policy Groups management Tree management User creation User editing and deletion User moderation Choose cataloging policy: Based on organization complexity you have to set up strategies that fit your organization structure, you have 4 alternatives available: Standard fields cataloging: in this case you will use only standard system fields (Name, Surname, e-Mail). cataloging with additional fields: You can add to standard fields more fields that you have previously created; additional fields can be simple text, extended text, drop-down, yes/no, data and file upload, all that fields can be used as search fields. cataloging with additional fields + Groups: Groups are boxes where you can insert users, have a cataloging goal but you can also use it for defining roles. To each group you can associate cataloging fields, in this way a user subscribed to a certain group will have standard and additional cataloging files and also cataloging fields associated to the group. cataloging with additional fields + Groups + Tree: If groups are cross users the organization module allows to put the users inside a tree structure, where the sub-tree can have custom cataloging field. Based on your cataloging policy a user can be stored in a single sub-tree or in multiple ones. Groups management: We have described many groups functions, we can also associate groups to specific sub-trees or other groups. We have 4 kind of groups: Free Groups: Visible to all the users and all the user can auto-subscribe. Moderated Groups: Groups visible to everyone and everyone can auto-subscribe but a moderator have to authorize him. Closed Groups: Group visible to the users where the moderator or a sub-administrator can subscribe Group: Groups not visible to the users but only used by the administrator. Groups can also set to be visible only to certain sections of Docebo.
30/126
28/10/2008
Documentation_eng.html
Tree management: User cataloging inside the tree offers a complete vision of the organization structure and eases the user cataloging. The tree can be organized in relation of the company context and can set up the following parameters: Cataloging fields are common for all the sub tree Custom cataloging field Sub tree cataloging Attention: users inside the sub tree are virtual users and cannot be managed when are located there, management operation may be done only in root area. User creation: User creation can be done in different ways: User are created directly by the Administrators Creation moderated by a sub administrator (Administrators with moderator role have to confirm) Auto subscription to the platform Moderated auto subscription (Administrators with moderator role have to confirm) During the creation we can also subscribe users and associate them to the tree (this operation only when in admin context), during the subscription phase the interface will also ask to fill extra fields associated with groups and sub tree areas. Modify/Delete users: Clicking on the tree root you can perform several actions: Frozen (suspended) users User deletion (with all related data) It is possible to edit the user parameters in every part of the tree, when you edit a user you can also edit all related fields. Remember that certain fields can be hidden by the user profile and that users can edit their fields from their user profile. We have 3 ways for subscribing user to the platform, Free subscription: Everyone can subscribe to the platform Moderated subscription: Everyone can self subscribe to the platform but must be authorized by the Administrators with moderation rights. Subscription is made only by the administrators: Only Administrators and Sub-Administrators with moderation rights can create users.
31/126
28/10/2008
Documentation_eng.html
Sub Administrators
Administrators are different from super administrator becuase thay have limited permission on user, courses and content management. This limits can be configured by the control panel. How to create and configure sub-administrators Every LMS user can be sub.administrator, to activate him you can edit the user by "user management" area and set level as sub.administrator. In administration module "Main > Permission > Sub administrators" you can find the edited user.. To every user there are 5 icons that allow to manage the functions, if CMS is also enabled icons are 10.
Configuration : Whit this function you can set specific administrator limitis like: Maximum number of users that the admin can activate If the activation are directly activated or need third party permission Maximum number of course subscription If the acourse ctivation are directly activated or need third party permission Menu management : this feature allow to enable to sub administrator only certain functions. FOr example we can create a sub.administrator that manage only course but that can't subscribe users to a course. User management : whit this feature you can assign only some user to manage and not all the complete user list. (very useful for Area manager and similar). Language management: Limit language management and translation only to some language available. Course management : Similar to limit user management but related to courses in watch or manage. Funzioni relative al Cms : The other 5 features are related to CMS page management, to content, media and news limit for sub administration.
32/126
28/10/2008
Documentation_eng.html
Public administrator
The Public Administrators are very similar to Administrators, but access to their tasks by special modules directly from the public LMS, without entering the administrative side. You can also assign a more limited number of functions such as:
Another difference is on the display report, an Administrator may not create new reports but only see those made available from the New Reporting System and marked as "public".
33/126
28/10/2008
Documentation_eng.html
Advanced functions
Introduction to the activity: DoceboLMS 3.0 introduces many advanced features. Now that the system is much more powerful, things are a little bit more complicated during the setup process. We will show functions that make it easier to use the advanced functions to fit your customization needs: Workflow: Platform subscription policy Privacy and security management Groups subscription policy Advanced users cataloging Sub Administrators Alert and notification Interface to an SMS gateway Platform subscription policy: It is possible to define the platform subscription policy (to populate the user database), it is possibile to subscribe in 3 ways: Self subscription Moderated self subscription Only administrator can subscribe Chosen policy is configurable from configuration/login and registration configuration. If you choose moderated subscription policy the Super Administrator and Administrator with moderation permission can authorize users located in the waiting list. If you choose to use the advanced registration form it is possible to make the subscription policy to deal with groups, in this case users will be asked to fill cataloging fields related to the groups. The system allows automatic subscription to groups, in this case the user will be self subscribed to certain groups, this function is also setup from the configuration panel.
Privacy and Security Management: In order to offer better security to our users we have added several new functions to the Docebo platforms: Password policy (Minimum size, type of characters that can be used and so on) Maximum number of login attempts, after that the system will temporarily ban the user Storing in the database failed logins or only failed login forcing Password expiration Time allowed for password confirmation Groups subscription policy: User groups (means groups used for the Administrator area not for a course area) have the following characteristics: Software: A group can be assigned only to one of the application or more than one, this means, for instance, that in an e-learning environment we can use a group not used in a CMS environment. Subscription policy: In this case group subscription can be: Free Moderated Only Administrator can subscribe We also have groups invisible to users that can be used only by the Administrator. Advanced users cataloging: Docebo applications allow to catalog users using an unlimited number of fields and more powerful catalogation policy. The most simple catalogation strategy is to use standard fields, Name, Surname, UserName and e-mail, if the strategy is to use a more articulated catalogation strategy you can use:
34/126
28/10/2008
you can use:
Documentation_eng.html
Assign additional cataloging fields: You can create additional fields and associate them to the user profile for a more detailed user cataloging Place users in a tree schema Place users in a tree schema and associate different cataloging fields to different sub trees Assign catalog fields to groups, which can be used to manage roles or users groups, cataloging fields associated to groups are inheritated by the groups members Sub admins: We can have sub administrator that can have the following limitations: Course subscription or just pre-subscription Maximum number of users that the sub-Administrator can create or subscribe to a course Courses, Bounded courses or course catalog that can manage Users, group users or sub-trees that can manage Functions accessible by the Administrator Alert and notification: An administrator can define rules for the notification of certain events, such as: When we receive a reply to a forum thread When the user profile is changed by the Administrator When a new advice has been inserted ... The configuration system works as inheritance, this means that the administrator chooses the general notification policy (activated, not activated and configurable by the user), last configuration is related by media used, notification can be done via e-mail or SMS. A user can manage alerts and choose whether to receive or not a specific alert and also define if he needs to receive them by e-mail or SMS. Interface to an SMS gateway: we have an agreement to interface our system to an SMS gateway called SMSMarket.it, after buying a credit with this SMS Gateway provider you just have to fill the data with the parameter given to you after the buying confirmation. These fields are: International prefix: Will be placed before the telephone number Sender number: Name of the sender (Works on gateway 3, attention, 1 cent more expensive than the interconnection fee!) Gateway user: Your SMSMarket.it user account Gateway password: The password of your SMSMarket.it account Cellular number field: Custom field where the user's mobile phone is stored Select gateway: If you choose a number different from 0 that means you have specific need (ask smsmarket.it), the sender number works on gateway 3 (1 cent more expensive than interconnection). For customers outside Italy please use gateway 0. Gateway IP: Server where the gateway is located (usually is ok to keep the default) Port: The port used by the gateway (usually is ok to keep the default) The system will update the credit after every SMS sent.
35/126
28/10/2008
Documentation_eng.html
Courses
Types of Courses House, Blended and E-learning. The courses of classroom and blended it will be possible to assign one or more classrooms on the course, in e-learning courses this feature is disabled Member of a course (Under construction) construction: The course appears on the list courses only to users with higher-level students enabled (subscribers) Course (Available and Confirmed) Available and Confirmed: In these states the student can access the system Concluded: Only users who completed the course can access it. Cancelled: Avoid that there are auto registrations by catalogue and no one can access it. Future Options: Play direct supervision of a learning object: Course Editions: Course button statistics Other options: Who can see a list of subscribers In what area of the platform will the course be shown (catalog courses, external, only registered users) Method of completion: Based on the conclusion of one or more learning object or action teaching manual Who can access the course once it is completed Maximum number of users that can be entered in the course Budget of SMS time allocated to the course Date beginning and end of the course Days assigned to the user to complete the course Days estimated for the completion of the course (only an estimate, serves as a parameter in the report) External link Course Sponsor Logos Course Logos
Here are the functions that interact with the courses: Classrooms: Marked as House Blended or you can assign one or more classroom references Responsibilities: Under the mapping which you can assign and how the powers will be allocated to the completion of the course
36/126
28/10/2008
Documentation_eng.html
Certificates: You can associate one or more certificates previously created, determine when you can download (according to the condition of the course) and know how many students have already taken the certificate. Waiting list students: You can approve users who are awaiting access to the course. Registration, Edit and describe descriptions from the course. Importation of registration: a file .csv (create the file with a line per userID) Importation of registration: users enrolled in another course. And 'possible' withdrawn "users enrolled in a course and enroll new the new courses. Menu: Preconfigured menus can be assigned to the course a "navigation system" including those functions used during excluding those not necessary.
37/126
28/10/2008
Documentation_eng.html
Report
The e-learning system provides two types of reporting: Reporting by user: creates a table with each user row course situation that contains information like User name, Name, Surname, Course that is attending, start date, end date and so on Reporting by course: a table where, for every course, is shown the number of subscribed users, how many users have to start, are attending or have completed the course The user selection can be done by: One by one By Groups By tree All the reports can be seen on the screen or exported as .csv files
38/126
28/10/2008
Documentation_eng.html
Creating new reports and report types created The creation of a new report has 4 steps: 1. Step One is to specify the name you want to assign to new report and select the type of information you want to have on the report 2. Step Two is required to set up filters on the lines, for example, if you chose the lines Users you can filter users shown in that report (one group, part of the organization, etc.) 3. Now you must select what information you want to merge with the previous year, or what columns are on the report
39/126
28/10/2008
Documentation_eng.html
4. Step Four allows you to configure the filters on the information of columns. For example, if you have selected the data with the courses, you can filter what courses to consider. You can also select which columns show in the report and, depending on the report, can be configured filters dynamic. Also in this step we can decide whether to save the report and return to the beginning or continue the display or show the results without saving the report. Once you receive the reports it is possible to use new actions. You can export the report as html, csv or file excel also in the case on the lines of the report are present users will be able to select some of these people and send them an e-mail. Editing a Created Report The modification of a report which already exist has functions but does not allow you to change the types of data that were selected as rows and columns, but instead you can change the filters set. Scheduling of a report This system allows you to schedule a report for sending periodic e-mail to other users, for each report, you can create scheduling and select one or more users. You can also choose an item: Daily Weekly Monthly To effectively use this feature, it is necessary to configure the server via a CRON operation or plan to call the file: http://nomsito/cron/cron.report.php
40/126
28/10/2008
Documentation_eng.html
41/126
28/10/2008
Documentation_eng.html
42/126
28/10/2008
Documentation_eng.html
CMS Pages
Language creation Pages and navigation structure creation Pages publication Language creation: DoceboCMS is a multi-language software that manages differents navigation trees for each language, so we can create simplified versions of the web site. This isn't possible on many other CMSes, that only allow to create a copy of the content. Italian: Home Page -> Societ -> Eventi --> Speciale Fiera Milano English: Homepage -> Company -> Events As you can see in the tree above, in the english version the page "Speciale Fiera Milano" doesn't exist because it's only a page dedicated to Italian people. Page creation: once you have created the language, then you can insert pages: the system is based on macroareas, so we can think of a navigation structure like this: Company People Mission Products Product 1 Product 2 Reserved area Documents In this case the menu changes according to the macroareas. In a small portal management, it's better to create one macroarea and the menu list below. In DoceboCMS a page is considered as a box in which you have to add contents. A content is a block you can put everywhere in the structure. It can be news, images, documents, free text, forum, feedback, newsletter, etc... It's possible to hide pages during the creation and then publish them. It's also possible to schedule a publication of a page in a given time and date.
43/126
28/10/2008
Documentation_eng.html
44/126
28/10/2008
Documentation_eng.html
CMS Blocks
Working steps: How to insert a block in the page Different kinds of blocks Permissions of the blocks Block syles How to insert a block in the page: once you have created a page and chosen a layout, it's possible to insert some functions blocks, to manage: the position in the page graphical layout permissions Different kinds of blocks: each standard function or new implemented one is a block. This can be put anywhere in a page Alerts: what kind of alerts the user wants to receive (e-mail or sms) Banner: It creates a block for a banner (for each category) Chat: A real time chat Single content/text: you can insert free text as you want Directory content: you can insert content from a selection of a navigation tree Selective content: You can select content from other directories Documents: You can publish a document placed in a directory Specific document: You can publish a specific document placed in a directory Form: You can create a form for a contact (for example). An user will fill it and than you'll receive an email. Forum: you can create forums for different groups of users and with different permissions Link: links... also managed by category-subcategory Login: to log-in in the reserved area Multimedia: You can publish images or videos Menu: Creation of navigation menu My groups: user can subscribe to a group News: news publishing, starting from a base directory. profile: user profile Send news: a user can send a news to the web site. Subscribe: subscription form to the web site. Permissions of the blocks: In each page, a block can be positioned anywhere, and each block represents a function. It is possible to assign some rules to these blocks, for instance to show the publishing date... The view control of the blocks is for groups. In each page we can have different blocks for different users. For Instance, for the user group "marketing" we can create a document only for them, that will be hidden for the other users. Block styles For each block we can assign a style: Background color Borders Block title Font The style can be decided during the creation of the block and can be edited in every moment.
45/126
28/10/2008
Documentation_eng.html
46/126
28/10/2008
Documentation_eng.html
47/126
28/10/2008
Documentation_eng.html
Statistics
General statistic: This function is a summary that analyzes the whole statistics grouped by the following parameters: Most used browser Most used operating system Accesses by country Most active crawler/robots Most active ISP Most visited pages Most active referrer Most used Search Engine Keywords Detailed statistic: Shows the last visitors grouped by visitors, robots crawler, referrer and shows what are visitors of the last 30 minutes, if you click on the number of visited pages you will see what pages a visitor has seen Temporal statistic: chart with the visits grouped: By day By week By month By year
48/126
28/10/2008
Documentation_eng.html
49/126
28/10/2008
Documentation_eng.html
Reserved area: DoceboCMS is not only a software to create web sites or portals but its also a tool to create reserved area and to publish documents for groups of users. First method, page level protection: you can create pages just for registered users or groups of users. Second method: you can create public pages, but protected blocks, so the page will have different contents for different users. For instance, you can decide to: publish a text and a login block for unregistered users, or publish a document block only for a certain group of users or more to publish the photo block only for friends, etc Recursive contents: as in other modules (documents, news, images) you can archive content with a tree system and structure like: Root Family images Family husband Parents Uncle Wifes family Parents Uncle Job images Milan Rome
Using Docebo's block system you can publish a tree choosing whether to publish the sub-trees images too. For instance you can choose to publish the family sub-tree and the parents and uncles sub-galleries, or not.
50/126
28/10/2008
Documentation_eng.html
E-Commerce
[Integrated from docebo 3.5] Docebo e-commerce system is made to organize an "online courses sales business", this means that some (or all) courses inserted in the catalog can be sold to registered users. Steps for creating an e-commerce system from docebo are: In admin area select TAX policy, if you need to sell in a country where there is only a single tax rate go to Admin/E-Commerce/Tax Zone and delete all the zones excluded the ones you need to mantain. Then go to tax rates and fill values in the matrix Then go to the payments accounts and manage payment details. Now the system is configured, you just have to go to Main/Configuration/E-Commerce and fill fields related to the seller. Put online courses to sell means to go to the given course properties (edit course then ...), mark course as course that must be placed in e-commerce and assign a price. Course in catalog marked as to be placed in e-commerce are marked as "Place in shopping cart", the user can manage a transaction as a normal ecommerce. After the order is complete, the system will send an e-mail to the e-learning platform administrator and also to the buyer. Now all the orders are stored in E-commerce/Transactions and must be approved by the seller.
51/126
28/10/2008
Documentation_eng.html
E-Portfolio
[Included from Docebo 3.5] Il sistema Docebo pu gestire diversi e-portfolio assegnati a diversi utenti, gruppi di utenti o rami dell'organigramma, la stessa cosa vale per i tutor che sono i "gestori" dell'attivit sull'e-portfolio. Lato amministrazione si pu attivare un e-portfolio, assegnare le domande al piano di sviluppo personale (domande relative agli obiettivi di apprendimento e sviluppo, nonch degli interessi dello studente), alle competenze strumenti utili a valutare le competenze dello studente (lo studente pu invitare altri a valutarlo). Una volta configurato l'e-portfolio lo studente potr iniziare a compilarlo e i tutor a monitorarne l'avanzamento agendo sul piano di sviluppo personale bloccando o sbloccando certi questiti e obittivi.
52/126
28/10/2008
Documentation_eng.html
PDF Certificates
[Included in docebo 3.5] Docebo manages PDF certificate templates, and students can download and print them. PDF certificate flow is: The Administrator creates a certificate template Once created he can make certificate template related to one or more courses and define "generating rules" (EXAMPLE: XYZ certificate can be generate only when the course has been completed) Now students can go to the "My certificates" area, preview and create the certificate The Administrator can "Unlock" certificates already created and "recreate" them with different values. IMPORTANT: For a limit of the PDF class that will be fixed in future versions we suggest to use ONLY background images and not to embed images in HTML code inside tags like <p> <div> <center> and so on, this can generate page errors. This is a certificate sample: We certify that the student [firstname] [lastname] Completed course [course_name] in date [date_end] The score of the final test was: [test_score_final] Supported fields are: [course_code] Course code [course_name] Course name [course_description] Course description [date_begin] Course starting date [date_end] Course end date [display_name] if user name, write name and last name are not available, username will be shown [username] User name [firstname] Name [lastname] Last name [date_enroll] Course subscription date [date_first_access] Course first access date [date_complete] Date of course completion [total_time] Total time spent in the course [total_time_hour] Total time spent in the course (hours only) [total_time_minute] Total time spent in the course (minutes only) [total_time_second] Total time spent in the course (seconds only) [test_score_start] Initial Learning Object score [test_score_start_max] Maximum initial Learning Object score [test_score_final] Final Learning Object score [test_score_final_max] Maximum final Learning Object score [course_score_final] Final score [course_score_final_max] Max final score [today] Date of certificate [year] Year of certificate
53/126
28/10/2008
Documentation_eng.html
PDF Meta-Certificates
The meta certificates are different from normal certificates for two reasons: They are designed to work on more than one course at a time: You can issue a certificate directly from administration (you can not generate it alone) The logic of operations is similar to certificates, so you can create a new certificate model and prepare the structure to generate PDFs. Once created, the model will create assignments, or you can decide from user to user which courses must be completed so that the certificate can be issued. For example: we can make the certificate available to Mario Rossi only after he has completed the following courses: Introductory Course and the Advanced Course Also through this form you can view the progress of a certificate, or display a red table if Mario has already completed both courses assigned to him or not and consequently whether it is possible to issue the certificate later on. Just like the form certificates once issued, the certificate creates a "static" pdf and changes personal data or his training plan will not be reflected on the granted certificate. In these cases it will be necessary to delete the previous issued certificate and generate a new certificate
54/126
28/10/2008
Documentation_eng.html
I/O Task
The I/O task (Input Output) allows to import and export data from and to Docebo. There are several pre-configured tasks written in php file format that manage these activities: Import/Export companies (connector.docebocompany.php) Import/Export organization chart (connector.doceboorgchart.php) Import/Export organization chart from xml file (connector.xmlorgchart.php) Import/Export user-course relation (connector.docebocourseusers.php) Import/Export course list (connector.docebocourses.php) Import/Export course list in SAP HR format (connector.coursesap.php) Import/Export course report (connector.docebocoursereport.php) Import/Export csv file (connector.csv.php) Import/Export docebo users (connector.docebousers.php) Import/Export users report (connector.userreport.php)
Creating a Connector means to activate it (there is a .php file that manages certain data) Creating a connection means to assign a certain activity to a connector, in order to write and read some data stored in CSV file or DB. To create a TASK means to associate a connector source to a connector destination where to archive (import/export) certain data. For instance, you can write to a CSV file or database starting from a Database or CSV. Example: Import users from a csv file loaded nightly by ftp and write data inside DOCEBO DB. Note: connectors are generally made in a way that recognizes data managed by connectors and data manually handled. Using the input/output module it is possible to schedule a set of activities that read from a .csv or .xml file loaded through FTP by another application or sent by Docebo to another application. Basic instructions for managing automatic import/export: Activities can be scheduled via the administration area using the I/O (input/output) module, which is placed in admin/main/configuration/IO task .csv files are placed in the files/common/iofiles directory by Docebo or third-party applications Import procedure is made by using cron o another scheduler and calling the doceboCore/tasks.php file User list import (e.g.. filename users_aaaammdd.csv) UserId, Password (e.g. claudio.erba, pippo). It is possible to add many other fields, if they should be handled by dropdown boxes then the fixed values have to be preloaded in the LCMS system. If authentication is managed with systems like LDAP it is not required to import passwords. Course list import (e.g. filename courses_aaaammdd.csv) Course code, course name (e.g. 001, Math). It is also possible to add to the .csv file other fields as: complexity, course status, subscription policies, course language, start date, end date, extimated time. Automatic user-course subscriptions import (e.g. filename AAAMMDDusercourses_data.csv) UserId, Course code (e.g. claudio.erba, 001). It is also possible to add an optional field that represents the level of the user in the course, if not specified the user will be added as student. 1 Ghost, 2 Guest, 3 Student, 4 Tutor, 5 Mentor, 6 Teacher, 7 Administrator.
55/126
28/10/2008
Documentation_eng.html
Form skills
This administration module is divided into four parts: Creation and management skills Assignment of responsibilities for a course Viewing skills acquired by a user Report on the skills acquired
Creation and management skills E-Learning> E-Learning> Management skills Through this form you can create their measured skills under various categories. Each jurisdiction may have a name located at the second language installed and a description For each jurisdiction is necessary to specify if is a score or flags or if its value rose from Acquired From to acquire only and does not provide an allocation of points. In the case of a power to points you can also specify the maximum points and minimum. For each jurisdiction is possible to indicate the type, distinguishing between skill and attitude. Once created their skills are three possible actions involving users: Get a list of users who have acquired the knowledge Assign experience as a competence to users (or assign points) Assign rights as you "acquire" users Assignment of responsibilities for a course E-Learning> E-Learning> Management courses A new icon for each course is now available which allows you to assign responsibilities to a course, this means that as soon as a user completes the course will be awarded points in the skills set here.
Viewing the skills acquired by a user In the area immediately after login the LMS is available within the form "my skills". Through this module the user can see what the responsibilities were assigned as "achieved" and what skills are already acquired.
56/126
28/10/2008
Documentation_eng.html
Report on skills acquired Inside the new reporting system you can create a report with "users" on the lines and "competence" in the columns showing which users have obtained certain skills. In particular, you can create dynamic filters that allow, for example, to know who has acquired more than 100 points in one jurisdiction and more than 20 points in another.
57/126
28/10/2008
Documentation_eng.html
How to start
Teacher activity is made inside the e-learning platform public area (ex. www.yoursite.com or www.yoursite.com/doceboLms/); Before teacher and students can enter inside the classroom the administrator should: Activate a classroom (course), assign a name, a menu and a usage policy Subscribe teacher, tutor and mentor to the course If the course is not a self-subscription or moderated subscription one, the admin have to subscribe students too. Once this is done the teacher can Enter inside the course, load learning objects, manage forums and so on ... Edit his own profile Manage his alerts
58/126
28/10/2008
Documentation_eng.html
59/126
28/10/2008
Documentation_eng.html
User profile
In the user profile an user can: Edit his personal information, as the picture, signature, avatar, etc Change his password and the platform template Edit some other information (If the administrator allows the user) such as the mobile phone number, the birth date, his company sector, etc
60/126
28/10/2008
Documentation_eng.html
61/126
28/10/2008
Documentation_eng.html
Menu management
Through this tool we can create specific configuration that allow users to create different scenarios: Grouping functions in macroareas Enable/Hide some functions Change usage permission for some functions and show/not show macro voices to some levels Rename menu items with your words This system makes the platform really flexible and you can use several didactical models. Initial mask shows what pre-defined menu are available and gives you the possibility to create a new one:
Menu management can be done creating macro categories and then inserting the functions you need under the right macro category, this is the interface:
For each voice it is possible to set up the permission to assign (who can view, edit, modify, delete this object, or moderate the forum and so on ...) You can also create a new menu starting from another one already configured.
62/126
28/10/2008
Documentation_eng.html
63/126
28/10/2008
Documentation_eng.html
64/126
28/10/2008
Documentation_eng.html
User groups
You can aggregate users in several groups and this is useful to exploit advanced functions inside the learning manager. These functions are: Learning object visible only to certain groups Messages sent only to certain groups Forums are visibile only to certain groups Advices visible only to certain groups Filtering stats and reports by groups. For the Project Manager module the Group usage is Mandatory. Note: Classroom groups are not related to admin groups. Grouping users in classrooms means manage these kinds of functions: Forum: Some forum discussion categories could be seen by one or more groups Messages: It's possible to manage the receivers by groups Advice: It's possible to show advices to one or more groups Learning Objects: Some learning objects can be shown only to some groups Statistics: We can create group filterss for watching statistics data Project: It is mandatory to assign a project to one group
65/126
28/10/2008
Documentation_eng.html
66/126
28/10/2008
Documentation_eng.html
67/126
28/10/2008
Documentation_eng.html
68/126
28/10/2008
Documentation_eng.html
69/126
28/10/2008
Documentation_eng.html
70/126
28/10/2008
Documentation_eng.html
71/126
28/10/2008
Documentation_eng.html
This module presents the list of questions created manually or imported and a simple search engine for navigation. You can create a new application directly from here so you can modify or delete a demand already present. You can also import (and export) demand from a text file formatted as GIFT (format supported by Moodle).
By selecting the questions you can presently export them in GIFT format or export them directly creating a new test which will be positioned directly in the course materials
72/126
28/10/2008
Documentation_eng.html
73/126
28/10/2008
Documentation_eng.html
74/126
28/10/2008
Documentation_eng.html
75/126
28/10/2008
Documentation_eng.html
The forum
The forum is the main way to discuss about certain themes. Forum is divided in: Categories: Created by the teacher who decide if they are visible by some groups. Threads: discussions posted by the teachers, students, etc they should be replied. The small man icon means that you can make this forum visible to certain users groups. Using the forum we can also: Upload a file into a thread Edit the replies Search into discussions Notify via e-mail or sms that a new discussion is started Notify via e-mail or sms that you have received a reply to a discussion that you have monitored Forums can be also moderated in two ways: Blocking a thread: we can read the discussion but we cant add any other reply Closing a thread: the thread isnt viewable anymore. Erase an answer Erase a thread Edit a user content Tips: User moderation is Level Based, you can assign moderator level to tutors or mentors assigning permissions on the menu management area Tips: File upload in forum works based on levels, you can assign permission to students to upload files through the menu management area Tips: It is possible to Unlock a previous moderated message by clicking on the Mail+Lock icon Tips: When you Erase Thread or an answer the data will be completely erased and cannot be restored
76/126
28/10/2008
Documentation_eng.html
The wiki
[Included from Docebo 3.5] The wiki is a powerful and simple text collaboration system. Unlike other wikis we don't use complex tags but simple html tags already included in the editor. In this way you can edit the wiki as you would edit a word document. The only tag we use is the double "[ [" to open and close a document "] ]" (without spaces). If you write a tag like document you will create a new page. The page is red when empty and blue when it contains text. The wiki is multilingual, therefore you can manage parallel translations of every single page. If it is actually multilingual you can see different flags on top of the wiki. Page titles are also multilingual, you have to put the translated page name after the original name separated by a "pipe". For instance, the page "documents" can be translated in the italian word "documenti", so the correct syntax will be "[ [" documents|documenti "] ]" (without spaces between the brackets). In each LMS course we can have one or more wiki, that can also be shared with other classrooms. There are policies for: View Edit Create Permissions for these 3 actions are assigned by the course menu.
77/126
28/10/2008
Documentation_eng.html
Instant messenger
[Included from Docebo 3.5] If enabled in the course it's possible to send real time messages with teachers and friends (like in MSN or Skype). Clicking on the number of connected students it's possible to choose the user you need to contact, the system will show him a popup with the message sent.
78/126
28/10/2008
Documentation_eng.html
Messaging system
This function is used to share files and messages in every single course, so, each student will be able to post new messages for every course he joins. In the message area we can send messages or attach files to: Single users A selection of users Groups of users
79/126
28/10/2008
Documentation_eng.html
80/126
28/10/2008
Documentation_eng.html
Events reservation
[Included from Docebo 3.5] This is a powerful module that allow teacher and LMS administrators to create events that students can subscribe (works also for Phisical events like Labs reservation and so on). This Module is "Course related" this means that the event must be linked to a course. The event can be scheduled from the teacher area or from the admin area, users can subscribe not full or expired events, teacher can see who has subscribed the event, can contact users via e-mail and so on, users list can also be exported in excel format. An Event have following parameters: Name Location Maximum users Starting subscription period End subscription period Date Start and end hour
81/126
28/10/2008
Documentation_eng.html
Chat
Starting from version 3.x, the chat has been completely rebuilt, now it is in ajax and not in flash, functions are: User list Emoticons
82/126
28/10/2008
Documentation_eng.html
My grade
In this area the student can see in a table all the results that he has obtained in the course, the fields are: Activity Date Comment Vote The student can only see the votes that the teachers decide to make public, so this is not the complete grade list.
83/126
28/10/2008
Documentation_eng.html
Gradebook
The Gradebook is a teacher dedicated module that allows to do 3 main things: View in a table/matrix mode all the classroom activities and test votes Manage alredy given votes and give final vote Create a new activity to insert in the table/matrix The view function is divided in 3 areas: the first part of the table is dedicated to aggregate the following info: Max activity/test score Required activity/test score to pass it Weight for final score Visible/not visible to students This activity is used for the final score Second part of the table is dedicated to show student's results The third part of the table is dedicated to show this info: How many users have passed the test How many users have failed the test How many users need manual votes to open answers and file upload Average grade Standard deviation Maximum score Minimum score The area to manage activities already done is the area where the teacher can edit automatic votes or can correct the 2 kind of text answers that can not be automatically scored by the system (Free Text and File Upload). It is also possible to edit the following test/activity properties: Weight Show to users Use for final score From here it is also possible to manage the final grade. The new activity functions allow the teacher to manually add a new activity and assign grades to students.
84/126
28/10/2008
Documentation_eng.html
85/126
28/10/2008
Documentation_eng.html
General stats
General stats report users' activities in the platform. The layout is the same, but the analysis can be done on three layers: General stats Viewed pages More used functions For each single user For each single log to the platform For each activity after a log in the platform
86/126
28/10/2008
Documentation_eng.html
User stats
Teacher can view, for each single user, how many learning objects are done and how many arent completed yet. He can also see test results. Opening the learning tree, we can see how many objects students have to do and how many are already done. If we want to see a test stat, we have to click on the test name, to see the results and the detailed aswers.
87/126
28/10/2008
Documentation_eng.html
Lesson stats
In this stats theacher can compare a user status with a learning object. By this layout, teacher can also see polls results. The first mask shows the selection of the object to compare. (we have to click on the icon on the right) Next mask shows every users that are part of the comparison. We can also filter them for groups or for status.
88/126
28/10/2008
Documentation_eng.html
Welcome page
Once you have been logged in Docebo you will find several function. In this document you will find all the functions you can see but the system administrator can disable some of this. First of all you will see all the courses you are attending, and, in the "learning history" all courses you have completed. In course catalog you will see all the courses you can subscribe, subscription can be automatic or you have to require permission The message area allow you to send messagges to every student or teacher that are attending same courses you are attending You have also your personal area, in this area you will find Profile: You can edit your info and change your password My Groups: You can manage your groups subscription My friends: You can add registered users as friend and send messages to them E-Portfolio (explained in separate page)
89/126
28/10/2008
Documentation_eng.html
90/126
28/10/2008
Documentation_eng.html
91/126
28/10/2008
Documentation_eng.html
Reporting functions
Student activity are tracked by Docebo. Tracked activity are: Activity inside the platform Time inside the platform Results for every single object that can track results Results taken in the object that teacher user allow to see are diplayed inside the "gradebook" module, also course certificate can considered a reporting function.
92/126
28/10/2008
Documentation_eng.html
93/126
28/10/2008
Documentation_eng.html
94/126
28/10/2008
Documentation_eng.html
DimDim videoconference
Info on external website http://www.dimdim.com
95/126
28/10/2008
Documentation_eng.html
Teleskill
More info on http://www.teleskill.net
96/126
28/10/2008
Documentation_eng.html
FORM USAGE When writing forms, HTML tags should not be directly written. There is a class called Form that can ease the form management and guarantee that their code will comply with the XHTML standard. The Form class provides these main methods: function openForm( $id , $action, $css_form = false, $method = false, $enctype = '', $other = '' ) opens the FORM tag with its attributes function closeForm() closes the FORM tag function openElementSpace( $css_class = 'form_elem' ) opens the section for the form content function closeElementSpace( ) closes the section for the form content
97/126
28/10/2008
function openButtonSpace($css_div = false) opens the button section function closeButtonSpace( ) closes the button section
Documentation_eng.html
function getTextBox( $text , $css_line = 'form_line_text', $inline = false ) creates a textbox function getLineBox( $span_text, $text , $css_line = 'form_line_l', $css_f_effect = 'label_effect' ) creates a texline function getHidden( $id, $name, $value, $other_param = '' ) creates a HIDDEN field function getTextfield( $label_name, $id, $name, $maxlenght, $value = '', $alt_name = '', $other_after = '', $other_before = '') creates a text field function getDatefield( $label_name, $id, $name, $value = '', $date_format = FALSE, $sel_time = FALSE, $alt_name = '', $other_after = '', $other_before = '' ) creates a date field function getPassword( $label_name, $id, $name, $maxlenght, $alt_name = '', $other_after = '', $other_before = '' ) creates a PASSWORD field function getFilefield( $label_name, $id, $name, $value = '', $alt_name = '', $other_after = '', $other_before = '' ) creates a file chooser field function getDropdown( $label_name, $id, $name, $all_value , $selected = '', $other_after = '', $other_before = '' ) creates a dropdown menu function getListbox( $label_name, $id, $name, $all_value, $selected = FALSE, $multiple = TRUE, $other_after = '', $other_before = '' ) creates a listbox function getCheckbox( $label_name, $id, $name, $value, $is_checked = false, $other_param = '' ) creates a checkbox function getRadio( $label_name, $id, $name, $value, $is_checked = false ) creates a radio button function getRadioSet( $group_name, $id, $name, $all_value , $selected = '', $other_after = '', $other_before = '' ) creates a set of radio buttons function getButton( $id, $name, $value, $css_button = 'button', $other_param = '' ) creates a button For further information give a look at: doceboCore/lib/lib.form.php
LANGUAGE KEYS USAGE To allow easy translations of the application messages, textual strings should not be included in the code. Instead, language keys should be adopted. They are symbolic constants that refer to a message that can be present translated in many languages inside Docebo database. Language management can be done through the administration interface and allows to insert new keys, to edit the existing ones and to add translations for those that are not already translated in a given language. From the programmer's point of view, it is important to take into account that the names chosen for the new language keys should have a specific prefix, so that they will not overlap with other ones included in Docebo. To show the content of a message you should use an instance of the DoceboLanguage class, that can be obtained with the following command: $lang=& DoceboLanguage::createInstance($module, $platform, $lang_code); where the meanings of the parameters are: $module = name of the module that contains the language keys (e.g. 'admin_content') $platform = platform in use (cms, lms, framework, ecc.) $lang_code = language to use (if not specified, the current language will be adopted)
98/126
28/10/2008
Documentation_eng.html
Then, messaged can be extracted with the following code: $msg = $lang->def($key); the $key parameter is the language key to show (e.g. '_BACK_TOLIST'). For further information related to the DoceboLanguage class, give a look at: doceboCore/lib/lib.lang.php
99/126
28/10/2008
Documentation_eng.html
SAFE OPERATIONS Adding a field to a Docebo table This operation can be risky if the following naming convention is not adopted: EXT_XXX, where the "EXT_" prefix is the extension and "XXX" the requested name. Adding a table to Docebo database This operation is not dangerous at all if the following table naming convention is adopted: EXT_XXX, where the "EXT_" prefix is an extension and "XXX" is the desired name.
100/126
28/10/2008
Documentation_eng.html
101/126
28/10/2008
Documentation_eng.html
function ext_xxx_showMain($idBlock, $title, $block_op) Shows the block in the CMS page. Taking one of the existing modules as example, it should be easy to code a new block. If you need to define some helper functions, you have to call them according to this standard: "ext_xxx_Yyy", where Yyy is the function name. If the helper functions can be used in different parts of the application (for instance, when rendering the block), it is suggested to put them in a specific file inside the same directory called "functions.php". If you want to define a class instead of functions, it is suggested to call the file in this way: "class.ext_xxx_yyy.php" and call the class "ext_xxx_yyy", where "yyy" is the object name. Rendering block subpages: Some blocks only show a single content, as the "Menu" block, while others can also show subpages. To manage subpages it is required to add in the same directory an "index.php" file, to contain the code that handles the subpage selection, executing the corresponding function. It is possible to take the "news" block as an example to code a new block. If you need to define some helper functions, you have to call them according to this standard: "ext_xxx_Yyy", where Yyy is the function name. It is advised to create helper functions that can be called by the main page ("block.ext_xxx.php" file) or by subpages ("index.php" file) and group them inside the "functions.php" file. Language keys definition: Each fixed text that has to be shown by the pages should be defined as a language key. Acting this way eases the translation to other languages. New language keys have to be defined inside the "CMS" platform and the new module. If the messages are already present as language keys, to avoid conflicts with future Docebo updates, it is always suggested to create new keys. CSS styles definition: If the new block requires some new CSS style definitions, it is suggested to name them according the convention: ext_xxx_yyy, where "xxx" is the name of the module that uses them and "yyy" is the style name.
102/126
28/10/2008
Documentation_eng.html
What is a REST API Representational state transfer (REST) is a style of software architecture for distributed hypermedia systems such as the World Wide Web. The terms representational state transfer and REST were introduced in 2000 in the doctoral dissertation of Roy Fielding, one of the principal authors of the Hypertext Transfer Protocol (HTTP) specification. The terms have since come into widespread use in the networking community. REST strictly refers to a collection of network architecture principles which outline how resources are defined and addressed. The term is often used in a looser sense to describe any simple interface which transmits domain-specific data over HTTP without an additional messaging layer such as SOAP or session tracking via HTTP cookies. These two meanings can conflict as well as overlap. It is possible to design any large software system in accordance with Fieldings REST architectural style without using HTTP and without interacting with the World Wide Web. It is also possible to design simple XML+HTTP interfaces which do not conform to REST principles, and instead follow a model of remote procedure call. The difference between the uses of the term REST therefore causes some confusion in technical discussions. Systems which follow Fieldings REST principles are often referred to as RESTful.
How REST API are implemented in Docebo Docebo doesn't implements a strictly RESTful paradigm but it's more REST-like, since it supports either stateless connection either stateful (it depends on the Docebo configuration). To access Docebo's resources you need to be authenticated on the server, two ways are provided for authentication: fixed code (stateless connection): in this case in every request you make to the API, you need to pass an additional parameter with a code predefined in Docebo's configuration. User's identity is not known. generated token (stateful connection): in this case before making any request to the API, you first need to authenticate on the platform with your Docebo's username and password. Then you will receive a token, which validity is time-limited (time limit depends on Docebo's configuration). After that you need to pass the token as additional parameter in every request to the API. User's identity is known. When token expires, you need to reauthenticate generating a new token. To access a module you need to use a URL formatted in this way <root url>/restAPI/<module>/<module function>[/<additional parameters>][.<output format>][!<call method>] Legend: <root url>: the base url of the docebo installation. <module>: the module you are referring in your request. <module function>: specify the function of the module. <additional parameters>: optional parameters in the url (in the form: "/param-1/param-2/.../param-n" ). <output format>: optional, the format of the data you will receive as output (at the moment are supported XML and JSON formats). Default: XML. <call method>: optional, you may force the request to use a different call method then the real one you are using to send request. It works only if you are using a POST request (you may specify then GET, PUT or DELETE).
Examples with mod_rewrite enabled and configured : http://<host URL>/restAPI/<module>/<function> without mod_rewrite enabled and configured : http://<host URL>/doceboCore/rest.php?q=/restAPI/<module>/<function>
103/126
28/10/2008
Documentation_eng.html
104/126
28/10/2008
Documentation_eng.html
getauthmethod
Description: A call to this function will return the autentication method configured in the Docebo installation.
Method: GET
Parameters: ( none )
Output examples:
XML: <?xml version=1.0 encoding=UTF-8 ?> <XMLoutput> <auth_mode>SINGLE_CODE</auth_mode> </XMLoutput> JSON: {auth_mode:SINGLE_CODE}
105/126
28/10/2008
Documentation_eng.html
authenticate
Description: When the server is configured in "generated-token" authentication, you need to call this function to get a token.
Method: POST
Parameters: Name username password Method POST POST Description passed dobebo user's username passed dobebo user's password
Output examples: XML: <?xml version=1.0 encoding=UTF-8 ?> <XMLoutput> <success>true</success> <message>You are authenticated.</message> <token>9u579hfbxo3984hg83028fhbw</token> <expire_at>2008-10-11 13:28:36</expire_at> </XMLoutput> JSON: {success:true,message:You are authenticated.,token: 9u579hfbxo3984hg83028fhbw,expire_at: 2008-10-11 13:28:36}
106/126
28/10/2008
Documentation_eng.html
userslist
Description: Returns a list of all the users registered on the Docebo platform, with userid, #id, first name and last name;
Output examples: XML: <?xml version=1.0 encoding=UTF-8 ?> <XMLoutput> <element> <userid>luigiverdi</userid> <idst>1065</idst> <firstname>Luigi</firstname> <lastname>Verdi</lastname> </element> <element> <userid>mariorossi</userid> <idst>1987</idst> <firstname>Mario</firstname> <lastname>Rossi</lastname> </element> {} </XMLoutput> JSON: [{userid:luigiverdi,idst:1065,firstname:Luigi,lastname:Verdi}, {userid:mariorossi,idst:1987,firstname:Mario,lastname:Rossi}, ( )]
Notes: None.
107/126
28/10/2008
Documentation_eng.html
userdetails
Description: Returns the description (also additional custom fields) of a single user by his #id.
Parameters: Name Method Description <idst> <URLparam> Idst of the needed user
Output examples: XML: <?xml version=1.0 encoding=UTF-8 ?> <XMLoutput> <idst>2865</idst> <userid>johnsmith</userid> <firstname>John</firstname> <lastname>Smith</lastname> <email>[email protected]</email> <signature></signature> <valid>true</valid> <pwd_expire_at>2008-10-11 12:00:00</pwd_expire_at> <register_date>2007-04-06 12:43:11</register_date> <last_enter>2008-09-23 18:50:12</last_enter> <custom_fields> <element> <name>MSN contact</name> <value>[email protected]</value> </element> { other element tags } </custom_fields> </XMLoutput> JSON: {idst:2865,userid:johnsmith,firstname:John,lastname:Smith,email:[email protected],signature:,valid:true,pwd_expire_at: 2008-10-11 12:00:00,register_date: 2007-04-06 12:43:11,last_enter: 2008-09-23 18:50:12,custom_fields:[{name:MSN contact,value:[email protected]}, ()]}
Notes: custom fields are variable and depends on user assigned fields in the platform.
108/126
28/10/2008
Documentation_eng.html
customfields
Description: Returns a list of all the custom fields set on the Docebo platform, with fieldid and field name.
Parameters: Name auth langcode* Method GET / POST <URLparam> Description authentication code field name translation language (optional)
Output examples: XML: <?xml version=1.0 encoding=UTF-8 ?> <XMLoutput> <element> <id>4</id> <name>MSN contact</name> </element> <element> <id>11</id> <name>Company</name> </element> {} </XMLoutput> JSON: [{id:4,name:MSN contact},{id:11,name:Company},()]
109/126
28/10/2008
Documentation_eng.html
createuser
Description: create a new user specifying user data by input.
Parameters: Name <idst>* userid firstname lastname password email signature Method Description POST POST POST POST POST POST POST Force manual id assignment (optional).
pwd_expire_at POST
Output examples: XML: <?xml version=1.0 encoding=UTF-8 ?> <XMLoutput> <success>true</success> <message>User has been created successfully.</message> </XMLoutput> JSON: {success:true,message:User has been created successfully.}
110/126
28/10/2008
Documentation_eng.html
updateuser
Description: change an users data.
Parameters: Name idst userid Method POST Description <URLparam> / POST Idst of the user to change.
fistname POST lastname POST password POST email POST signature POST last_enter POST valid POST
Output examples: XML: <?xml version=1.0 encoding=UTF-8 ?> <XMLoutput> <success>true</success> <message>User has been updated successfully.</message> </XMLoutput> JSON: {success:true,message:User has been updated successfully.}
111/126
28/10/2008
Documentation_eng.html
deleteuser
Description: delete an user.
Parameters: Name Method idst Description <URLparam> / POST Idst of teh user to delete
Output examples: XML: <?xml version=1.0 encoding=UTF-8 ?> <XMLoutput> <success>true</success> <message>User has been deleted successfully.</message> </XMLoutput> JSON: {success:true,message:User has been deleted successfully.}
112/126
28/10/2008
Documentation_eng.html
As we saw previously, SCORM hasn't any particular closed format. Any type of file can be a learning object, on condition that the object can communicate with the LMS or it is a support-object that doesn't communicate with the E-Learning platform. Comparison table between file format File format Word, Excel, Powerpoint Html Flash Java Pdf Audio (Ex. Mp3) Video (Ex. Avi, Real video) Smil Flash Video X X X X X X X X Trackable Not trackable X
113/126
28/10/2008
Documentation_eng.html
Scorm Glossary
Integrated standards: - IMS (Navigation and catalogation) - AICC (Sequencing and RTE) - IEEE Official website is http://www.adlnet.org, elements included in the standard are: The scorm package Scorm and Assets organized and sequenced. The package format is a .zip or a .pif (seems to be a .zip renamed). Inside the scorm package, in the main directory, is MANDATORY that a manifest file is present and must be named imsmanifest.xml Sco's e gli asset The sco's have specific functions that allow the object to "talk" (send and receive data-instructions) from/to the Learning Manager, the asset are support object that don't have capabilities to talk with the LMS. All this objects (and also the molecular part that compose it) are called "resources". L'IMS Manifest Is the Index file that contain information regarding: - Resources included in the scorm package - Resources destination (if are treated as sco's or asset) - The organizations (different way for using/navigatig a certain course) - The metadata, fields description of the total package, the organization or the sco's/asset) Sco's status and specific call The system can receive and send to the LMS some "staus" regarding the learning object and student's activity. The Scorm Standard use lot of description keys, we analyze, only for general purpose, only the most used: cmi.core.lesson_status is the scorm call that send to the LMS the status of the Object, status have the following values: completed incomplete not attempted failed passed cmi.core.session_time send to the LMS the time occured for this session cmi.core.student_name call the student name from the LMs
114/126
28/10/2008
Documentation_eng.html
115/126
28/10/2008
Documentation_eng.html
116/126
28/10/2008
Documentation_eng.html
Now we can create a botton that close the object with the javascript instruction finish();
117/126
28/10/2008
Documentation_eng.html
After clicking "publish" these are the e-learning scorm output properties:
118/126
28/10/2008
Documentation_eng.html
119/126
28/10/2008
Documentation_eng.html
After you have created your content you can publish it with this function:
120/126
28/10/2008
Documentation_eng.html
121/126
28/10/2008
Documentation_eng.html
122/126
28/10/2008
Documentation_eng.html
4) After this operation put the main files (in our example are the HTML and not the SWF that are considered dipendent from the html) inside the resources and marke it as SCO (for default are marked as ASSET 5) After you have populated the resource area you can create the 2 organization named at the start of this tutorial ("free" and "locked"), please don't use symbols and special chars for item and organizations name.
123/126
28/10/2008
Documentation_eng.html
124/126
28/10/2008
Documentation_eng.html
After you have uploaded the scorm package you will see all the organization contained , generally you have a single organization.
Clicking on the icon with the lens or (only if student) on the organization name you will see the scorm object player and the learning object.
125/126
28/10/2008
Documentation_eng.html
126/126