Setting up a Deep Linking-enabled tool

In order to set up a deep linking enabled tool, consult with your tool provider to ensure that it supports deep linking. It's important to remember that both the platform and tool must support the same extensions for these to work. Assuming that support is not an issue, an LMS administrator must register and deploy a new 1.3 learning tool. Extensions require the Keyset URL. This URL is needed for the tool and platform to communicate and use the extensions. Once defined, ensure that you select the check box to enable the Deep Linking extension.

 

  1. Navigate to the tool deployment page.
  2. Click View Link.
  3. Click New Link.
  4. Complete the following fields on the Create Link screen:
    • Name: The desired name for your content selector. The name you specify here is the name that will appear in the UI in other areas.
    • URL: The launch point URL that the user navigates to when they click the content selector.
    • Description: An optional description that will help users understand what this tool does.
    • Type: The type defined dictates on how this link can be used. The default value is Basic Launch, meaning the link only performs the usual LTI launch. For deep linking, change this to be one of the following deep linking selectors types supported by Brightspace:
      • Deep Linking Quicklink: Exposes the link as a content selector in our quicklink menu areas.
      • Deep Linking Insert Stuff: Exposes the link as a content selector in the Insert Stuff HTML Editor area.
        • Note that the plugin used should be dictated by the tool provider.
    • Width and Height: When selecting content Brightspace opens an iFrame displaying the tool UI to discover content. These settings dictate the size of the iFrame.
    • Substitution Parameters: Users can select from a pre-defined list of parameters that is dynamically substituted with a value from the LMS at the time of launch. Brightspace currently supports the following parameters:
      • $CourseSection.timeFrame.begin
      • $CourseSection.timeFrame.end
      • $ResourceLink.available.startDateTime
      • $ResourceLink.available.endDateTime
      • $ResourceLink.submission.endDateTime
    • Custom Parameters: In instances where tools need to define both the name and value of a custom parameter, they can be defined here. These parameters are not dynamically replaced, and are constrained to sending a static value for each launch.
  5. Click Save and Close.

If you created a deep linking Quicklink, you can find it in the content area as follows:

  • Using the Classic Content Experience:
    1. Navigate to Content.
    2. Select a module.
    3. Click Add Existing Activities.
    4. Select the desired item.
  • Using the New Content Experience:
    1. Navigate to Content.
    2. Select a module.
    3. Click Add.
    4. Select desired user quicklink.

Content selector links created will show up in these menus as a starting point to selecting content. After click your desired tool, a window will open and launch the user through the tool's specific experience. Whether creating an activity or selecting content through discovery, the tool will help return back exactly the content the user wants.

If you created a deep linking Quicklink, you can find it in the content area as follows:

Using the Classic Content Experience:

  1. Navigate to Content.
  2. Select a module.
  3. Click Add Existing Activities.
  4. Select the desired item.

Using the New Content Experience:

  1. Navigate to Content.
  2. Select a module.
  3. Click Add.
  4. Select desired user quicklink.