Skip to main content

Setting Up LTI 1.3

1. Share Information​

To connect to the TMA Tool using LTI 1.3, provide TMA with the following details about your Platform:

  • Platform Id
  • Client Id
  • Deployment Id
  • Public Keyset URL
  • Access Token URL
  • Authentication Request URL

2. Gather Information​

TMA will provide you with the following details to configure your Platform:

  • Login Initiation URL: URL that initiates the LTI connection.
  • Tool Link URL: URL that launches users into the TMS after a successful connection.
  • Public Key: Shared on demand for authentication and authorization.
  • Application ID: Identifies customer environments and determines the redirect flow.

3. Configure the Tool​

  1. Log in to your Platform or LMS as an administrator.
  2. Navigate to LTI integration settings (location varies per platform).
  3. Add a new LTI 1.3 tool or integration and enter the following:
    • Tool Name: A user-friendly name for the TMA Tool.
    • Client ID: Provided by TMA.
    • Client Secret: Generated by TMA.
    • LTI Request URL: Provided by TMA.
    • Redirect URL: Provided by TMA.
  4. Add a custom field in JSON format named ApplicationId, including:
    • Application ID (required)
    • Gender (optional: 1 for male, 2 for female)
  5. Configure user roles and permissions as needed.
  6. Save and enable the integration.

Testing the Connection

After configuring the TMA Tool, follow these steps:

  1. Create a course, assignment, or activity in your Platform.
  2. Add the TMA Tool to the course or assignment.
  3. Launch the TMA Tool from your Platform.
  4. Ensure the POST request from the Platform contains the login hint.
  5. Verify the exchange of data between your Platform and the TMA Tool.
  6. When launching a new candidate, verify account creation by providing:
    • First Name
    • Infix (optional)
    • Last Name
    • Gender
    • Email Address/Username
    • Password
  7. After storing the data, an account is created, and TMA-170 or TMA-312 begins.
  8. On subsequent launches, the candidate should be redirected directly into TMS.

Continuous Access

Candidates can access TMS using LTI Launch or by logging in with a username and password for one year (default grace period). Once expired, a status update is sent to the Platform, restricting Tool access until re-enabled.

Additional Features

1. Additional Login Parameters​

We support:

  • given_name: First name(s) per OIDC.
  • family_name: Surname(s) per OIDC.
  • middle_name: Candidate infix.
  • email: Candidate’s business email address.

2. Status Updates​

The TMA Tool sends status updates to inform the Platform of user progress:

  • Activity Progress: In Progress, Completed.
  • Grading Progress: Pending, FullyGraded.

The most recent lineitemUrl is used for updates.

Unsupported Features

  • Deep Linking is not currently supported.
  • Multiple Line Items: Only a single line item is supported.
  • Role Mapping: All candidates receive a default role.

Portal Changes for LTI-Enabled Portals

1. Deactivation/Deletion​

  • Candidates created via LTI cannot be deleted, only deactivated.
  • A warning message appears when deactivating candidates.

2. Starting TMA​

  • A TMA analysis starts automatically for new candidates.
  • Admins can select between TMA-170 and TMA-312.

Troubleshooting

If issues arise:

  • Verify credentials and configuration settings.
  • Consult LTI 1.3 documentation.
  • Contact TMA support if issues persist.

Additional Resources