documentation/admin/basiclti_external_tools.php

   1 <?php require('../common/body_header.inc.php'); $lm = '$LastChangedDate: 2006-06-29 11:25:07 -0400 (Thu, 29 Jun 2006) $'; ?>
   2
   3 <h2>Creating and Adding External Tools</h2>
   4         <p>The External Tools utility allows ATutor administrators and instructors to link external tools into ATutor, and to
   5 associate those tools with content as learning activities. External tools that support the <strong>BasicLTI</strong> tool provider standard may be added to content here.</p>
   6
   7
   8 <h3>Setup A New External Tool </h3>
   9 <ol>
  10 <li> Title:  Enter a name for the tool being created in the title field</li>
  11 <li> 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</li>
  12 <li> Description: Describe the tool, its function, and how it might be used.</li>
  13 <li> 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)</li>
  14 <li> Enter the Tool Key and secret</li>
  15 <li> Set various options and Save</li>
  16 </ol>
  17
  18 <h3>External Tool Options</h3>
  19 <p>These values may be set by the administrator or the administrator may allow the instructor to set these values in content items.</p>
  20
  21 <h4>Required Settings</h4>
  22 <ul>
  23 <li>ToolId (must be unique across system)<br />
  24 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.</li>
  25
  26 <li>Tool Launch URL<br />
  27 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.</li>
  28
  29 <li>Tool Key (oauth_consumer_key)<br />
  30 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.</li>
  31
  32 <li>Tool Secret<br />
  33 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.</li>
  34 </ul>
  35
  36 <h4>Optional External Tool Settings</h4>
  37
  38 <ul>
  39 <li>Frame Height<br />
  40 This allows you to control the height of the frame that will contain the external tool.</li>
  41
  42 <li>Allow Frame Height to be Changed<br />
  43 The frame height may be specified for a tool by the administrator, or the administrator may allow the instructor to change the frame height.</li>
  44
  45 <li>Launch Tool in Pop Up Window<br />
  46 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.</li>
  47
  48 <li>Launch Tool in Debug Mode<br />
  49 This option should normally be off except when you are having problems with tool launching.   When this option is turned on, The launch is
  50 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
  51 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.</li>
  52
  53 <li>Send User Names to External Tool<br />
  54 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.
  55 This option may be specified for a tool by the administrator, or the administrator may allow the instructor to specify this option.</li>
  56
  57 <li>Send User Mail Addresses to External Tool<br />
  58 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
  59 if you share user addresses with the external tools that you are following all appropriate regulations regarding student privacy.
  60 Sending user mail addresses is optional data in the Basic LTI specification although some tools may require user names to function properly.
  61 This option may be specified for a tool by the administrator, or the administrator may allow the instructor to specify this option.</li>
  62
  63 <li>Accept Grades From External Tool<br />
  64 Some tools can send grades back to ATutor through a Basic LTI extension REST web service.   If the external tool has the capability of
  65 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
  66 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
  67 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.</li>
  68
  69 <li>Allow External Tool To Retrieve Roster<br />
  70 Some tools can retrieve the entire course roster through a Basic LTI extension REST web service.  If the external tool has the capability of
  71 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.</li>
  72
  73 <li>Allow External Tool to use the Setting Service<br />
  74 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
  75 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.</li>
  76
  77 <li>Custom Parameters
  78 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<br />
  79
  80 <strong>isbn=929293939</strong>
  81 </li>
  82 </ul>
  83 <h3>BasicLTI Resources</h3>
  84 <p>Sample LTI Tool for Testing/Demo Purposes. Copy this URL, and its associated key and secret, into the corresponding fields in the Create External Tool screen to setup a simple demonstration tool.<br />
  85 http://www.imsglobal.org/developers/BLTI/tool.php<br />
  86 key: lmsng.school.edu<br />
  87 secret: secret<br />
  88 </p>
  89
  90 <h4>Tools Currently with BasicLTI Provider Capability</h4>
  91 <ul>
  92 <li>QuestionMark<br />
  93 <a href="http://www.questionmark.com/">http://www.questionmark.com/</a></li>
  94 <li>Noteflight<br />
  95 <a href="http://www.noteflight.com/">http://www.noteflight.com/</a></li>
  96 <li>Wimba<br />
  97 http://www.wimba.com/</a></li>
  98 <li>Elluminate<br />
  99 <a href="http://www.elluminate.com/">http://www.elluminate.com/</a></li>
 100 </ul>
 101
 102 <p>A current list of BasicLTI conformant systems can be found at:<br />
 103 <a href="http://www.imsglobal.org/cc/statuschart.html">http://www.imsglobal.org/cc/statuschart.html</a></p>
 104 <p>
 105 More about the BasicLTI Standard
 106 <a href="http://www.imsglobal.org/lti/">http://www.imsglobal.org/lti/</a></p>
 107
 108 <p>Here are a couple videos with more information:<br />
 109 <a href="http://www.vimeo.com/18074396">http://www.vimeo.com/18074396</a><br />
 110 <a href="http://vimeo.com/14100773">http://vimeo.com/14100773</a></p>
 111
 112 <?php require('../common/body_footer.inc.php'); ?>