Sakai v25: How to Add a Stealthed Tool

Owned by Andrea Schmidt, created
Last updated: Sept 26, 2024
3 min read

The ability to add a stealthed tool and add it to several sites at once will work for both LTI 1.1 and 1.3.

Tsugi Admin Setup

Log into https://sakai.tsugicloud.org/tsugi/admin/

  1. Click Manage Access Keys

  2. Click Tenant Keys

  3. Click Insert Tenant

    1. Add a key title

    2. Enter a key in LTI 1.1: OAuth Consumer Key - This key needs to be unique in Tsugi. Do not use 12345 for the key

    3. Leave LTI 1.1: OAuth Consumer Secret empty

    4. For User Id enter: 1

    5. Save the key

  4. Click on the tenant just created (you may have to search for it)

    1. Click Edit

    2. For Dynamic Registration Unlock Code (one time use) enter: 42

    3. Save the key

    4. Click on the key again

  5. Click on the Sakai tab > and click Copy beside LTI Dynamic Registration URL. You will need this URL in Sakai

Note: another option to add the tenant, is to skip the unique key (3-b), but enter a LTI 1.3: Deployment ID and continue with 3-d.

Important! Make sure to add any tools to your sites that will be used as placements before adding the stealthed tools. The options are Lessons, Assignments and rich text editor for both the deep link (“store”) and the single LTI tool.

Sakai Admin Setup

Log into Sakai as an admin to > Worksite Setup > Administration Workspace > External Tools

  1. On the External Tools page, click the Install LTI Tool button

  2. Install LTI Tool page displays with the following fields:

    • Tool Title (required)

    • Site ID (Normally Left Blank)

  3. Enter a tool title and click Continue

  4. External Tool form displays

  5. The form already contains the Tool Title, so click Use LTI Dynamic Registration

  6. LTI Dynamic Registration pop-up displays

  7. Paste the URL you copied from the Tenant Entry page when you created the entry in Tsugi and click Begin Configuration - Page displays with configuration information

  8. Click Continue Registration in the LMS - Pop-up displays, asking "Do you want to change the title of this tool to: Sakai"

  9. Click Cancel to keep the tool title you entered above - External Tool page displays with a pop-up "Imported auto configuration data into the form, please review and save."

  10. Click OK on the pop-up - External Tool page displays with values populated

  11. Enter a Description, if desired

  12. The Tool Status is set to Enabled by default (keep this setting)

  13. Tool Visibility is set to Visible by default - change this to Stealthed (Manual Deployment)

  14. A button appears at the top of the page: Deploy Tool to Sites

  15. Click Deploy Tool to Sites

    • Tool Deployment pop-up displays

    • Text displays: The tool is not available in any sites

    • A Deploy Tool to Sites button displays

  16. Click Deploy Tool to Sites

  17. Manual Tool Deployment form displays

    • Notes field: enter a note if you wish

    • Textarea for Site Ids

  18. Enter the Site Ids where the tool should be added

  19. Click Save

  20. A Success message displays followed by a table containing the sites to which the tool was deployed

  21. Close the pop-up

  22. Replace the example launch URL with the URL of the tool

  23. Scroll down to “The launch URL for this tool…”

    • If you’re adding the “store”, check the box: The tool URL supports a "resource picker" experience with one or more tools (Deep Link launch)

    • If you’re adding a single tool, (Trophy, Breakout, etc), check the box: The tool URL supports a single LTI tool (Resource Link launch)

  24. For the section “Indicate where in the Sakai User interface that these tools should appear”, check the appropriate box

  25. For Privacy Settings, check the items needed. If you’re adding the “store” or any single tool that passes grades, you’ll want all of them

  26. For Services, check the items needed. If you’re adding the “store” or any single tool that passes grades, you’ll want all of them

  27. Click Save

Adding/Editing Stealthed Placements

After a stealthed tool has been added and deployed to a site(s), the External Tools page will contain a number in the Deployment column.

  1. Click on the number in the Deployment column

  2. The Manual Tool Deployment page displays (listing any existing sites)

  3. To add another site, click the Deploy Tool to Sites button and add the Site Ids

  4. To add a note for a site, click Edit

  5. To remove the tool from a site, click Delete

 Related articles