Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

LTI ContentItem Enhancements: Difference between revisions

From MoodleDocs
No edit summary
Line 20: Line 20:
This work is being undertaken with the support of [http://www.cengage.com/ Cengage].
This work is being undertaken with the support of [http://www.cengage.com/ Cengage].


== Introduction ==
== Improvements to current External Tool select content flow ==


As mentioned above the focus of this project will be improve the user experience and streamline the link creation process of the IMS Content-Item Message implementation within Moodle. To that end the following enhancements will be undertaken as part of this effort:
As mentioned above the focus of this project will be improve the user experience and streamline the link creation process of the IMS Content-Item Message implementation within Moodle. To that end the following enhancements will be undertaken as part of this effort:
Line 32: Line 32:
The current lightbox displayed by Moodle on a Content-Item Message request is rather small and often results in the need for the user to scroll vertically and horizontally. This project would update the lightbox to be larger based on screen dimensions.
The current lightbox displayed by Moodle on a Content-Item Message request is rather small and often results in the need for the user to scroll vertically and horizontally. This project would update the lightbox to be larger based on screen dimensions.


'''Support for multiple content items and automatic creation'''
== Direct Content Item flow from Activity Chooser ==


The current Moodle Content-Item implementation only allows for receipt of a single content item per request. The project will update the implementation to support receipt of multiple content-items. Additionally, this project will add support for the auto_create flag which will allow for creation of content items in Moodle without the need for manual review and acceptance (i.e., the user will not be presented with the screen prompting them to accept the content items). Both multiple content-item and auto_create are part of the IMS Content-Item Message specification so the implementation will still be in alignment with the standard. The auto_create option will be configurable.
A new flow is added to skip the External Tool page when launching from the Activity Chooser. The goal is to make the external tool feel more integrated and behave more like an Activity Module. It also allows for the creation of '''multiple''' links in a single interaction.
 
=== Changes to the Tool Configuration ===
 
The new behavior will be an opt-in flow, thus not impacting current deployments. The new option is the tool settings is to skip the External Tool page when adding an activity from the activity chooser. This option is only available if the tool supports the Content Item flow; it also requires the tool to be listed in the activity chooser. This setting does not change the flow when the link is added using the External Tool option.
 
=== Streamlined add flow ===
 
Once the tool is configured to skip the External Tool page, when a user selects the tool directly in the activity chooser, the user is sent directly to the Tool Provider using the ContentItemSelectionRequest launch. The parameters in the launch now include:
- '''autocreate: true''' indicating the links will be created directly on return
- '''multiple: true''' indicating it is ok to return more than one LTI Link Content Item
 
http://claudeonthe.net/cengage/img/mdl_mock_add_cisr.png
 
On return, all links are created. If a content item contains a LineItem (gradebook column), a Grade Item is also configured accordingly.

Revision as of 20:34, 18 July 2017

LTI Content-Item Enhancements
Project state Planning
Tracker issue MDL-59402
Discussion Enhancing support for IMS Content-Item message
Assignee Stephen Vickers


Project goal

The goal of this project is to enhance the existing IMS Content-Item Message implementation in Moodle. IMS Content-Item Message is an extension of the IMS Learning Tool Interoperability (LTI) specification that allows for sharing of content, typically LTI links, between two systems. The enhancements developed as part of this project will provide a more streamlined link creation process and an improved user experience.

Specifically, these enhancements will:

  • Allow instructors and course designers to add multiple content items at once; eliminating the need to access a content selector each time a link is to be added
  • Support a more streamlined workflow where content items can optionally be added automatically without any manual intervention
  • Enhance the user experience of using a content selector within Moodle by increasing the size of the lightbox where the content selector is rendered

This work is being undertaken with the support of Cengage.

Improvements to current External Tool select content flow

As mentioned above the focus of this project will be improve the user experience and streamline the link creation process of the IMS Content-Item Message implementation within Moodle. To that end the following enhancements will be undertaken as part of this effort:

Support for thumbnail

Content items returned to Moodle in a Content-Item Message response optionally contain a thumbnail (i.e., images to be displayed along with link text) data. Currently Moodle does not support display of the thumbnails received as part of a content item. This project would add support for both the thumbnail.

Support for a larger lightbox for display of a content selector

The current lightbox displayed by Moodle on a Content-Item Message request is rather small and often results in the need for the user to scroll vertically and horizontally. This project would update the lightbox to be larger based on screen dimensions.

Direct Content Item flow from Activity Chooser

A new flow is added to skip the External Tool page when launching from the Activity Chooser. The goal is to make the external tool feel more integrated and behave more like an Activity Module. It also allows for the creation of multiple links in a single interaction.

Changes to the Tool Configuration

The new behavior will be an opt-in flow, thus not impacting current deployments. The new option is the tool settings is to skip the External Tool page when adding an activity from the activity chooser. This option is only available if the tool supports the Content Item flow; it also requires the tool to be listed in the activity chooser. This setting does not change the flow when the link is added using the External Tool option.

Streamlined add flow

Once the tool is configured to skip the External Tool page, when a user selects the tool directly in the activity chooser, the user is sent directly to the Tool Provider using the ContentItemSelectionRequest launch. The parameters in the launch now include: - autocreate: true indicating the links will be created directly on return - multiple: true indicating it is ok to return more than one LTI Link Content Item

http://claudeonthe.net/cengage/img/mdl_mock_add_cisr.png

On return, all links are created. If a content item contains a LineItem (gradebook column), a Grade Item is also configured accordingly.