[BACK]Return to Domain_Configuration_LTI_Tools.tex CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / html / adm / help / tex

Diff for /loncom/html/adm/help/tex/Domain_Configuration_LTI_Tools.tex between versions 1.3 and 1.4

version 1.3, 2020/05/24 20:40:51 version 1.4, 2020/05/24 21:48:38
Line 33  Optionally, you can also: Line 33  Optionally, you can also:
   
 \item{\textbf{User data sent on launch}}  \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.   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}}  \item{\textbf{Role mapping}}
   
Line 45  For each tool you will set mapping to an Line 45  For each tool you will set mapping to an
   
 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.  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.  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.  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.
   
Line 53  Lastly, the Provider URL can be set to b Line 53  Lastly, the Provider URL can be set to b
   
 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.  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.  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.  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}  \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:  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}  \begin{verbatim}
   
Removed from v.1.3  
changed lines
  Added in v.1.4

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>