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.4

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