New Column in CD2/DAP Query API: unified_tool_id in context_external_tools Table

[sgergely]

We’re excited to announce an update to the context_external_tools table in the Canvas namespace of the DAP Query API. On 31st of March in 2025, we will be adding a new column:

unified_tool_id: A unique identifier for the external tool, helping Canvas institutions better track and analyze LTI tools across their instance.

This enhancement is part of our long-term goal to improve existing tool data.

What You Need to Know

1. New Column Addition
   1. Column Name: unified_tool_id
   2. Type: Optional(Annotated[str, MaxLength(255)])
   3. Purpose: The unified_tool_id field will help us provide better reports for installed tools in a Canvas instance by matching them with our LTI tool metadata single source of truth.
2. Important Considerations
   1. Not all LTI tools will be given a unified_tool_id. Instructure is committed to creating a unified_tool_id for the most commonly used LTI tools.
      1. Please note that homegrown LTI tools will not be given a unified_tool_id in the foreseeable future.
   2. Usage of an LTI tool through the Redirect LTI tool will not be able to be aggregated and analyzed since the Redirect tool is a separate LTI tool itself. 
   3. Tool IDs Can Change
      1. The tool ID and its associated tool may change at any time, as we reserve the right to update identifiers dynamically. However, historical data will remain the same and not get updated retroactively.
      2. This means that while unified_tool_id adds valuable tracking capabilities, users should not assume permanent consistency of a specific tool ID.
   4. Why This Matters
      1. Helps institutions track LTI tools across their instance.
      2. Enables better reporting and analytics on external tools.
      3. Moves us closer to providing standardized LTI usage data within DAP.

If you’re a DAP CLI user, no action is required on your part—CLI automatically handles new columns and its values seamlessly.

The new data is going to be available through incremental queries, no need to do a full snapshot of the context_external_tools table.

The documentation is going to be updated once the release is out, so it always documents the current, live state of the system.

[IanGoh]

I applaud more transparency in LTI usage.

Will the unified_tool_id be something human readable or some cryptic UUID that we have no idea how to match up to the single source of truth?

Yours

Ian

[teryn_odom]

Hi @IanGoh! The unified_tool_id is indeed a UUID to ensure that there is a single source of truth/one ID per tool to improve tracking and referencing LTI usage data without overlap. We will continue to work toward transparency to ensure that admins are equipped with the information needed to make analyzing their LTI usage as quick and easy as possible. Let us know if you have additional questions!

[KNGoh]

Hi @sgergely and @teryn_odom, I am not a DAP CLI user and need to manually handle the new column.

What will be the updated table structure for context_external_tools including the new field? Specifically, what position will unified_tool_id be in the table? Is it added to the end of the table?

[sgergely]

Hey @KNGoh!

That is a really good question. Assuming you are asking where it would be in the schema that the schema endpoint provides for that table: it will be added to the end of the list of fields.

Hope this answers your question.