Differences

This shows you the differences between two versions of the page.

--- training_library [2019/11/21 09:33] – [Creating references to courses within the library] lucy
+++ training_library [2021/10/18 15:16] (current) – [Setting up the template] lucysecurity
@@ Line 1: / Line 1: @@
-====== Training Library ======
+====== Library setup ======
-===== Introduction =====
+===== Setting up the template =====
+Go to the settings -> Templates -> Awareness templates ->
+Edit the library
+{{ :edit_aw_temp.png?600 |}}
-The training library should give employees the opportunity to download their training content from an overview page called "training library". The large selection of regular e-learning templates in LUCY serves as learning input. The overview page can be sorted by certain topics (video, quiz, test etc.).
+Click "Library"
+Activate and Deactivate the "Select All" checkbox to deselect every default template in the Library.
+{{ :click_library.png?600 |}}
-===== Where to find the library? =====
+Now it is time to build your own library, activate every template you like for it to be in the library.
+In the example below, there are 7 templates activated.
-The library is located under the awareness templates.
+The next step is to go to the "Content Template" and to edit //static/templates/init.js//
+Make sure that the template names have correct names.
+The characters should match the names of the templates.
+In another case, a template with mismatching will not be visible in the Library.
+For example, the following names are not the same: \\
+//01 Mobilgeräten\\
+Mobilgeraten//
-{{ library_s.png?600 }}
+Spaces are also important.
-===== Creating references to courses within the library =====
+{{ :edit_initjs.png?600 |}}
-**Instruction (Items 1-4 should be performed inside the campaign)**
-  - Go to the template, click the Library button;
-  - Set the checkboxes for the templates that will be used;
-  - Go to the Content Template, edit the file templates/init.js. The   template   name  in the file "templates/init.js" must match exactly  the  name  of the template on the LUCY server. Otherwise, the template  will not be found. If some template is renamed, then you need to make changes to the file "templates/init.js";
-  - If you want to change the images that get displayed in the library overview, you can upload images with a size of 675 x 497 pixels;
-  - Now the template can be used.
+It is possible to check the media files added to the Library.
+{{ :files_in_the_lib.png?600 |}}
-**Loop construction:**
+It can be seen that 7 "quiz-question-titles.js" are in the Library.
-  * %awareness-links-start% .. %awareness-links-end% — a block of links to awareness templates within the library
+These files contain the names of the questions. If the number of questions is incorrect, it can cause unreliable statistics in a campaign.
-  * %awareness-link% — a link to the particular template within the loop
-  * %awareness-title% — a title of the particular template within the loop
-Loop usage example:
+You can only experimentally determine which file belongs to which template.
-    %awareness-links-start%
+The easiest way to do this is:
-    <div class="awareness-link">
+execute step 4 (that is, delete all templates from the library)
-        <a href="%awareness-link%">%awareness-title%</a>
+  - Go to the "Edit" tab and click the "Save" button
-    </div>
+  - Go to the "Content Template" tab, delete all files "quiz-question-titles.js" and click the "Save" button (Note, that those quiz-quiestion-titles files would be there only in case the **Quiz** option is enabled for the template in the main edit setting. More details can be found [[https://wiki.lucysecurity.com/doku.php?id=create_an_interactive_e-learning_template#how_to_create_an_interactive_elearning_page|here]]).
-   %awareness-links-end%
+  - Go to the "Library" tab, add one template to the library, go to the "Edit" tab and click "Save"
+  - Go to the "Content Template" tab and edit the fresh file "quiz-question-titles.js". It will have a path "static/library/1/static/quiz-question-titles.js".
+  - Repeat steps 1 - 4 for any other templates you want to add to the library. The path of the next "quiz-question-titles.js" will contain "2", then "3" and so on.
+ {{ :files_in_the_lib2.png?600 |}}
-Also, you may use the following direct library links in the template (please note that the names may change):
+===== Creating a campaign =====
-  * %awareness5% — General Data Protection Regulation (GDPR)
+We recommend using Wizard since it is quite convenient.
-  * %awareness24% — Physical Security Course 1.2
+{{ :wzrd_for_lib.png?600 |}}
-  * %awareness26% — Quick Tips | One Pager Static Page (Version 2.2)
-  * %awareness25% — Prevent Phishing Attacks: 5 Tips (Version 2.1)
-  * %awareness30% — Workplace Security Course
-  * %awareness10% — Mixed Awareness - Long Version 2.2
-  * %awareness11% — Mixed Awareness Template III (1.3)
-  * %awareness35% — Password Security Course (1.3)
-  * %awareness12% — Mixed Awareness Template IV (1.2)
-  * %awareness36% — Social Engineering Course
-  * %awareness1% — Avoid & Recognize Phishing Attacks (V 2.2)
-  * %awareness13% — Mixed eLearning (short | v.2.2)
-  * %awareness6% — General Security Awareness Course (V 2.3)
-  * %awareness7% — Identity Theft Security Course 1.3
-  * %awareness37% — WIFI Security Course
-  * %awareness14% — Mobile Security Awareness Course (2.3)
-  * %awareness39% — PCI Exam (Version 1.1)
-  * %awareness40% — Phishing Quiz I (Version 2.1)
-  * %awareness41% — Phishing Security Exam (Version 1.3)
-  * %awareness19% — PCI Security Course (Version 1.3)
-  * %awareness20% — PDF Infoflyer (1.1)
-  * %awareness21% — Phishing Quiz II (Version 2.1)
-  * %awareness46% — Mobile Security Awareness Video 1.2
-  * %awareness17% — One Pager Phishing Awareness (responsive | 1.2)
-  * %awareness50% — Ransomware Explainer Video 1.3
-  * %awareness58% — Game: Test your phishing know-how! (V 2.1)
-  * %awareness2% — Email Security Course (Version 2.2)
-  * %awareness59% — Game: Spot the phishing Scam! (V 2.1)
-  * %awareness48% — Social Engineering Video
-  * %awareness38% — Internet Security Exam 1.2
-  * %awareness43% — Email Security Video 1.3
-  * %awareness42% — Data Privacy & GDPR Video
-  * %awareness53% — Security Awareness Video: 7 Security Tips 1.3
-  * %awareness45% — Lucy Phishing Video (with Tracking Option) 1.1
-  * %awareness44% — Identity theft video
-  * %awareness54% — Security Awareness Video Library
-  * %awareness47% — Password Security Video 1.2
-  * %awareness52% — Secure social media usage video - SHORT
-  * %awareness55% — Social Engineering Video
-  * %awareness56% — WI-FI security video
-  * %awareness57% — Workplace Security Awareness Video
-  * %awareness51% — Secure Internet usage video 1.2
-  * %awareness49% — Physical Security Awareness Video 1.3
-Please note, that these links are not available in CSS and Javascript files.
+{{ :edct.png?600 |}}
+Next, follow the instructions on the screen, fill in the required fields.
+Using the wizard will help to avoid gross mistakes.
-===== Customization of navigation menu =====
+There is no need for additional settings if you used the wizard. However, there is the possibility of additional verification of the library configuration. See the following points:
-You can customize the navigation in the training library, for example, add a new entry "Security" to the menu: \\
+Go to "Awareness Settings", click on the button "Edit Awareness Settings" and go to "Website":
-\\
+{{ :website_lib.png?600 |}}
-. Go to the Settings menu > Awareness Templates; \\
-. Find the template "Awareness Training Library" (install it through the page "Download Templates", if missing) > click on "Edit"; \\
-. Within the section "Content Template" click on the "Source Code" button; \\
-. Add new line into the section "__nav nav-sidebar__": \\ \\ <code html><li class="li-security"><a class="a-menuitem a-security" href="#">Security</a></li></code> \\ \\ {{ training_library_idx.png?700 }} \\
-. Add the following lines of code into the section "__main-grids__": \\
-<code html>
-<div class="sect-info security">
-<h3>Security </h3>
-</div>
-<div class="sect-body security "></div>
-<div class="clearfix clear-sect security "></div>
-</code>
-{{ training_library_body.png?700 }}
+Here are all of the files included in the library:
+{{ :files_in_the_lib.png?600 |}}
-. Save the template by clicking "Save" button; \\
+For example, the image above shows the files related to the 2nd template.
-. Switch to the file "__static/js/actions.js__" and add the following code: \\
+You can see what this template is by opening the index.html file.
-<code java>
-if($(this).hasClass('a-security'))
-{
-showSection('security');
-return false;
-}
-</code>
-{{ training_library_action.png?700 }}
+Thus, if you want to edit the questions of the 2nd template, you need to open the 2nd file "quiz-question-titles.js":
-. Save the template. \\
+{{ :q_in_the_lib.png?600 |}}
-. Switch back to the file "__index.html__" and click on "__Preview__" button to check out the results:
+Check all of the "quiz-question-titles.js" files! It should have questions of the appropriate templates. If something is wrong, it is possible to fix these files right here.
-{{ training_library_result.png?700 }}
+===== Statistics =====
+In some time after the start of the campaign, statistics should appear.
+To check it, go to the Campaign -> Statistics -> Recipients and click on a user.
+{{ :john_stats.png?600 |}}
-===== Tracking which course gets started within the library =====
+It is possible to see that John has completed 2 trainings out of 7.
+Click on the training results to see the details.
-Please add a tracking event into a e-learning course used within the template. To send a LUCY an event that can determine which course was loaded, this function is used:
+{{ :details_on_training_results.png?600 |}}
-**lucyDispatchEvent(str);**
+===== Export Results =====
-"str" can be any string. Example:
+You can export results in two ways:
+"[[create_campaign_reports|Reports]]" -> button "New Report"
+{{ :select_this_option.png?600 |}}
-**lucyDispatchEvent("Course: This is your course name");**
+[[export_campaign_data|Exports]]
+{{ :exports_lib.png?600 |}}
-An  event  can  be  sent at any time. It can be loaded automatically when the user starts the course or you could associate such an event with the click of a button.
-**Button example:**
-In order to associate an event with a button, you can do this within the HTML code:
-Button Example 1
-  <button onclick="lucyDispatchEvent('some string')"> Some button </button>
-Button Example 2:
-  <button onclick="buttonfunc()">
-  Some button
-  </button>
-  <script>
-  function buttonfunc()
-  {
-  lucyDispatchEvent('some string');
-  }
-  </script>
-**Automatic Start Example** (in this example an notification about the course name that gets started is sent automatically to LUCY upon opening of the first page). Please insert this script into the index.html page (can be in header or body. It is important to insert it before the body close tag (/body>).
-  <script>
-  $(function () {
-  lucyDispatchEvent("Course: your_course_name started"); });
-  </script>
-jQuery requirements: In most templates, jQuery is already connected.
-If  a  line  like the examples below is already in the index.html file, then nothing else needs to be done. Look for:
-  <script src="%static%/jquery-1.11.3.min.js"></script>
-or
-  <script src="https://code.jquery.com/jquery-1.12.4.min.js"></script>
-If you dont have jQuery in the template, you can use those versions:
-  * jquery-1.11.3.min.js
-  * jquery.js
-  * jquery-2.4.min.js
-All those version can be downloaded from here:
-https://jquery.com/download/
-**Statistics in Training Library**
-Statistics of visits and completed quizzes in the Training Library can be found in Campaign>Statistics>Awareness training:
-{{:train_lib_1.png?600|}}
-You can check the statistics for all quizzes or for an individual quiz:
-{{:train_lib_2.png?600|}}
-{{:train_lib_3.png?600|}}