mods/basiclti/README.txt

   1 ##########################################
   2 # External Tools Module Readme file: #####
   3 ##########################################
   4 This is an alpha version of an ATutor Basic LTI Integration module.
   5
   6 It allows ATutor administrators and instructors to link external tools into ATutor, and to
   7 associate those tools with content as learning activities.
   8
   9 The current development source code is located at:
  10 http://svn.atutor.ca/repos/atutor/trunk/mods/basiclti/
  11
  12 More about the BasicLTI Standard
  13 http://www.imsglobal.org/lti/
  14
  15 Here are a couple videos with more information:
  16 http://www.vimeo.com/18074396
  17 http://vimeo.com/14100773
  18
  19 ######################
  20 # Intallation & Setup
  21 ######################
  22 1. Download the External Tools (BasicLTI TBD) Module from atutor.ca (or import it directly from atutor.ca via the Admin Module Manager if it's listed there)
  23 2. Follow the instructions presented by the module installer to install the module.
  24 3. Once installed, enable the module where it is listed in the Module Manager. This will create an External Tools Tab from where BasicLTI compatible external tools can be managed.
  25
  26 Setup A New External Tool (Administrator)
  27 1. Title:  Enter a name for the tool being created in the title field
  28 2. ToolID: Create an ID for the tool that will be unique across all tools on the system (e.g. demo_tool.ocadu.ca) any unique string will do
  29 3. Description: Describe the tool, its function, and how it might be used.
  30 4. Tool Launch URL: Copy the URL of the tool's BasicLTI launch location. Ensure there is no space at the end of the URL (see the Sample LTI Tool below for demo purposes)
  31 5. Enter the Tool Key and secret
  32 6. Set various options and Save
  33
  34 Add a Tool to Course Content (Instructor)
  35 1. Create a new content page and save it or edit an existing page.
  36 2. Click on the External Tool icon in the content editor toolbar while editing that page.
  37 3. Select from the available tools to add it as a Learning Activity.
  38 4. Save the content page, and close the content editor.
  39 5. The tool appears at the bottom of the page as a link that opens a popup window.
  40
  41 Or,
  42
  43 Setup a New Tool (Instructor)
  44 1. Under the Manage Tab, click on Create External Tool in the External Tools section
  45 2. Fill in the required fields, as described above for Administrators.
  46 3. Set the optional settings below and Save
  47 4. Follow the steps above to Add a Tool to Course Content, to use your new tool.
  48
  49 ##################
  50 # Useful Resources
  51 ##################
  52
  53 BasicLTI Certification
  54 http://www.imsglobal.org/developers/alliance/LTI/blti-cert/lmscert.cfm
  55
  56 Sample LTI Tool for Testing/Demo Purposes
  57 http://www.imsglobal.org/developers/BLTI/tool.php
  58 key: lmsng.school.edu
  59 secret: secret
  60
  61 Tools Currently with BasicLTI Provider Capability
  62 QuestionMark
  63 http://www.questionmark.com/
  64 Noteflight
  65 http://www.noteflight.com/
  66 Wimba
  67 http://www.wimba.com/
  68 Elluminate
  69 http://www.elluminate.com/
  70
  71 A list BasicLTI conformant system can be found at:
  72 http://www.imsglobal.org/cc/statuschart.html
  73
  74 ###############################
  75 # Known issues in this release
  76 ###############################
  77 - should the view button in the admin's tool listing table display the actual tool instead of the tool settings. Would be more useful I think, given clicking the edit button displays the same information. Or maybe display settings above, and open the tool below in a frame.
  78
  79 - course backups need to be rethought. There is currently no backup support for external; tools.
  80         Issues:
  81         If/How to export Admin created tools in a course backup, so they will render in other systems without disclosing authentication/tool account info to instructors, who may not have license to access a tool outside it originally licenced environment?
  82         How to import course level tools in backups, and reset course_id and cid to the new content ids created
  83         How to reset the toolid to make it unique when importing BasicLTI tools in a backup into a course.
  84
  85 #############################
  86 # Tool options documentation
  87 #############################
  88 ###################
  89 #Required Settings#
  90 ###################
  91 #ToolId (must be unique across system)
  92 This is a unique identifier that you much choose.  This identifier must be unique across the system.  This identified is used to connect tool content items across exports and imports of the content area.
  93
  94 #Tool Launch URL
  95 This is the launch URL for the external tool.  It is provided by the eternal tool provider and should be entered here.  Generally an external tool provider will give you a URL, key, and secret so that you can access their tool.
  96
  97 #Tool Key (oauth_consumer_key)
  98 This is the launch key for the external tool.  It is provided by the external tool provider and should be entered here.  Generally an external tool provider will give you a URL, key, and secret so that you can access their tool.
  99
 100 #Tool Secret
 101 This is the launch key for the external tool.  It is provided by the eternal tool provider and should be entered here.  Generally an external tool provider will give you a URL, key, and secret so that you can access their tool.
 102 ###################
 103 #Optional Settings#
 104 ###################
 105
 106 #Frame Height
 107 This allows you to control the height of the frame that will contain the external tool.
 108
 109 #Allow Frame Height to be Changed
 110 The frame height may be specified for a tool by the administrator, or the administrator may allow the instructor to change the frame height.
 111
 112 #Launch Tool in Pop Up Window
 113 Normally tools are launched in an iframe at the bottom of an ATutor content page.  This option can be used so that the tool opens in a new browser window by clicking a link at the bottom of a content page, which replaces the default iframe. This option may be specified for a tool by the administrator, or the administrator may allow the instructor to specify this option.
 114
 115 #Launch Tool in Debug Mode
 116 This option should normally be off except when you are having problems with tool launching.   When this option is turned on, The launch is
 117 paused part-way through to allow you to examine the data to be sent to the external tool.  You are then given an option to continue the launch
 118 by pressing a button. This option may be specified for a tool by the administrator, or the administrator may allow the instructor to specify this option.
 119
 120 #Send User Names to External Tool
 121 This option determines whether you want to send user names to the external tool. You should only send user names to trusted tools and you should make sure that if you share user names with the external tools that you are following all appropriate regulations regarding student privacy. Sending user names is optional data in the Basic LTI specification although some tools may require user names to function properly.
 122 This option may be specified for a tool by the administrator, or the administrator may allow the instructor to specify this option.
 123
 124 #Send User Mail Addresses to External Tool
 125 This option determines whether you want to send user mail addresses to the external tool.You should only send user mail addresses to trusted tools and you should make sure that
 126 if you share user addresses with the external tools that you are following all appropriate regulations regarding student privacy.
 127 Sending user mail addresses is optional data in the Basic LTI specification although some tools may require user names to function properly.
 128 This option may be specified for a tool by the administrator, or the administrator may allow the instructor to specify this option.
 129
 130 #Accept Grades From External Tool
 131 Some tools can send grades back to ATutor through a Basic LTI extension REST web service.   If the external tool has the capability of
 132 using these services and you would like to allow the tool to send grades back to ATutor, you can enable this option.   When you author
 133 an external tool content item and enable this option, the tool will only be able to read and write grades in a single grade book item that
 134 you associate with the content item. This option may be specified for a tool by the administrator, or the administrator may allow the instructor to specify this option.
 135
 136 #Allow External Tool To Retrieve Roster
 137 Some tools can retrieve the entire course roster through a Basic LTI extension REST web service.  If the external tool has the capability of
 138 using these services and you would like to provide the entire course roster to the tool then you can enable this option.  If this option is enabled, it respects the privacy option setting as to whether or not to release user names and email addresses.   If these are configured to be provided on launches and the tool can retrieve the entire roster, then user names and mail addresses are included in the roster when it is retrieved.  This option may be specified for a tool by the administrator, or the administrator may allow the instructor to specify this option.
 139
 140 #Allow External Tool to use the Setting Service
 141 This option allows the external tool to store up to 8K of data in the content item.  Typically the external tool uses this area for a resource
 142 setting or perhaps a playlist as selected by the user. In particular it does not allow a separate 8K setting for each user for a content item. This option may be specified for a tool by the administrator, or the administrator may allow the instructor to specify this option.
 143
 144 #Custom Parameters
 145 Sometimes the external tool requires that you send additional custom parameters along with the launch. The typical use of this would be to specify an ISBN number for a book associated with the launch or to select a particular content item within a content repository.   Different tools will use this capability differently.  Typically these will be specified as a keyword and a value such as
 146
 147 isbn=929293939
 148
 149 These values may be set by the administrator or the administrator may allow the instructor to set these values in content items.
 150
 151 #######################
 152 #Additional Administrator Options
 153 #######################
 154 #Organization Identifier (typically DNS)
 155 This is typically the domain name of the organization hosting ATutor such as www.ocad.ca - this field is optional.
 156
 157 #Organization URL
 158 This is typically the URL of the starting page for the learning management system such as http://atutor.ocad.ca - this field is optional.
 159
 160 #Organization Description
 161 This is a short one-line textual description of the organization hosting ATutor such as "The Ontario College of Art & Design" - this field is optional