Tsugi

LTIConstants
in package

Table of Contents

Constants

ACCEPT_COPY_ADVICE  : mixed = "accept_copy_advice"
accept_copy_advice=false | true (Optional)
ACCEPT_MEDIA_TYPES  : mixed = "accept_media_types"
accept_media_types=application/vnd.ims.lti.v1.ltilink,image/*,text/html (Required)
ACCEPT_MULTIPLE  : mixed = "accept_multiple"
accept_multiple=false | true (Optional)
ACCEPT_PRESENTATION_DOCUMENT_TARGETS  : mixed = "accept_presentation_document_targets"
accept_presentation_document_targets=embed,frame,iframe,window,popup,overlay (Required)
ACCEPT_UNSIGNED  : mixed = "accept_unsigned"
accept_unsigned=false | true (Optional)
AUTO_CREATE  : mixed = "auto_create"
auto_create=false | true (Optional)
BASIC_LTI_LAUNCH_REQUEST  : mixed = "basic-lti-launch-request"
CAN_CONFIRM  : mixed = "can_confirm"
can_confirm=false | true (Optional)
CONTENT_ITEM_RETURN_URL  : mixed = "content_item_return_url"
content_item_return_url=http://lmsng.school.edu/portal/123/page/988/item/261 (Required)
CONTENT_ITEM_SELECTION_REQUEST  : mixed = "ContentItemSelectionRequest"
CONTEXT_ID  : mixed = "context_id"
context_id=8213060-006f-27b2066ac545 <p> This is an opaque identifier that uniquely identifies the context that contains the link being launched.
CONTEXT_LABEL  : mixed = "context_label"
context_label=SI182 <p> A label for the context - intended to fit in a column.
CONTEXT_TITLE  : mixed = "context_title"
context_title=Design of Personal Environments <p> A title of the context - it should be about the length of a line.
CONTEXT_TYPE  : mixed = "context_type"
context_type=CourseSection <p> This string is a comma-separated list of URN values that identify the type of context. At a minimum, the list MUST include a URN value drawn from the LIS vocabulary (see Appendix A). The assumed namespace of these URNs is the LIS vocabulary so TCs can use the handles when the intent is to refer to an LIS context type. If the TC wants to include a context type from another namespace, a fully-qualified URN should be used.
CONTEXT_TYPE_COURSE_OFFERING  : mixed = "CourseOffering"
CONTEXT_TYPE_COURSE_SECTION  : mixed = "CourseSection"
CONTEXT_TYPE_COURSE_TEMPLATE  : mixed = "CourseTemplate"
CONTEXT_TYPE_GROUP  : mixed = "Group"
CUSTOM_PREFIX  : mixed = "custom_"
custom_keyname=value <p> The creator of a Basic LTI link can add custom key/value parameters to a launch which are to be included with the launch of the Basic LTI link. The Common Cartridge section below describes how these parameters are represented when storing custom parameters in a Common Cartridge.
DATA  : mixed = "data"
data=... (Optional)
EXT_CONTEXT_MEMBERSHIP_ID  : mixed = "ext_ims_lis_memberships_id"
EXT_CONTEXT_MEMBERSHIP_URL  : mixed = "ext_ims_lis_memberships_url"
EXT_CONTEXT_REQUEST_ID  : mixed = "id"
EXT_SAKAI_PROVIDER_DISPLAYID  : mixed = "ext_sakai_provider_displayid"
ext_sakai_provider_displayid=john.smith <p> If set, this will indicate to an external application that the user is normally known by this ID and when displaying the ID to the user this ID should be used instead of the user_id and ext_sakai_provider_eid.
EXT_SAKAI_PROVIDER_EID  : mixed = "ext_sakai_provider_eid"
ext_sakai_provider_eid=jsmith26 <p> If set, this will signal that the external application has provided an eid which should be used preferentially. Many external applications will not have access to a user's uuid in Sakai, so this allows integrations with those systems.
EXTENSION_PREFIX  : mixed = "ext_"
ext_param=value <p> Systems can add their own values to the launch but should prefix any extensions with "ext_".
LAUNCH_PRESENTATION_CSS_URL  : mixed = "launch_presentation_css_url"
launch_presentation_css_url=http://www.toolconsumer.url/path/to/lti.css <p> This points to a fully qualified URL for a CSS which can be used to style the tool.
LAUNCH_PRESENTATION_DOCUMENT_TARGET  : mixed = "launch_presentation_document_target"
launch_presentation_document_target=iframe <p> The value should be either 'frame', 'iframe' or 'window'. This field communicates the kind of browser window/frame where the TC has launched the tool.
LAUNCH_PRESENTATION_HEIGHT  : mixed = "launch_presentation_height"
launch_presentation_height=240 <p> The height of the window or frame where the content from the tool will be displayed.
LAUNCH_PRESENTATION_LOCALE  : mixed = "launch_presentation_locale"
launch_presentation_locale=en_US_variant <p> Language, country and variant separated by underscores. Language is the lower-case, two-letter code as defined by ISO-639 (list of codes available at http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt). Country is the upper-case, two-letter code as defined by ISO-3166 (list of codes available at http://www.chemie.fu- berlin.de/diverse/doc/ISO_3166.html). Country and variant codes are optional.
LAUNCH_PRESENTATION_RETURN_URL  : mixed = "launch_presentation_return_url"
launch_presentation_return_url=http://lmsng.school.edu/portal/123/page/988/ <p> Fully qualified URL where the TP can redirect the user back to the TC interface. This URL can be used once the TP is finished or if the TP cannot start or has some technical difficulty. In the case of an error, the TP may add a parameter called lti_errormsg that includes some detail as to the nature of the error. The lti_errormsg value should make sense if displayed to the user. If the tool has displayed a message to the end user and only wants to give the TC a message to log, use the parameter lti_errorlog instead of lti_errormsg. If the tool is terminating normally, and wants a message displayed to the user it can include a text message as the lti_msg parameter to the return URL. If the tool is terminating normally and wants to give the TC a message to log, use the parameter lti_log. This data should be sent on the URL as a GET - so the TP should take care to keep the overall length of the parameters small enough to fit within the limitations of a GET request.
LAUNCH_PRESENTATION_WIDTH  : mixed = "launch_presentation_width"
launch_presentation_width=320 <p> The width of the window or frame where the content from the tool will be displayed.
LIS_COURSE_OFFERING_SOURCEDID  : mixed = "lis_course_offering_sourcedid"
lis_course_offering_sourcedid=school.edu:SI182-F08 <br/> lis_course_section_sourcedid=school.edu:SI182-001-F08 <p> These fields contain LIS course identifiers associated with the context of this launch. These fields are optional and their content and meaning are defined by LIS.
LIS_COURSE_SECTION_SOURCEDID  : mixed = "lis_course_section_sourcedid"
LIS_OUTCOME_SERVICE_URL  : mixed = "lis_outcome_service_url"
lis_outcome_service_url=http://lmsng.school.edu/service/ltiout/ <p> This field should be no more than 1023 characters long and the TP should assume that the URL might change from launch to launch and allow for the fact that a TC might change their service URL from launch to launch and only use the most recent value for this parameter. The service URL may support various operations / services.
LIS_PERSON_CONTACT_EMAIL_PRIMARY  : mixed = "lis_person_contact_email_primary"
lis_person_contact_email_primary=user@school.edu <p> These fields contain information about the user account that is performing this launch. The names of these data items are taken from LIS. The precise meaning of the content in these fields is defined by LIS.
LIS_PERSON_NAME_FAMILY  : mixed = "lis_person_name_family"
lis_person_name_family=Public <p> These fields contain information about the user account that is performing this launch. The names of these data items are taken from LIS. The precise meaning of the content in these fields is defined by LIS.
LIS_PERSON_NAME_FULL  : mixed = "lis_person_name_full"
lis_person_name_full=Jane Q. Public <p> These fields contain information about the user account that is performing this launch. The names of these data items are taken from LIS. The precise meaning of the content in these fields is defined by LIS.
LIS_PERSON_NAME_GIVEN  : mixed = "lis_person_name_given"
lis_person_name_given=Jane <p> These fields contain information about the user account that is performing this launch. The names of these data items are taken from LIS. The precise meaning of the content in these fields is defined by LIS.
LIS_PERSON_SOURCEDID  : mixed = "lis_person_sourcedid"
lis_person_sourcedid=school.edu:user <p> This field contains the LIS identifier for the user account that is performing this launch. The example syntax of "school:user" is not the required format – lis_person_sourcedid is simply a unique identifier (i.e., a normalized string). This field is optional and its content and meaning are defined by LIS.
LIS_RESULT_SOURCEDID  : mixed = "lis_result_sourcedid"
lis_result_sourcedid=83873872987329873264783687634 <p> This field contains an identifier that indicates the LIS Result Identifier (if any) associated with this launch. This field is optional and its content and meaning is defined by LIS.
LTI_MESSAGE_TYPE  : mixed = "lti_message_type"
lti_message_type=basic-lti-launch-request <p> This indicates that this is a Basic LTI Launch Message. This allows a TP to accept a number of different LTI message types at the same launch URL. This parameter is required.
LTI_MESSAGE_TYPE_BASICLTILAUNCHREQUEST  : mixed = "basic-lti-launch-request"
LTI_MESSAGE_TYPE_CONTENTITEMSELECTION  : mixed = "ContentItemSelection"
LTI_MESSAGE_TYPE_CONTENTITEMSELECTIONREQUEST  : mixed = "ContentItemSelectionRequest"
LTI_MESSAGE_TYPE_CONTEXTMEMBERSHIPS  : mixed = "basic-lis-readmembershipsforcontext"
LTI_MESSAGE_TYPE_CONTEXTMEMBERSHIPSWITHGROUPS  : mixed = "basic-lis-readmembershipsforcontextwithgroups"
LTI_VERSION  : mixed = "lti_version"
lti_version=LTI-1p0 <p> This indicates which version of the specification is being used for this particular message. This parameter is required.
LTI_VERSION_1  : mixed = "LTI-1p0"
LTI_VERSION_2  : mixed = "LTI-2p0"
MEDIA_CC  : mixed = "application/vnd.ims.imsccv1p1,application/vnd....
MEDIA_CC_1_1  : mixed = "application/vnd.ims.imsccv1p1"
MEDIA_CC_1_2  : mixed = "application/vnd.ims.imsccv1p2"
MEDIA_CC_1_3  : mixed = "application/vnd.ims.imsccv1p3"
MEDIA_LTILINKITEM  : mixed = "application/vnd.ims.lti.v1.ltilink"
NEW_SITE_TYPE  : mixed = "lti"
The default site type to use if a site needs to be created. Can be overriden in sakai.properties or as part of the launch.
OAUTH_PREFIX  : mixed = "oauth_"
Parameters with the OAuth prefix are also acceptible.
RESOURCE_LINK_DESCRIPTION  : mixed = "resource_link_description"
resource_link_description=… <p> A plain text description of the link’s destination, suitable for display alongside the link. Typically no more than several lines long. This parameter is optional.
RESOURCE_LINK_ID  : mixed = "resource_link_id"
resource_link_id=88391-e1919-bb3456 <p> This is an opaque unique identifier that the TC guarantees will be unique within the TC for every placement of the link. If the tool / activity is placed multiple times in the same context, each of those placements will be distinct. This value will also change if the item is exported from one system or context and imported into another system or context. This parameter is required.
RESOURCE_LINK_TITLE  : mixed = "resource_link_title"
resource_link_title=My Weekly Wiki <p> A title for the resource. This is the clickable text that appears in the link. This parameter is recommended.
ROLE_INSTRUCTOR  : mixed = "Instructor"
ROLE_LEARNER  : mixed = "Learner"
ROLES  : mixed = "roles"
roles=Instructor,Student <p> A comma-separated list of URN values for roles. If this list is non-empty, it should contain at least one role from the LIS System Role, LIS Institution Role, or LIS Context Role vocabularies (See Appendix A). The assumed namespace of these URNs is the LIS vocabulary of LIS Context Roles so TCs can use the handles when the intent is to refer to an LIS context role. If the TC wants to include a role from another namespace, a fully-qualified URN should be used. Usage of roles from non-LIS vocabularies is discouraged as it may limit interoperability. This parameter is recommended.
TEXT  : mixed = "text"
text=... (Optional)
TITLE  : mixed = "title"
title=... (Optional)
TOOL_CONSUMER_INFO_PRODUCT_FAMILY_CODE  : mixed = "tool_consumer_info_product_family_code"
tool_consumer_info_product_family_code=desire2learn <p> In order to better assist tools in using extensions and also making their user interface fit into the TC's user interface that they are being called from, each TC is encouraged to include the this parameter. Possible example values for this field might be:
TOOL_CONSUMER_INFO_VERSION  : mixed = "tool_consumer_info_version"
tool_consumer_info_version=9.2.4 <p> This field should have a major release number followed by a period. The format of the minor release is flexible. Possible vaues for this field might be:
TOOL_CONSUMER_INSTANCE_CONTACT_EMAIL  : mixed = "tool_consumer_instance_contact_email"
tool_consumer_instance_contact_email=System.Admin@school.edu <p> An email contact for the TC instance.
TOOL_CONSUMER_INSTANCE_DESCRIPTION  : mixed = "tool_consumer_instance_description"
tool_consumer_instance_description=University of School (LMSng) <p> This is a user visible field - it should be about the length of a line.
TOOL_CONSUMER_INSTANCE_GUID  : mixed = "tool_consumer_instance_guid"
tool_consumer_instance_guid=lmsng.school.edu <p> This is a key to be used when setting a TC-wide password. The TP uses this as a key to look up the TC-wide secret when validating a message. A common practice is to use the DNS of the organization or the DNS of the TC instance. If the organization has multiple TC instances, then the best practice is to prefix the domain name with a locally unique identifier for the TC instance. This parameter is recommended.
TOOL_CONSUMER_INSTANCE_NAME  : mixed = "tool_consumer_instance_name"
tool_consumer_instance_name=SchoolU <p> This is a user visible field - it should be about the length of a column.
TOOL_CONSUMER_INSTANCE_URL  : mixed = "tool_consumer_instance_url"
Missing from implementation guide. Needs documentation. Not required, but "tasty".
TYPE_CONTENTITEM  : mixed = "ContentItem"
TYPE_FILEITEM  : mixed = "FileItem"
TYPE_IMPORTITEM  : mixed = "ImportItem"
TYPE_LTILINK_OLD  : mixed = "LtiLink"
TYPE_LTILINKITEM  : mixed = "LtiLinkItem"
USER_ID  : mixed = "user_id"
user_id=0ae836b9-7fc9-4060-006f-27b2066ac545 <p> Uniquely identifies the user. This should not contain any identifying information for the user. Best practice is that this field should be a TC-generated long-term "primary key" to the user record - not the logical key. This parameter is recommended.
USER_IMAGE  : mixed = "user_image"
user_image=http://my.sakai.org/direct/profile/0ae836b9-7fc9-4060-006f-27b2066ac545/image <p> This attribute specifies the URI for an image of the user who launched this request.

Constants

ACCEPT_COPY_ADVICE

accept_copy_advice=false | true (Optional)

public mixed ACCEPT_COPY_ADVICE = "accept_copy_advice"

This indicates whether the TC is able and willing to make a local copy of a content item. The return message may include a expiresAt parameter to indicate that the URL provided will expire and so a copy of the content item should be stored locally before the expiry time passes. Use a value of false (the default) to indicate that the TC has no capacity for storing local copies of content items.

ACCEPT_MEDIA_TYPES

accept_media_types=application/vnd.ims.lti.v1.ltilink,image/*,text/html (Required)

public mixed ACCEPT_MEDIA_TYPES = "accept_media_types"

A comma-separated list of MIME types which can be accepted on the return URL. A MIME type of application/vnd.ims.lti.v1.ltilink is used to represent an LTI launch request to a TP. This parameter should use the same format as the Accept header in HTTP requests [HTTP, 14]. For example, a value of “image/; q=0.5, image/png” indicates that a PNG image is preferred, but any type of image will be accepted if one is not available. To accept any media type except an LTI link, a header of “application/vnd.ims.lti.v1.ltilink; q=0, * /” could be used.

ACCEPT_MULTIPLE

accept_multiple=false | true (Optional)

public mixed ACCEPT_MULTIPLE = "accept_multiple"

This indicates whether the user should be permitted to select more than one item. This parameter is optional; when omitted a value of false should be assumed (i.e. only a single item may be returned).

ACCEPT_PRESENTATION_DOCUMENT_TARGETS

accept_presentation_document_targets=embed,frame,iframe,window,popup,overlay (Required)

public mixed ACCEPT_PRESENTATION_DOCUMENT_TARGETS = "accept_presentation_document_targets"

A comma-separated list of ways in which the selected content item(s) can be requested to be opened (via the presentationDocumentTarget element for a returned content item). The possible values for this parameter are: embed – insert the item at the current insertion point (for example, using an img tag or an object tag); frame – open the item in the same frame as the link; iframe – open the item within an iframe within the same page/frame as the link; window – open the item in a new window (or tab); popup – open the item in a popup window (using the dimensions provided, if any); overlay – open the item over the top of the page where the link exists (for example, using a lightbox). none – the item is not intended for display but for storing or processing (for example, an assignment submission may just be stored without a link to it being added to the course).

ACCEPT_UNSIGNED

accept_unsigned=false | true (Optional)

public mixed ACCEPT_UNSIGNED = "accept_unsigned"

This indicates whether the TC is willing to accept an unsigned return message, or not. A signed message should always be required when the content item is being created automatically in the Tool Consumer without further interaction from the user. This parameter is optional; when omitted a value of false should be assumed (i.e. the return message should be signed).

AUTO_CREATE

auto_create=false | true (Optional)

public mixed AUTO_CREATE = "auto_create"

This indicates whether any content items returned by the TP would be automatically persisted without any option for the user to cancel the operation. This parameter is optional; when omitted a value of false should be assumed (i.e. items returned may not be persisted at the TC end).

BASIC_LTI_LAUNCH_REQUEST

public mixed BASIC_LTI_LAUNCH_REQUEST = "basic-lti-launch-request"

CAN_CONFIRM

can_confirm=false | true (Optional)

public mixed CAN_CONFIRM = "can_confirm"

This indicates whether the TC supports the feature for confirming the persistence of content items received. When a value of true is passed, the TP may include a confirm_url parameter in its return message containing the endpoint to which a confirmation request should be sent (see below). If the TP does not support this feature or does not wish to receive a confirmation it may just omit the confirm_url parameter from its return message. This option may be used even when the auto_create parameter is set to true if a TC is willing to offer the additional reassurance that items have been persisted, or to allow a TP to be notified of resource link IDs for any LTI links which have been created.

CONTENT_ITEM_RETURN_URL

content_item_return_url=http://lmsng.school.edu/portal/123/page/988/item/261 (Required)

public mixed CONTENT_ITEM_RETURN_URL = "content_item_return_url"

Fully qualified URL where the TP redirects the user back to the TC interface. This URL can be used once the TP is finished or if the TP cannot start or has some technical difficulty.

CONTENT_ITEM_SELECTION_REQUEST

public mixed CONTENT_ITEM_SELECTION_REQUEST = "ContentItemSelectionRequest"

CONTEXT_ID

context_id=8213060-006f-27b2066ac545 <p> This is an opaque identifier that uniquely identifies the context that contains the link being launched.

public mixed CONTEXT_ID = "context_id"

CONTEXT_LABEL

context_label=SI182 <p> A label for the context - intended to fit in a column.

public mixed CONTEXT_LABEL = "context_label"

CONTEXT_TITLE

context_title=Design of Personal Environments <p> A title of the context - it should be about the length of a line.

public mixed CONTEXT_TITLE = "context_title"

CONTEXT_TYPE

context_type=CourseSection <p> This string is a comma-separated list of URN values that identify the type of context. At a minimum, the list MUST include a URN value drawn from the LIS vocabulary (see Appendix A). The assumed namespace of these URNs is the LIS vocabulary so TCs can use the handles when the intent is to refer to an LIS context type. If the TC wants to include a context type from another namespace, a fully-qualified URN should be used.

public mixed CONTEXT_TYPE = "context_type"

CONTEXT_TYPE_COURSE_OFFERING

public mixed CONTEXT_TYPE_COURSE_OFFERING = "CourseOffering"

CONTEXT_TYPE_COURSE_SECTION

public mixed CONTEXT_TYPE_COURSE_SECTION = "CourseSection"

CONTEXT_TYPE_COURSE_TEMPLATE

public mixed CONTEXT_TYPE_COURSE_TEMPLATE = "CourseTemplate"

CONTEXT_TYPE_GROUP

public mixed CONTEXT_TYPE_GROUP = "Group"

CUSTOM_PREFIX

custom_keyname=value <p> The creator of a Basic LTI link can add custom key/value parameters to a launch which are to be included with the launch of the Basic LTI link. The Common Cartridge section below describes how these parameters are represented when storing custom parameters in a Common Cartridge.

public mixed CUSTOM_PREFIX = "custom_"

When there are custom name / value parameters in the launch, a POST parameter is included for each custom parameter. The parameter names are mapped to lower case and any character that is neither a number nor letter in a parameter name is replaced with an "underscore". So if a custom entry was as follows:

Review:Chapter=1.2.56

Would map to: custom_review_chapter=1.2.56

Creators of Basic LTI links would be well served to limit their parameter names to lower case and to use no punctuation other than underscores. If these custom parameters are included in the Basic LTI link, the TC must include them in the launch data or the TP may fail to function.

DATA

data=... (Optional)

public mixed DATA = "data"

An opaque value which should be returned by the TP in its response.

EXT_CONTEXT_MEMBERSHIP_ID

public mixed EXT_CONTEXT_MEMBERSHIP_ID = "ext_ims_lis_memberships_id"

EXT_CONTEXT_MEMBERSHIP_URL

public mixed EXT_CONTEXT_MEMBERSHIP_URL = "ext_ims_lis_memberships_url"

EXT_CONTEXT_REQUEST_ID

public mixed EXT_CONTEXT_REQUEST_ID = "id"

EXT_SAKAI_PROVIDER_DISPLAYID

ext_sakai_provider_displayid=john.smith <p> If set, this will indicate to an external application that the user is normally known by this ID and when displaying the ID to the user this ID should be used instead of the user_id and ext_sakai_provider_eid.

public mixed EXT_SAKAI_PROVIDER_DISPLAYID = "ext_sakai_provider_displayid"

This parameter is optional and is unique to the Sakai Basic LTI provider.

EXT_SAKAI_PROVIDER_EID

ext_sakai_provider_eid=jsmith26 <p> If set, this will signal that the external application has provided an eid which should be used preferentially. Many external applications will not have access to a user's uuid in Sakai, so this allows integrations with those systems.

public mixed EXT_SAKAI_PROVIDER_EID = "ext_sakai_provider_eid"

This parameter is optional and is unique to the Sakai Basic LTI provider.

EXTENSION_PREFIX

ext_param=value <p> Systems can add their own values to the launch but should prefix any extensions with "ext_".

public mixed EXTENSION_PREFIX = "ext_"

LAUNCH_PRESENTATION_CSS_URL

launch_presentation_css_url=http://www.toolconsumer.url/path/to/lti.css <p> This points to a fully qualified URL for a CSS which can be used to style the tool.

public mixed LAUNCH_PRESENTATION_CSS_URL = "launch_presentation_css_url"

There are no officially defined CSS classes for this file, but the Consumer can apply styles to paragraphs, body, and the various HTML elements. It is up to the tool as to whether this CSS is used or not, and in what order this is included relative to the tool-specific CSS.

LAUNCH_PRESENTATION_DOCUMENT_TARGET

launch_presentation_document_target=iframe <p> The value should be either 'frame', 'iframe' or 'window'. This field communicates the kind of browser window/frame where the TC has launched the tool.

public mixed LAUNCH_PRESENTATION_DOCUMENT_TARGET = "launch_presentation_document_target"

LAUNCH_PRESENTATION_HEIGHT

launch_presentation_height=240 <p> The height of the window or frame where the content from the tool will be displayed.

public mixed LAUNCH_PRESENTATION_HEIGHT = "launch_presentation_height"

LAUNCH_PRESENTATION_LOCALE

launch_presentation_locale=en_US_variant <p> Language, country and variant separated by underscores. Language is the lower-case, two-letter code as defined by ISO-639 (list of codes available at http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt). Country is the upper-case, two-letter code as defined by ISO-3166 (list of codes available at http://www.chemie.fu- berlin.de/diverse/doc/ISO_3166.html). Country and variant codes are optional.

public mixed LAUNCH_PRESENTATION_LOCALE = "launch_presentation_locale"

LAUNCH_PRESENTATION_RETURN_URL

launch_presentation_return_url=http://lmsng.school.edu/portal/123/page/988/ <p> Fully qualified URL where the TP can redirect the user back to the TC interface. This URL can be used once the TP is finished or if the TP cannot start or has some technical difficulty. In the case of an error, the TP may add a parameter called lti_errormsg that includes some detail as to the nature of the error. The lti_errormsg value should make sense if displayed to the user. If the tool has displayed a message to the end user and only wants to give the TC a message to log, use the parameter lti_errorlog instead of lti_errormsg. If the tool is terminating normally, and wants a message displayed to the user it can include a text message as the lti_msg parameter to the return URL. If the tool is terminating normally and wants to give the TC a message to log, use the parameter lti_log. This data should be sent on the URL as a GET - so the TP should take care to keep the overall length of the parameters small enough to fit within the limitations of a GET request.

public mixed LAUNCH_PRESENTATION_RETURN_URL = "launch_presentation_return_url"

LAUNCH_PRESENTATION_WIDTH

launch_presentation_width=320 <p> The width of the window or frame where the content from the tool will be displayed.

public mixed LAUNCH_PRESENTATION_WIDTH = "launch_presentation_width"

LIS_COURSE_OFFERING_SOURCEDID

lis_course_offering_sourcedid=school.edu:SI182-F08 <br/> lis_course_section_sourcedid=school.edu:SI182-001-F08 <p> These fields contain LIS course identifiers associated with the context of this launch. These fields are optional and their content and meaning are defined by LIS.

public mixed LIS_COURSE_OFFERING_SOURCEDID = "lis_course_offering_sourcedid"

LIS_COURSE_SECTION_SOURCEDID

public mixed LIS_COURSE_SECTION_SOURCEDID = "lis_course_section_sourcedid"

LIS_OUTCOME_SERVICE_URL

lis_outcome_service_url=http://lmsng.school.edu/service/ltiout/ <p> This field should be no more than 1023 characters long and the TP should assume that the URL might change from launch to launch and allow for the fact that a TC might change their service URL from launch to launch and only use the most recent value for this parameter. The service URL may support various operations / services.

public mixed LIS_OUTCOME_SERVICE_URL = "lis_outcome_service_url"

The TC will respond with a response of 'unimplemented' for services it does not support.

LIS_PERSON_CONTACT_EMAIL_PRIMARY

lis_person_contact_email_primary=user@school.edu <p> These fields contain information about the user account that is performing this launch. The names of these data items are taken from LIS. The precise meaning of the content in these fields is defined by LIS.

public mixed LIS_PERSON_CONTACT_EMAIL_PRIMARY = "lis_person_contact_email_primary"

LIS_PERSON_NAME_FAMILY

lis_person_name_family=Public <p> These fields contain information about the user account that is performing this launch. The names of these data items are taken from LIS. The precise meaning of the content in these fields is defined by LIS.

public mixed LIS_PERSON_NAME_FAMILY = "lis_person_name_family"

LIS_PERSON_NAME_FULL

lis_person_name_full=Jane Q. Public <p> These fields contain information about the user account that is performing this launch. The names of these data items are taken from LIS. The precise meaning of the content in these fields is defined by LIS.

public mixed LIS_PERSON_NAME_FULL = "lis_person_name_full"

LIS_PERSON_NAME_GIVEN

lis_person_name_given=Jane <p> These fields contain information about the user account that is performing this launch. The names of these data items are taken from LIS. The precise meaning of the content in these fields is defined by LIS.

public mixed LIS_PERSON_NAME_GIVEN = "lis_person_name_given"

LIS_PERSON_SOURCEDID

lis_person_sourcedid=school.edu:user <p> This field contains the LIS identifier for the user account that is performing this launch. The example syntax of "school:user" is not the required format – lis_person_sourcedid is simply a unique identifier (i.e., a normalized string). This field is optional and its content and meaning are defined by LIS.

public mixed LIS_PERSON_SOURCEDID = "lis_person_sourcedid"

LIS_RESULT_SOURCEDID

lis_result_sourcedid=83873872987329873264783687634 <p> This field contains an identifier that indicates the LIS Result Identifier (if any) associated with this launch. This field is optional and its content and meaning is defined by LIS.

public mixed LIS_RESULT_SOURCEDID = "lis_result_sourcedid"

LTI_MESSAGE_TYPE

lti_message_type=basic-lti-launch-request <p> This indicates that this is a Basic LTI Launch Message. This allows a TP to accept a number of different LTI message types at the same launch URL. This parameter is required.

public mixed LTI_MESSAGE_TYPE = "lti_message_type"

LTI_MESSAGE_TYPE_BASICLTILAUNCHREQUEST

public mixed LTI_MESSAGE_TYPE_BASICLTILAUNCHREQUEST = "basic-lti-launch-request"

LTI_MESSAGE_TYPE_CONTENTITEMSELECTION

public mixed LTI_MESSAGE_TYPE_CONTENTITEMSELECTION = "ContentItemSelection"

LTI_MESSAGE_TYPE_CONTENTITEMSELECTIONREQUEST

public mixed LTI_MESSAGE_TYPE_CONTENTITEMSELECTIONREQUEST = "ContentItemSelectionRequest"

LTI_MESSAGE_TYPE_CONTEXTMEMBERSHIPS

public mixed LTI_MESSAGE_TYPE_CONTEXTMEMBERSHIPS = "basic-lis-readmembershipsforcontext"

LTI_MESSAGE_TYPE_CONTEXTMEMBERSHIPSWITHGROUPS

public mixed LTI_MESSAGE_TYPE_CONTEXTMEMBERSHIPSWITHGROUPS = "basic-lis-readmembershipsforcontextwithgroups"

LTI_VERSION

lti_version=LTI-1p0 <p> This indicates which version of the specification is being used for this particular message. This parameter is required.

public mixed LTI_VERSION = "lti_version"

MEDIA_CC

public mixed MEDIA_CC = "application/vnd.ims.imsccv1p1,application/vnd.ims.imsccv1p2,application/vnd.ims.imsccv1p3"

MEDIA_CC_1_1

public mixed MEDIA_CC_1_1 = "application/vnd.ims.imsccv1p1"

MEDIA_CC_1_2

public mixed MEDIA_CC_1_2 = "application/vnd.ims.imsccv1p2"

MEDIA_CC_1_3

public mixed MEDIA_CC_1_3 = "application/vnd.ims.imsccv1p3"

MEDIA_LTILINKITEM

public mixed MEDIA_LTILINKITEM = "application/vnd.ims.lti.v1.ltilink"

NEW_SITE_TYPE

The default site type to use if a site needs to be created. Can be overriden in sakai.properties or as part of the launch.

public mixed NEW_SITE_TYPE = "lti"

This contains a number of preconfigured roles, so that the IMS role vocabulary can be used. See BLTI-151

OAUTH_PREFIX

Parameters with the OAuth prefix are also acceptible.

public mixed OAUTH_PREFIX = "oauth_"

resource_link_description=… <p> A plain text description of the link’s destination, suitable for display alongside the link. Typically no more than several lines long. This parameter is optional.

public mixed RESOURCE_LINK_DESCRIPTION = "resource_link_description"

resource_link_id=88391-e1919-bb3456 <p> This is an opaque unique identifier that the TC guarantees will be unique within the TC for every placement of the link. If the tool / activity is placed multiple times in the same context, each of those placements will be distinct. This value will also change if the item is exported from one system or context and imported into another system or context. This parameter is required.

public mixed RESOURCE_LINK_ID = "resource_link_id"

resource_link_title=My Weekly Wiki <p> A title for the resource. This is the clickable text that appears in the link. This parameter is recommended.

public mixed RESOURCE_LINK_TITLE = "resource_link_title"

ROLE_INSTRUCTOR

public mixed ROLE_INSTRUCTOR = "Instructor"

ROLES

roles=Instructor,Student <p> A comma-separated list of URN values for roles. If this list is non-empty, it should contain at least one role from the LIS System Role, LIS Institution Role, or LIS Context Role vocabularies (See Appendix A). The assumed namespace of these URNs is the LIS vocabulary of LIS Context Roles so TCs can use the handles when the intent is to refer to an LIS context role. If the TC wants to include a role from another namespace, a fully-qualified URN should be used. Usage of roles from non-LIS vocabularies is discouraged as it may limit interoperability. This parameter is recommended.

public mixed ROLES = "roles"

TEXT

text=... (Optional)

public mixed TEXT = "text"

Default text to be used as the visible text for the content item returned by the TP. If no text is returned by the TP, the TC may use the value of the title parameter instead (if any). This value may be a long description of the content item.

TITLE

title=... (Optional)

public mixed TITLE = "title"

Default text to be used as the title or alt text for the content item returned by the TP. This value should normally be short in length, for example, suitable for use as a heading.

TOOL_CONSUMER_INFO_PRODUCT_FAMILY_CODE

tool_consumer_info_product_family_code=desire2learn <p> In order to better assist tools in using extensions and also making their user interface fit into the TC's user interface that they are being called from, each TC is encouraged to include the this parameter. Possible example values for this field might be:

public mixed TOOL_CONSUMER_INFO_PRODUCT_FAMILY_CODE = "tool_consumer_info_product_family_code"

learn desire2learn sakai eracer olat webct This parameter is optional but recommended.

TOOL_CONSUMER_INFO_VERSION

tool_consumer_info_version=9.2.4 <p> This field should have a major release number followed by a period. The format of the minor release is flexible. Possible vaues for this field might be:

public mixed TOOL_CONSUMER_INFO_VERSION = "tool_consumer_info_version"

9.1.7081 2.8-01 7.1 8 The Tool Provider should be flexible when parsing this field. This parameter is optional but recommended.

TOOL_CONSUMER_INSTANCE_CONTACT_EMAIL

tool_consumer_instance_contact_email=System.Admin@school.edu <p> An email contact for the TC instance.

public mixed TOOL_CONSUMER_INSTANCE_CONTACT_EMAIL = "tool_consumer_instance_contact_email"

TOOL_CONSUMER_INSTANCE_DESCRIPTION

tool_consumer_instance_description=University of School (LMSng) <p> This is a user visible field - it should be about the length of a line.

public mixed TOOL_CONSUMER_INSTANCE_DESCRIPTION = "tool_consumer_instance_description"

TOOL_CONSUMER_INSTANCE_GUID

tool_consumer_instance_guid=lmsng.school.edu <p> This is a key to be used when setting a TC-wide password. The TP uses this as a key to look up the TC-wide secret when validating a message. A common practice is to use the DNS of the organization or the DNS of the TC instance. If the organization has multiple TC instances, then the best practice is to prefix the domain name with a locally unique identifier for the TC instance. This parameter is recommended.

public mixed TOOL_CONSUMER_INSTANCE_GUID = "tool_consumer_instance_guid"

TOOL_CONSUMER_INSTANCE_NAME

tool_consumer_instance_name=SchoolU <p> This is a user visible field - it should be about the length of a column.

public mixed TOOL_CONSUMER_INSTANCE_NAME = "tool_consumer_instance_name"

TOOL_CONSUMER_INSTANCE_URL

Missing from implementation guide. Needs documentation. Not required, but "tasty".

public mixed TOOL_CONSUMER_INSTANCE_URL = "tool_consumer_instance_url"

TYPE_CONTENTITEM

public mixed TYPE_CONTENTITEM = "ContentItem"

TYPE_IMPORTITEM

public mixed TYPE_IMPORTITEM = "ImportItem"
public mixed TYPE_LTILINK_OLD = "LtiLink"

TYPE_LTILINKITEM

public mixed TYPE_LTILINKITEM = "LtiLinkItem"

USER_ID

user_id=0ae836b9-7fc9-4060-006f-27b2066ac545 <p> Uniquely identifies the user. This should not contain any identifying information for the user. Best practice is that this field should be a TC-generated long-term "primary key" to the user record - not the logical key. This parameter is recommended.

public mixed USER_ID = "user_id"

USER_IMAGE

user_image=http://my.sakai.org/direct/profile/0ae836b9-7fc9-4060-006f-27b2066ac545/image <p> This attribute specifies the URI for an image of the user who launched this request.

public mixed USER_IMAGE = "user_image"

This image is suitable for use as a "profile picture" or an avatar representing the user. It is expected to be a relatively small graphic image file using a widely supported image format (i.e. PNG, JPG, or GIF) with a square aspect ratio. This parameter is optional.


        
On this page

Search results