> ## Documentation Index
> Fetch the complete documentation index at: https://support.nectir.io/llms.txt
> Use this file to discover all available pages before exploring further.

# LTI Manual Registration

> How to manually integrate Nectir AI in D2L Brightspace

export const entity_1 = "Assistant"

export const entity_0 = "Workspace"

<Note>
  This guide is intended for LMS administrators. If you encounter any issues during the integration process, please contact [support@nectir.io](mailto:support@nectir.io).
</Note>

## Configuring Nectir AI

The D2L Brightspace integration process consists of three main steps: creating a Tool, creating a Deployment of that Tool, and creating a Link based on the Deployment that you can place in your courses. Follow the step-by-step instructions below to complete the integration.

### Create the Tool

1. Within D2L, go to **Admin Tools** > **Manage Extensibility**
2. Go to **LTI Advantage** tab
3. Select **Register Tool**
4. Choose **Standard** registration
5. Input the following information:
   * **Name**: Nectir AI - Tool
   * **Description**: Nectir AI is a platform that enables educators to create custom AI Assistants to provide personalized support and feedback to students, right within the LMS.
   * **Domain**: [https://ai.nectir.io](https://ai.nectir.io)
   * **Redirect URLs**: [https://ai.nectir.io/api/lti13/validate](https://ai.nectir.io/api/lti13/validate)
   * **OpenID Connect Login URL**: [https://ai.nectir.io/api/lti13/login](https://ai.nectir.io/api/lti13/login)
   * **Target Link URI**: [https://ai.nectir.io/api/lti13/validate](https://ai.nectir.io/api/lti13/validate)
   * **Keyset URL**: [https://ai.nectir.io/api/lti13/keys](https://ai.nectir.io/api/lti13/keys)
   * **Extensions**:
     * **Assignment and Grade Services**: True
     * **Deep Linking**: True
     * **Names and Role Provisioning Services**: True
   * **Roles**:
     * **Send Institution role**: True
   * **Custom Parameters**:
     * **Name**: `workspaceId` | **Value**: `YOUR_WORKSPACE_ID`

       <Tip>
         You can find your {entity_0} ID by going to **Nectir AI** > **{entity_0} settings** <Icon icon="gear" iconType="solid" color="black" /> > Copy and paste the **{entity_0} ID** field
       </Tip>
6. Click **Register**
7. After you register your Tool, make sure it's **Enabled**

### Create the Deployment

1. Now go to **Admin Tools** > **External Learning Tools**
2. On the **LTI Advantage** tab, select **New Deployment**
3. Input the following information:
   * **Enabled**: True
   * **Auto Migrate Links**: True
   * **Tool**: Nectir AI - Tool
   * **Name**: Nectir AI - Deployment
   * **Description**: Nectir AI is a platform that enables educators to create custom AI Assistants to provide personalized support and feedback to students, right within the LMS.
   * **Extensions**:
     * **Assignment and Grade Services**: True
     * **Deep Linking**: True
     * **Names and Role Provisioning Services**: True
   * **Security Settings**:
     * **Org Unit Information**: True
     * **User Information**: True
     * **Classlist including users not known to this Deployment**: True
   * **Configuration Settings**:
     * **Open as External Resource**: (If you want Nectir AI to open within D2L Brightspace as an iframe, leave unchecked. Otherwise, if you want to open it in a new tab, click the checkbox)
   * For the "Org Units" section, choose the org unit that encompasses all the courses you want to provision access to, based on your D2L org hierarchy. If you want to include your entire org, make sure you include all descendants.
4. Click **Create Deployment**

### Create the Link

1. After you create your Deployment, click the newly created Deployment, and scroll down to the bottom and select **View Links**
2. Select **New Link**
3. Input the following information:

* **Name**: Nectir AI - Link
* **URL**: [https://ai.nectir.io/api/lti13/validate](https://ai.nectir.io/api/lti13/validate)
* **Description**: Nectir AI is a platform that enables educators to create custom AI Assistants to provide personalized support and feedback to students, right within the LMS.
* **Type**: Basic Launch

1. Click **Save and Close**
2. After you save your Link, navigate to a course to test it. Once you're in the course, click the **Content** tab and select **Existing Activities** > **External Learning Tools**. Choose the **Nectir AI** Link, and test the integration. If you don't see the Nectir AI Link, visit [Troubleshooting](#troubleshooting). You should receive:

```
{"error":"LTI 1.3 Error - getPlatform: unregistered or invalid LTI platform"}
```

<Warning>
  After completing these steps, contact your Nectir AI representative to
  complete the final configuration on their side.
</Warning>

### Linking to a Specific Assistant (Optional)

If you would like to have the Nectir AI Link open to a specific Assistant, follow these steps:

1. In D2L, go to the course you want to add the **Link** to
2. Navigate to **Course Admin** > **External Learning Tools** > **LTI Advantage** and click **New Link**
3. Input the following information:
   * **Deployment**: Nectir AI - Course Link
   * **Name**: Nectir AI
   * **URL**: [https://ai.nectir.io/api/lti13/validate](https://ai.nectir.io/api/lti13/validate)
   * **Description**: Nectir AI is a platform that enables educators to create custom AI Assistants to provide personalized support and feedback to students, right within the LMS.
   * **Custom Parameters**:
     * **Name**: `assistantId` | **Value**: `YOUR_ASSISTANT_ID`

       <Tip>
         You can find your {entity_1} ID by going to **Nectir AI** > **{entity_1} settings** <Icon icon="gear" iconType="solid" color="black" /> > Copy and paste the **{entity_1} ID** field
       </Tip>

## Adding Nectir AI to a Course

1. Navigate to your course in D2L Brightspace
2. Click the **Content** tab
3. Select the module where you want to add Nectir AI
4. Click the **Existing Activities** dropdown and select **External Learning Tools**
5. Select the **Nectir AI** Link
6. The Tool is now available in your course

## Troubleshooting

* If your Link isn't appearing as an option when you click **Existing Activities** > **External Learning Tools**, go to your **Deployment** and make sure the course you are using to test is within the selected **Org Units**.
* If your students don't sync from your roster to Nectir AI, go to your **Deployment** by clicking **Admin Tools** > **External Learning Tools**, and click the Nectir AI **Deployment**. Once you're there, scroll down to **Security Settings** and ensure that you select **Org Unit Information**, **User Information**, and **Classlist including users not known to this Deployment**.
* Reload the page
* Verify that you entered all URLs and parameters correctly
* Ensure you enable Nectir AI at the Tool level
* Contact your Nectir AI representative for further help at [support@nectir.io](mailto:support@nectir.io)