create_an_interactive_e-learning_template
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
create_an_interactive_e-learning_template [2017/07/29 21:51] – [How to track users watching an awareness video] lucy | create_an_interactive_e-learning_template [2021/04/30 11:38] (current) – [Advanced functions] lucy | ||
---|---|---|---|
Line 19: | Line 19: | ||
**How to configure the quiz?** | **How to configure the quiz?** | ||
- | **Step 1 - Enable the Quiz Feature**: First of all, in order to enable quiz answers tracking, you should set a “Quiz” checkbox for awareness template you are working on. There are two places where you can enable it: | + | **Step 1 - Enable the Quiz Feature**: First of all, in order to enable quiz answers tracking, you should set a “Quiz” checkbox for the awareness template you are working on. There are two places where you can enable it: |
a) If you are working on an awareness template in the awareness template section then click here (see pic) | a) If you are working on an awareness template in the awareness template section then click here (see pic) | ||
Line 27: | Line 27: | ||
b) If you are working on an awareness website within a campaign then click here (see pic) | b) If you are working on an awareness website within a campaign then click here (see pic) | ||
- | {{ q2.png?600 }} | + | {{ :: |
Lucy then will automatically inject a JavaScript called /js/quiz.js to your template, making quiz-‐related functions available | Lucy then will automatically inject a JavaScript called /js/quiz.js to your template, making quiz-‐related functions available | ||
Line 36: | Line 36: | ||
a) lucyQuizStart(): | a) lucyQuizStart(): | ||
+ | |||
+ | :!: **Attention!** Calling function lucyQuizStart() resets the current quiz progress. If the user starts the quiz from the beginning, then the previous results will be reset. To prohibit passing the quiz several times, you should enable option ' | ||
b) lucyQuizAnswer(question, | b) lucyQuizAnswer(question, | ||
- | * question | + | * question |
- | * correct –correctness of the answer (boolean) | + | * correct – the correctness of the answer (boolean) |
In HTML code this might look as the following screenshot: | In HTML code this might look as the following screenshot: | ||
Line 48: | Line 50: | ||
===== How to track users watching an awareness video ===== | ===== How to track users watching an awareness video ===== | ||
- | **Method | + | When using an awareness training video in LUCY one can consider it useful to track down the number of users that have played the video after receiving the awareness training email or after redirect to the awareness website. Some statistics regarding the average time of the video being played by recipients might also be useful in terms of awareness campaign effectiveness assessment and personnel training productivity. |
+ | |||
+ | LUCY allows you to verify if a training video was played. The video-tracking statistics are not personified and are displayed as a general chart in the report (PDF \ DOCX \ HTML) and on the statistics page. Once a recipient finished watching the video he should be marked as " | ||
+ | |||
+ | To find more information regarding this feature, please, consult this [[video_tracking|chapter]]. | ||
+ | |||
+ | |||
+ | ===== Extended method of tracking the end of the quiz ===== | ||
+ | |||
+ | Starting with version Lucy 4.6, there is a new option called “Use extended method of tracking the end of the quiz”, which is designed to track when the user finishes the quiz. The option is available on the Awareness Template editing page: | ||
+ | |||
+ | {{ :: | ||
+ | |||
+ | Default state: disabled. | ||
+ | |||
+ | In order for this method to work, you will need to add a call to an additional function "**lucyQuizEnd()**" | ||
+ | |||
+ | :!: Attention! Enabling this option without calling the " | ||
+ | By default, Lucy marks each recipient as " | ||
+ | |||
+ | ==== An example of usage the function lucyQuizEnd() in awareness training ==== | ||
+ | |||
+ | Using the awareness template " | ||
+ | |||
+ | Add a new variable " | ||
+ | |||
+ | < | ||
+ | var correctAnswersCount = 0; | ||
+ | </ | ||
+ | |||
+ | {{ :: | ||
+ | |||
+ | Find the place in the code where function lucyQuizAnswer is called and insert a call of the function lucyQuizEnd after it with the condition as shown below. | ||
+ | |||
+ | < | ||
+ | correctAnswersCount++; | ||
+ | if (correctAnswersCount >= 5) { | ||
+ | lucyQuizEnd(); | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | {{ :: | ||
+ | |||
+ | Save the template and run the campaign. After 5 quiz questions are answered correctly, the recipient will be marked as " | ||
+ | |||
+ | :!: **Attention**. Using the function // | ||
+ | |||
+ | ===== Advanced functions | ||
+ | |||
+ | Since version 4.7.7, Lucy comes with few additional functions: | ||
+ | |||
+ | **lucyQuizStart (quizNumber, | ||
+ | * // | ||
+ | * // | ||
+ | * // | ||
+ | |||
+ | **lucySetVariable (varName, varValue, errorHandler)** - permanently saves some text data for the current user. Parameters: \\ | ||
+ | * //varName// - variable name (text, max length: 255) \\ | ||
+ | * // | ||
+ | * // | ||
+ | |||
+ | **lucyGetVariable(varName, | ||
+ | * //varName// - variable name (text, max length: 255) \\ | ||
+ | * // | ||
+ | * // | ||
+ | |||
+ | Example response: | ||
+ | |||
+ | < | ||
+ | { | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | Since version 4.8.1, Lucy comes with a new additional function: | ||
+ | |||
+ | **lucyQuizResults(quizNumber, | ||
+ | | ||
+ | | ||
+ | * // | ||
+ | |||
+ | Example response: | ||
+ | |||
+ | < | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ... | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
- | This method allows you only to verify, if the video was played. It does not allow tracking of the video lenght. Please use method 2 to track more details. | + | To illustrate how these new functions work, please download and restore a sample of awareness template (Advanced Quiz Functions) by the link: {{ :: |
- | * Mark the awareness template or website as " | + | ===== How to customize a logo ===== |
- | {{ quiz_enabled_c.png?600 }} | + | 1. Choose the **Upload File or Image** button or double click on the picture you would like to replace with a custom logo: |
- | * Make sure your awareness website (or template) has the quiz-question-titles.js static file with the following content: | + | {{::contentlogo.png|}} |
- | * Add " | + | |
- | <body onload=" | + | 2. Open **Image Properties** and within the **Image Info** tab click on the **Browse Server** button in order to access a [[file_browser|File manager]]: |
- | * Add " | + | {{:: |
- | <video onplay=" | + | 3. Within the [[file_browser|File manager]] press the **Upload** button or simply drag & drop the required file. In order to select the file double click on it: |
+ | {{:: | ||
- | **Method 2: using the video tracking JavaScript** | + | 4. After the image has been linked to the website you can adapt the size of the picture within the **Image Properties**: |
- | Using our custom tracking JavaScript which can be downloaded | + | {{::sizeadaptation.png|}} |
- | {{ video_tracking_new.png?600 }} | + | 5. Save the changes. |
- | This script allows you to track a video start and finish event and also display the progress in statistics (rounded percent in different event types like video-10 for 10% video played or video-90 for 90% video played, etc.). When the video is started, it sends a " | + | ===== Troubleshooting ===== |
- | {{ video_stats_sample.png?600 }} | + | __Issue.__ Lucy marks the recipients as ' |
+ | __Solution__: | ||
+ | __Issue.__ Lucy does not mark the recipients as ' | ||
+ | __Solution__: |
create_an_interactive_e-learning_template.1501357907.txt.gz · Last modified: 2019/07/25 12:52 (external edit)