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

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.5     ! raeburn    17: \item Post-login destination -- you can specify the destination URL to which
        !            18: the browser will be redirected post-LTI authentication. To allow
        !            19: time for the initial launch to complete, you will specify a delay in seconds 
        !            20: before client-side javascript executes the redirect.
        !            21: 
        !            22: \item Append to URL -- you can specify text to append to the default URL
        !            23: (shown) to which the data payload will be sent on launch.
        !            24: 
1.3       raeburn    25: \item Display target 
1.1       raeburn    26: \begin{itemize}
                     27: \item iframe -- the tool will be launched within the standard interface, (i.e.,
1.5     ! raeburn    28: inline menu including navigation controls, and links/icons).
1.1       raeburn    29: 
                     30: \item tab -- a page containing a link to launch the tool will be displayed
                     31: in a separate web browser tab.
                     32: 
                     33: \item window -- a page containing a link to launch the tool will be displayed
                     34: in a separate web browser window.
                     35: 
                     36: \end{itemize}
                     37: 
                     38: \item Display options -- if display is tab or window, additional options may be available:
                     39: 
                     40: \begin{itemize}
                     41: 
                     42: \item Link Text -- the text used in the link which launches the tool
                     43: \item Explanation -- optional text block (HTML mark-up can be used)
                     44: displayed below the link
                     45: \item Width/Height -- if display is window, width and height of the new window
                     46: can be set by specifying the number of pixels to use for each. 
                     47: 
                     48: \end{itemize}
                     49: 
                     50: \item Course label -- e.g., institutional course code (sent on launch of tool)
                     51: \item Course title -- Course Title
                     52: 
1.2       raeburn    53: \item Gradable -- if a tool is used in Main Content, you can choose whether
                     54: to accept scores passed back by the tool, if the domain configuration
                     55: specified availability of a passback service.  
                     56: 
1.1       raeburn    57: \item Title -- title to use for tool instance on the Course Contents page.
                     58: 
                     59: \end{itemize}
                     60: 
1.4       raeburn    61: If External Tools can be used in the course's domain, you will choose
                     62: either ``Defined in domain'' or ``Defined in course'' to populate the
                     63: ``Select'' drop-down list with a list of available tools. Choose the 
                     64: name of the tool you wish to use from the drop-down list. Doing 
1.1       raeburn    65: so will cause the options for the tool to be displayed. If display is in
                     66: an iframe, by default, but you are permitted to choose one of the other types,
1.5     ! raeburn    67: then clicking tab or window will cause additional elements to be displayed.
1.1       raeburn    68: 
1.4       raeburn    69: For tools defined in the domain, your domain coordinator can tell you what
                     70: data are sent to the external tool when it is displayed.  Typically, though,  
                     71: this will include the username of the user, as well as the user's current 
                     72: ``LTI'' role. For tools defined in the course, you can see what data are sent
1.5     ! raeburn    73: by using Settings $>$ Course Settings $>$ Display (``External Tools'' checked).
1.4       raeburn    74: 
                     75: LTI uses a more restricted set of roles -- Instructor, Content Developer,
                     76: Teaching Assistant or Learner -- than are available in LON-CAPA. For tools
                     77: defined in the domain, your domain coordinator will have decided on the
                     78: mapping to an LTI role to be used for each standard LON-CAPA role. At a minimum
1.1       raeburn    79: you can expect that Course Coordinator (LON-CAPA) will map to Instructor (LTI),
                     80: Student (LON-CAPA) will map to Learner (LTI).
                     81: 
                     82: Under the LTI protocol, the user's identity, as well as the course context, will
1.5     ! raeburn    83: be sent to the external tool in a signed payload, and the tool (the LTI Provider)
        !            84: must verify the signature before it will trust the user's identity and role sent 
        !            85: from LON-CAPA (the LTI Consumer), and then assign appropriate privileges
        !            86: to the user within the tool.