LMS 365 Quiz Builder Add-in Installation Guide Version 2.3
CONTENTS OVERVIEW AND SOFTWARE REQUIREMENTS... 3 AUDIENCE... 3 ABOUT THE ADD-IN... 3 SERVER SOFTWARE REQUIREMENTS... 3 CLIENT REQUIREMENTS... 3 INSTALLING THE ADD-IN... 4 INSTALLING THE WEB PART... 11 SETTING THE ADMINISTRATOR PERMISSIONS... 12 ADDING AZURE AD GROUPS... 15 LICENSE INFORMATION... 16 TRIAL LICENSE... 16 ACTIVATE A LICENSE... 18 MANAGING ACTIVATED LICENSE... 22 UPDATE... 24 UNINSTALL... 25 1
OVERVIEW AND SOFTWARE REQUIREMENTS Audience This guide has been written for the System Administrator to install the Add-in and Web Parts and create a fully working solution including uploading a LMS365 Quiz Builder Add-in. For detailed information about configuring the Quiz Settings please consult the User Guide. About the Add-in The LMS365 Quiz Builder Add-in has been developed to run on Office 365 SharePoint Online Team Sites. The Add-in is not yet supported for SharePoint 2013 On Premise. The LMS365 Quiz Builder is a part of the LMS 365 suite of Learning Add-ins. Server software requirements The Add-in has been developed to run within the Microsoft Office 365 SharePoint 2013 Online environment. Client requirements A supported browser such as Internet Explorer 11 onwards. Recent versions of Chrome and Firefox are also supported. 3
INSTALLING THE ADD-IN NOTE: For the installation of the Add-in the user must have Site Collection Administrator rights. To install the add-in click Settings icon and select Add an App from the Menu as illustrated: Enter Quiz Builder Add-in in the Search Field and click Search: The Search Result will tell you it has found results in the SharePoint Store as shown in the next illustration: 4
Click the results link and you will be presented with the following screen. Click the LMS365 Quiz Builder icon: You will be presented with the following screen from where you can add the Add-in to your Site: 5
You will be asked to confirm that you wish to add the Add-in. Click Continue button to confirm: When you get the confirmation page you can click Return to site button: 6
You must click Trust It button to enable the Add-in to function properly: 7
You will now see the Add-in installed on your Team Site: When you run the add-in for the very first time, you will be required to select Tenant Region for LMS365 data storage. NOTE: If you have added the My Learning Modules Web Part to your site, you will see the following message: Go to the Administration Back-end and select necessary Region: 8
Then click Next button. You will presented with the following screen: From this page you can confirm the Tenant Region or go back to select another one. NOTE: Remember that you can select Region once only (i.e. if you have previously selected the Region, there will be no such a step for other add-ins). After you have selected the Region, it will be applied for all add-ins of LMS365 suite and could not be changed on your own 9
initiative (only by request). 10
INSTALLING THE WEB PART The LMS 365 Quiz Builder Add-in comes with a Web Part. The Web Part will provide the UI for users to view and complete Quizzes. To add the Web Part to a page, do the following actions: 1. Go to the page, to which you want to add the Web Part; 2. Enter the Edit mode (click the Edit button on the ribbon); 3. Go to the Insert tab in the ribbon menu and select Web Part, followed by My Learning Modules in LMS365 category, and then click Add button: 4. Click Save icon in the Menu to save the page: The page will now be saved and the Web Part will be added to the page. To create a new Quiz, click the Add / Edit / Manage link and select Quizzes: 11
SETTING THE ADMINISTRATOR PERMISSIONS To have access to the back-end Administration you have to be a member of the Site Owners Groups. If you are not, you will get the following error message: The name of your group will differ from the one on the image above. To add yourself to the Site Owners Group do the following: 1. Go to Site Settings by clicking Settings icon on the top right corner of your site: 2. Click People and groups link: 12
3. Select the Team Site Owners Group from the left menu and click Team Site Owners Group followed by New and Add Users: 4. Add the user(s) you want to be able to administer the LMS365 Quiz Builder Add-in: 13
By default an email invitation will be sent to the user(s). To disable this function click Show Options and uncheck Send an email invitation box. There may be a delay between adding yourself to the Group and the add-in allowing access. This is normal SharePoint behaviour and outside of our control. 14
ADDING AZURE AD GROUPS SharePoint Online allows adding Azure AD Group principals as site members. This great ability helps a lot, but there is no out of the box ability to get members of the Azure AD groups. It means that your Azure AD should be configured to trust our add-ins to be able to read members of Azure AD groups. To give the application permissions to read users data you need to run a PowerShell script as described in LMS365 Course Creator & Catalog Add-in Installation Guide. Running the script requires Tenant Administrator rights. 15
LICENSE INFORMATION Trial License The Free Add-in comes with a 30 day trial license included and number of users unlimited. There is no need to obtain a license during the trial period. To get access to the license information, go to the Administration Back-end, click License Information link in the Settings section of the sidebar, and then Quiz: NOTE: New administration center is available only if Course Creator & Catalog Add-in is also installed on the site. Otherwise, a stand-alone add-in is administered in the old administration center. To activate the Trial license, fill in the form and click Activate button: 16
Upon successful License activation a confirmation page will be displayed: To check the status of the license, go to the Administration Back-end, and click Quiz link under License Information link in the Settings section of the sidebar. The following information will be displayed on the License Information page: 17
Start Date shows start date of the trial period; End Date shows end date of the trial period; Current number of users shows current number of users (Learner group members in courses, Visitor group members in usual sites are counted. Only unique users are counted across each site where Add-in is added). Current number of users is counted for all sites of the tenant; NOTE: Deleted/disabled in AD users are not counted in current number of users. License Key field for entering license key. Activate a License If you have received a License Key from ELEARNINGFORCE you can add it in the License Key field and click on the Activate button: 18
Upon successful License activation a confirmation page will be displayed: After license activation, the following information will be displayed: 19
Start date shows start date of your license; End Date shows end date of your license; Max number of users shows maximum number of users allowed by your license. If maximum number of users was exceeded it is possible to delete users to meet the license limitations (delete Learner from a course or delete a member of Visitors group); Current number of users shows current number of users (Learner group members in courses, Visitors group members in usual sites are counted. Only unique users are counted across each site where Add-in is added). Current number of users is counted for all sites of the tenant; NOTE: Deleted/disabled in AD users are not counted in current number of users. License key shows last symbols of your license key. LMS365 Administrator will see the following message in the Administration Back-end when license has expired: 20
OR the following message when the maximum number of users was exceeded: NOTE: When maximum number of users has been reached or license has expired, you have 14 days period for handling license issues. During this period, the system does not stop working, only a warning (depending on what has happened) appears in the Administration Back-end: Learners could continue working with the LMS during the 14 days period. After 14 days period (if license issues have not been handled), Leaners will see the following message when trying to access the add-in: 21
Managing Activated License After you have activated License, you can specify e-mail notification settings. In Notifications section, you can specify whether to send e-mail notifications when maximum number of users is reached and/or number of days when license is about to expire and/or number of days after license is expired. In the first case, specify number of users in % (you can specify several number of days separated by comma; by default, 50 and 99 % are set), in the second, specify number of days before license expires (you can specify several number of days separated by comma; by default, 30, 14, 7, 1 days are set), and in the third case, specify number of days after license expires (you can specify several number of days separated by comma; by default, 0, 5, 10 days are set), and then choose user(s) who will receive notification: In the Reports section, you can specify users, which you want to delete from all sites where add-in is installed. To do this, specify the needed user(s) and then click Unenroll button: 22
To download user license report, in which all users that are counted in the license will be specified, click Export to Excel button. Information will be presented in the following form: 23
UPDATE The update of the LMS365 Quiz Builder Add-in is taken care of automatically via the Office Market Place. Within 24 hours after a new version has been released, a notification that an update is available will appear on Site Contents page. A link is provided to immediately install the update. The update is installed without first uninstalling the earlier version. The update infrastructure tests the update installation and rolls it back if there are any errors. For more information you can go to http://msdn.microsoft.com/en-us/library/office/dn265910.aspx 24
UNINSTALL Users who are members of Owners group can uninstall the Add-in. To uninstall the LMS365 Quiz Builder Add-in from your SharePoint site, do the following: 1. Click Settings icon and select Site contents from the Menu as illustrated: 2. Open the Add-in settings and select Remove: 25
3. Confirm the uninstall: The Add-in will be deleted from the site. The Web Part My Learning Modules will be deleted from all pages, to which it had been added. All Quizzes created within the Add-in will be removed, and information about the attempts will be deleted. 26