[LON-CAPA-cvs] cvs: doc /help domain.manual.texxml loncom/html/adm/help/tex Domain_Configuration_LTI_Tools.tex

[raeburn]

raeburn		Sun May 24 18:36:08 2020 EDT

  Added files:                 
    /loncom/html/adm/help/tex	Domain_Configuration_LTI_Tools.tex 

  Modified files:              
    /doc/help	domain.manual.texxml 
  Log:
  - Add documentation for External Tools (LON-CAPA as LTI Consumer) to 
    Domain Coordination manual.
  
  
-------------- next part --------------
Index: doc/help/domain.manual.texxml
diff -u doc/help/domain.manual.texxml:1.26 doc/help/domain.manual.texxml:1.27
--- doc/help/domain.manual.texxml:1.26	Wed Jan  8 22:50:35 2020
+++ doc/help/domain.manual.texxml	Sun May 24 18:36:08 2020
@@ -61,6 +61,9 @@
     <subsection name="Course/Community Self-enrollment">
       <file name="Domain_Configuration_Selfenrollment.tex" />
     </subsection>
+    <subsection name="External Tools (LON-CAPA as LTI Consumer)">
+      <file name="Domain_Configuration_LTI_Tools.tex" />
+    </subsection>
     <subsection name="Authoring Space Requests">
       <file name="Domain_Configuration_Request_Author.tex" />
     </subsection>

Index: loncom/html/adm/help/tex/Domain_Configuration_LTI_Tools.tex
+++ loncom/html/adm/help/tex/Domain_Configuration_LTI_Tools.tex
\label{Domain_Configuration_LTI_Tools}

By adding one or more External Tools to a domain, you will be enabling use of your LON-CAPA domain as an LTI Consumer (where LTI = Learning Tool Interoperability). Under the LTI protocol, the user's identity, as well as the course context, can be sent to the external tool (the Provider) which will trust the identity and role information provided by LON-CAPA (the Consumer). Any LON-CAPA data being provided are included in an encrypted form in the tool launch page sent to the user's web browser by LON-CAPA. The external tool will assign appropriate privileges to the user within the tool, based on the user's role.  

The shared key and secret used to encrypt data sent to the Tool Provider are typically provided to you when contact the Provider to let them know you would like to use their tool with your Learning Management System, i.e., with the LON-CAPA service for your domain.

When a Domain Coordinator includes ``External Tools (LTI)'' as one of the domain settings to display/modify via the ``Set domain configuration'' link in the Main Menu, a table will be displayed listing all currently available External Tools (i.e., LTI Providers) configured for use in the domain, as well as an ``Add'' checkbox (for the last row in the table), used to add a new External Tool.

Internally in LON-CAPA each external tool you configure for your domain receives a unique numerical ID (starting at 1), which remains unchanged, regardless of any future changes made to the configuration for that particular tool.  A drop-down list in the left column of the External Tools table can be used to change the order in which available tools are listed in both the domain configuration table, and in the dropdown list in the ``External Tool Editor'' item available in the Course Editor (``External tab''), when one or more tools are available in the course's domain.

Settings available for each External Tool in the domain are as follows:

\begin{itemize}

\item{\textbf{Required settings}}

The Provider name will be the Tool name shown in the listing of available External Tools in the Course Editor.

Keys and secrets for LTI Tools, which should be specific to a LON-CAPA domain, are stored internally in a separate GDBM file from the other domain configuration information in your domain. For each LTI Tool, the unique key and secret will be provided to you by the Tool Provider, as will the remote URL which will handle LTI launch requests from link(s) to instance(s) of the tool in LON-CAPA courses in your domain.

Each LTI tool can be configured to allow additional information to be appended to the Tool URL for each tool instance by a Course Coordinator.  There are four other required settings: Version, Message Type, Signature Method and Nonce lifetime. You will likely use the default values provided for each of the four. 

\item{\textbf{Optional settings}}

