Working with Modules

Workflow for the end-user

Example work flow for a teacher using a Module (ModuleX) that has been embedded into the top menu of itslearning.

  1. In the top menu of itslearning the teacher clicks on the ‘ModuleX' menu item.

  2. The 'ModuleX' web application appears in the content frame below the itslearning main menu.

  3. The teacher can navigate and use the ModuleX web pages.

  4. When the teacher wants to access pages in itslearning he clicks the top menu navigation.

Workflow behind the scenes

  1. In the top menu of itslearning the teacher clicks on the ‘ModuleX’ menu item.

    1. Itslearning calls the agreed 'ModuleX' web application URL passing extension parameters.

      The 'ModuleX' web application decodes the parameters, using the shared secret to ensure they are genuine.

      The 'ModuleX' web application has access to the user’s name and ID, but may need more information on the user. If so, the 'ModuleX' Web app calls the REST API to get detailed information on the user – such as their SyncKey. See Rest API

  2. The 'ModuleX' application appears in the content frame below the itslearning main menu

  3. The teacher can navigate and use the ModuleX web pages.

  4. When the teacher wants to access pages in itslearning they click the top menu navigation.

Setting up a Module extension as a customer

In itslearning, site and organisation administrators can manage Modules.

  • Site administrators can manage Modules for any user group and hierarchy within the site

  • Organisation administrators can only manage Modules for the users within the hierarchies they have access to

How to manage a Module

  • Go to Home > Administration > Manage apps > Manage menus and select 'Add module'

  • Select for which organisation/hierarchy within your site the Module web application should be visible

  • Select which section (Administration menu, Top menu, Supervisor menu, Course menu, Assessment record, ePortfolio menu) your Module web application should be visible

  • Select which user groups (Aministrators, Teacher, Students, Guests, Mentor, Headteacher) should have access to your Module web application.

    User group

    Condition

    Administrator

    User must have role in hierarchy = Administrator in selected site/organisation/hierarchy

    Teacher

    User must have role in hierarchy = Teacher in selected site/organisation/hierarchy

    Student

    User must have role in hierarchy = Student in selected site/organisation/hierarchy

    Guest

    User must have role in hierarchy = Guest in selected site/organisation/hierarchy

    Mentor

    User must have role = Mentor in selected site/organisation/hierarchy

    Headteacher

    User must have role = Headteacher in selected site/organisation/hierarchy

images/download/attachments/9995189/Module_AddModule.png

Module extension menu placement options

Administration menu

The following user groups can be set up to have access to Module in the Administration menu:

    • Administrators

    • Teachers

    Modules will appear at the bottom of the main administration block, in alphabetic order. If a user has multiple access to the same Module, only one instance is shown in the list:

    images/download/attachments/9995189/Module_AdminMenu.png

    Top menu

    The following user groups can be set up to have access to Module in the Administration menu:

      • Administrators

      • Teachers

      • Students

      • Guests

    Modules will appear in the top menu on the right side in alphabetic order. If a user has multiple accesses to the same Module, only one instance of the Module will be shown. Only the first 20 characters of the titles will shown.

    images/download/attachments/9995189/Module_TopMenu1.png

    If there is no space to list the modules in the top menu, the Modules will be shown in the 'More' drop down box, in alphabetic order:

    images/download/attachments/9995189/Module_TopMenu2.png

    Supervisor menu

    The following user groups can be set up to have access to Modules in the Supervisor menu:

      • Mentor

      • Headteacher

    If the user is a mentor, the Modules will appear in Mentor menu on the bottom of the ‘Manage my group’ list, in alphabetic order.

    If the user is a headteacher, the Modules will appear in Headteacher menu on the bottom of the ‘Manage my organisation’ list, in alphabetic order.

    If the user is both mentor and headteacher, the Modules will appear in the Supervisor menu on the bottom of ‘Manage my group’ and/or the ‘Manage my organisation ‘ list, in alphabetic order.

    If a user has multiple access to the same Modules, only one instance is shown in the list:

    images/download/attachments/9995189/Module_SupervisorMenu.png

    Course menu

    The following user groups can be set up to have access to Modules in the Course menu:

    • Administrators

    • Teachers

    • Students

    • Guests

    Modules will appear in course menu and the bottom of the ‘Status and follow-up’ list, in alphabetic order. If a user has multiple access to the same Module, only one instance is shown in the list:

    images/download/attachments/9995189/Module_CourseMenu.png

    Assessment record

    The following user groups can be set up to have access to Modules in the Assessment record:

    • Administrators

    • Teachers

    Modules will appear in assessment record, in alphabetic order. If a user has multiple access to the same Module, only one instance is shown in the list:

    images/download/attachments/9995189/1.png

    ePortfolio menu

    The following user groups can be set up to have access to Modules in the ePortfolio menu:

      • Administrators

      • Teachers

      • Students

      • Guests

      Modules will appear in ePortfolio menu and the bottom of the ‘Content’ list, in alphabetic order. If a user has multiple access to the same Module, only one instance is shown in the list:

      images/download/attachments/9995189/Module_ePortfolioMenu.png

      Open the Module internal page from external pages (deep linking)

      Itslearning has an endpoint to open a Module extension internal page. This URL can be used anywhere (for notifications, external systems, any place in itslearning). When user opens this link, itslearning shows the Module extension with a specific internal page if this is supported by the Module.

      /ExtensionModule/ExtensionModuleRedirect.aspx?client_id={ExtensionModuleApplicationKey}&launch_parameters={ExtensionModuleLaunchParameters}

      Parameters

      Description

      client_id

      The application key of your Module

      launch_parameters

      The launch parameters that sends to the Extension Module and add possibility for open the specific content of this Module.

      Personalising data displayed in the Module web application

      In order for the Module web application to show specific user data, there must be an agreed common identifier or other way to uniquely identify the user between system. If a MIS/SIS creates users in itslearning, they can sign an unique 'SyncKey' to each user. This identifies the user to both itslearning and the external system.

      Using the itslearning REST API for plugins, the Module web application can get access to more detailed information on the user who has called the application (like synckey, email and other unique data). The itslearning REST-based services are protected via OAuth.

      See also Best practices, tips and tricks on how to grant access to extended data..