Return to Docs_Adding_External_Tool.tex CVS log

Up to [LON-CAPA] / loncom / html / adm / help / tex

Annotation of loncom/html/adm/help/tex/Docs_Adding_External_Tool.tex, revision 1.3

1.1       raeburn     1: \label{Docs_Adding_External_Tool}
                      2: 
                      3: External tools which support the LTI (Learning Tool Interoperability)
                      4: standard can be included within a LON-CAPA course.  Which tools are available,
                      5: as well as the options which can be set by a Coordinator when including 
                      6: one of the available tools within a course or community, are set by the Domain 
                      7: Coordinator at a domain level. 
                      8: 
                      9: The full range of options which may be available to the Coordinator in the course
                     10: or community are:
                     11: 
                     12: \begin{itemize}
                     13: 
1.3     ! raeburn    14: \item Display target 
1.1       raeburn    15: \begin{itemize}
                     16: \item iframe -- the tool will be launched within the standard interface, (i.e.,
                     17: inline menu including navigation controls, and links/icons)
                     18: 
                     19: \item tab -- a page containing a link to launch the tool will be displayed
                     20: in a separate web browser tab.
                     21: 
                     22: \item window -- a page containing a link to launch the tool will be displayed
                     23: in a separate web browser window.
                     24: 
                     25: \end{itemize}
                     26: 
                     27: \item Display options -- if display is tab or window, additional options may be available:
                     28: 
                     29: \begin{itemize}
                     30: 
                     31: \item Link Text -- the text used in the link which launches the tool
                     32: \item Explanation -- optional text block (HTML mark-up can be used)
                     33: displayed below the link
                     34: \item Width/Height -- if display is window, width and height of the new window
                     35: can be set by specifying the number of pixels to use for each. 
                     36: 
                     37: \end{itemize}
                     38: 
                     39: \item Course label -- e.g., institutional course code (sent on launch of tool)
                     40: \item Course title -- Course Title
                     41: 
1.2       raeburn    42: \item Append to URL -- you can specify text to append to the default URL 
                     43: (shown) which will be requested on launch.
                     44: 
                     45: \item Gradable -- if a tool is used in Main Content, you can choose whether
                     46: to accept scores passed back by the tool, if the domain configuration
                     47: specified availability of a passback service.  
                     48: 
1.1       raeburn    49: \item Title -- title to use for tool instance on the Course Contents page.
                     50: 
                     51: \end{itemize}
                     52: 
                     53: If external LTI tools can be used in the course's domain, you will select the
                     54: name of the tool you wish to use from the ``Select'' drop-down list. Doing 
                     55: so will cause the options for the tool to be displayed. If display is in
                     56: an iframe, by default, but you are permitted to choose one of the other types,
                     57: then click tab or window will cause additional elements to be displayed.
                     58: 
                     59: Your domain coordinator can tell you what data are sent to the external tool
                     60: when it is displayed. Typically, though, this will include the username of the
                     61: user, as well as the user's current ``LTI'' role. LTI uses a more restricted
                     62: set of roles -- Instructor, Content Developer, Teaching Assistant or Learner --
                     63: than are available in LON-CAPA. Your domain coordinator will have decided on
                     64: the mapping to an LTI role to be used for each standard LON-CAPA role. At a minimum
                     65: you can expect that Course Coordinator (LON-CAPA) will map to Instructor (LTI),
                     66: Student (LON-CAPA) will map to Learner (LTI).
                     67: 
                     68: Under the LTI protocol, the user's identity, as well as the course context, will
                     69: be sent to the external tool in an encrypted form, and the tool (the LTI Provider)
                     70: will trust the user's identity and role sent from LON-CAPA (the LTI Consumer),
                     71: and then assign appropriate privileges to the user within the tool.