There are five optional settings, for which you can set default values, which optionally you may allow a Course Coordinator to override for each tool instance: Display target (iFrame, Tab, or Window), Width and Height (if target is Window), default link text, and default explanation. 

Optionally, you can also:
\begin{itemize}
\item Set whether a tool can return grade information to the LON-CAPA course from which it was launched, for the user (and tool instance).  You can also set the lifetime (in days) of the unique grade passback ID sent to the external tool, each time a user launches a particular instance of a tool in a course.
\item Set whether a tool can retrieve roster information for the LON-CAPA course from which it was launched, within a specified number of seconds from launch.
\item Upload a small image file, which will be used as an icon for the file type for each tool instance in the Course Editor.
\end{itemize}

\item{\textbf{User data sent on launch}}

For each External Tool, you will set what data are sent when it is launched. You can choose to send any or all of: Full Name, First Name, Last Name, E-mail address, Role (i.e., current "LTI" role, as determined from current role in LON-CAPA), and User (either username or username:domain) for the user launching a tool instance in a course. 

\item{\textbf{Role mapping}}

LTI uses a more restricted set of roles - Instructor, Content Developer, Teaching Assistant or Learner - than are available in LON-CAPA.

For each tool you will set mapping to an LTI role to be used for each standard LON-CAPA role. At a minimum you should likely set that Course Coordinator (LON-CAPA) will map to Instructor (LTI), and Student (LON-CAPA) will map to Learner (LTI). 

\item{\textbf{Configurable in course}}

The five optional settings: display target (and width and height, when target is window), default link text, and default explanation can be set to be configurable for each instance of a tool in a course by the Course Coordinator.

In addition, two other items sent on launch to the external tool -- Course label and Course title -- can be set to be configurable by a Course Coordinator. If Course label is not configurable, the institutional course code for the LON-CAPA course will be used, whereas if Course title is not configurable, the LON-CAPA course title will be used, respectively, for context_label and context_title, as part of the data sent to the external tool on launch.

Lastly, the Provider URL can be set to be configurable, so that a Course Coordinator can specify text (potentially unique for each tool instance), such as a path or query string, which will be appended to the default Provider URL to which the encrypted LTI data are sent on launch.

\item{\textbf{Custom items sent on launch}}

Besides the set of standard LTI items, you may also add name=value pairs to send additional data to the LTI Provider on launch of the tool in a LON-CAPA course.

LON-CAPA will automatically prepend \emph{custom_} to the name of each custom item you set in the tool configuration when preparing the data to send to the external tool.

If the entry in the \emph{value} textbox is of the form: LONCAPA::env\{lcenvkey\}, where \emph{lcenvkey} is the name of an item in LON-CAPA's own \%env hash, then the LONCAPA::env\{lcenvkey\} value in the custom_name=value pair sent on launch will be the value of \$env\{lcenvkey\} in effect in the user's LON-CAPA session. Otherwise, whatever value is set in the domain configuration for the tool for item \emph{name} will be sent as the pair: custom_name=value.

\end{itemize}

For reference the complete set of parameters (other than custom_*) which could be present in the data POSTed on LTI launch (depending on how the tool is configured) is as follows:

\begin{verbatim}

basiclti_submit
context_id
context_label
context_title
context_type
ext_ims_lis_basic_outcome_url
ext_ims_lis_memberships_url
ext_ims_lis_memberships_id
launch_presentation_document_target
launch_presentation_locale
launch_presentation_height
launch_presentation_width
lis_outcome_service_url
lis_person_contact_email_primary
lis_person_name_family
lis_person_name_full
lis_person_name_given
lis_person_sourcedid
lis_result_sourcedid
lti_message_type
lti_version
oauth_consumer_key
oauth_nonce
oauth_signature
oauth_signature_method
oauth_timestamp
oauth_version
resource_link_id
resource_link_title
roles
tool_consumer_info_product_family_code
tool_consumer_info_version
tool_consumer_instance_description
tool_consumer_instance_guid
tool_consumer_instance_name
tool_consumer_instance_url
user_id

\end{verbatim}