Installation

This guide will walk you through fully installing SmarterID into your Moodle instance. There are four main sections to the installation which will take on average about 20 minutes to fully complete.

Obtain SmarterID LTI Keys

SmarterID LTI keys can be obtained via the SmarterID administrative area, to login to your account and locate your keys please follow these steps:

1. Navigate to your SmarterID administrative area in your browser. Your SmarterID administrator was provided your account special administrative area URL. If you do not have this information please contact them.
2. Enter your username and password and click Login.
3. Once logged in, click Settings in the upper right, then click Integration Settings.
   
4. Find the integration that you need to update, typically there will only be one integration. Then in the Actions menu, select Integration settings. This will drawer open the settings form, you will use the information on this form in subsequent steps below.

When moving to the next section, please open a new tab or browser window so you can easily reference the SmarterID integration settings when prompted to.

Install Javascript Snippet

SmarterID requires the LMS to have a snippet of Javascript on all pages so it can seamlessly communicate with the underlying identity service. This snippet of Javascript is very similar to what is used when embedding Google Maps or other embeddable services into web applications. Follow the steps below to complete the installation of the snippet into your Moodle environment.

1. Click the Site administration menu option
   
2. Click the Appearance tab.
   
3. Click the Additional HTML option.
   
4. Locate the field entitled Before BODY is closed. Paste the following snippet of code within that field. Ensure the placeholder for the deploymentSid is modified and set with the deploymentSid provided by SmarterID. You can find your deploymentSid from the integration settings page within the SmarterID administration area (see section above for how to access).
   
   
   

   Once complete, the field will look similar to the following: 

   

5. Click the Save Changes button.

Configure the External Service

External services can be added to individual courses or to all courses in an institution. The scope of your SmarterID implementation will dictate how you create these links. The process for adding the links to course is virtually the same regardless of method. It's much easier if you setup the external service in the site administration first.

1. Click the Site administration menu option.
   
2. Click on the Plugins tab.
   
3. Scroll to the Webservices section and click External services.
   
4. Under the Custom services section, click the Add link.
   
5. Complete this form using the following information:         
   1. Name: SmarterID
   2. Enabled: checked
   3. Click Add service
      
6. The "Add functions to the service" page will then appear, click Add functions.
   
7. The following functions will need to be added, once they have been selected click the Add functions button.  
   Note: all functions that are required are READ-ONLY. SmarterID does not require the ability to access any API functions that allow writing or making changes to the LMS.
   1. core_course_get_contents
   2. core_course_get_courses
   3. core_user_get_users
   4. core_enrol_get_enrolled_users
   5. core_user_get_course_user_profiles
   6. core_webservice_get_site_info
   7. mod_lti_get_ltis_by_courses 
8. From the breadcrumb menu, click the Web services link.
   
9. Click the Enable protocols link.
   
10. Ensure that the REST protocol is marked to enabled. If the eye is closed, then click it to open the eye. Next, click Save changes. If the eye is already open, you may skip this step.
    
11. From the breadcrumb menu, click the Web services link.
    
12. Click the Create a specific user link to setup a service user that will be used for the SmarterID integration.
    
13. Complete the user creation form. We suggest entering the following, however the user can be setup however makes the most sense for you organization.         
    1. Username: SmarterID
    2. New Password: manually enter a suitable password 
    3. First name, Surname, and Email address: enter whatever is suitable here, maybe the SmarterID product owner in your organization.
    4. Click Create user.
       
14. Navigate back to the Web services area by clicking Site Administration > Plugins > Web services.
15. Click the Create a token for a user link.
    
16. Complete the token creation form based on the following:         
    1. User: Select the service user that was created in step 13.
    2. Service: Select the service that was created in step 5.
    3. Click Save changes.
       
17. Return back to the SmarterID administration tab or browser window from the initial section above.
18. Copy the Token for the new user and paste it in the Token field within the SmarterID integration settings.
    
19. Click Save on the SmarterID integration settings form.
    

Providing the User Proper Permissions

The service user that was setup in the previous step will need to have access to all the courses that SmarterID will be used. It is suggested that the user be either set with admin privileges or be enrolled automatically into each course. This is required so the service user can get course information via the Moodle API.

Configure as Site Administrator

1. Click the Site administration menu option.
   
2. Click on the Users tab.
   
3. In the Permissions section, click the Site administrators link
   
4. In the list of Potential Users, find the SmarterID Service user (or the user name you setup in the last step) and click on it and click the Add button/link.
   
5. When prompted to confirm, click the Continue button.
   

This process granted the service user the ability to view the content in all courses which will allow SmarterID to function properly.

Configure the External Tool

1. Click the Site administration menu option.
   
2. Click on the Plugins tab.
   
3. Scroll down to the Activity modules section and click Manage tools.
   
4. Click the Configure a tool manually link.
   
5. Complete the External tool configuration form as follows:         
   1. Tool name: SmarterID
   2. Tool URL: Launch URL provided on the SmarterID integration settings page.
   3. Tool Description:  Any description can be added here to help describe SmarterID to your students.
   4. Consumer key: Consumer key provided on the SmarterID integration settings page.
   5. Shared secret: Secret provided on the SmarterID integration settings page.
   6. Custom parameters: Add the custom parameter value of consumer_sid=CNa7ac5bcd5bf84d73a0214e8d8c3ca754. Do not include the quotes.
   7. Tool configuration usage: Select the option here that fits your organization the best.
   8. Default launch container: Select the option here that fits your organization the best. We suggest "Embed, without blocks"
   9. Content-Item Message: unchecked
   10. Share launcher's name with tool: Always
   11. Share launchers email with tool: Always
   12. Accept grades from the tool: Never
   13. Force SSL: checked
   14. Click Save changes.
6. At this point the tool should be showing as a registered and active tool
   
   

Adding SmarterID to a Course

Once the External Tool has been created, then it can be added to a course's content. This section will walk-through placing a SmarterID link in a course.

1. Navigate to the course dashboard.
2. Click an Add an activity or resource link.
   
3. Select External Tool, and then click the Add button.
   
4. You will need to complete the form using the following settings:
          
   1. Activity Name: SmarterID (the name must be exactly this)
   2. Preconfigured tool: SmarterID
   3. You may also change the Activity Description and check any of the Display checkboxes.
5. Click the Save and display button.
   
6. SmarterID will launch.