# Annoto Package for Moodle Installation Guide

## Overview

This document details the steps required to install the Annoto Engagement Package for Moodle.

## Prerequisites <a href="#prerequisites" id="prerequisites"></a>

* API Key (Client ID)
* SSO secret
* Registration Keys
  * Annoto Dashboard
  * Annoto Assignment

## Installation Process <a href="#installation-background" id="installation-background"></a>

* **Annoto Moodle Local plug-in** used to:&#x20;
  * Load Annoto's in-video engagement widget for automatic detection and adjustment based on the player type running on the page.&#x20;
  * Enable Annoto Activity Completion.&#x20;
* **Annoto Assignment**: Annoto's in-video engagement widget and allows for grading activities to sync with Moodle Gradebook.
* **Annoto Dashboard**: Enables managing course activities and gaining actionable insights on learners and video content delivered.

### Install Annoto Local Plugin <a href="#install-annoto-local-plugin" id="install-annoto-local-plugin"></a>

1. Install the latest Annoto Local Plugin from: [https://moodle.org/plugins/local\_annoto](https://moodle.org/plugins/local_annoto)

{% hint style="info" %}
For guidance on how to install a plugin in Moodle please refer to the following link: [https://docs.moodle.org/en/Installing\_plugins](https://docs.moodle.org/en/Installing_plugins)

Or see this interactive guide:&#x20;

### [#interactive-step-by-step-for-adding-annoto-local-plugin](#interactive-step-by-step-for-adding-annoto-local-plugin "mention")


{% endhint %}

2. After the plugin is installed, Enter the API Key and SSO Secret.

<figure><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LRdI6n_jV_tV8BQXk-o%2Fuploads%2FqFUmTPnYtnrYOOc2YBIw%2Fimage.png?alt=media&#x26;token=ee056087-a384-4792-a312-8d22e62a81f2" alt=""><figcaption></figcaption></figure>

3.  Now click "Save" at the bottom of the settings page.

    <figure><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LRdI6n_jV_tV8BQXk-o%2Fuploads%2FS1fUYXz4ttgP9jaD1Pni%2Fimage.png?alt=media&#x26;token=5859dfa0-0503-4b7b-a124-53ccf363bad6" alt=""><figcaption></figcaption></figure>

    Note If you want to learn more about the plugin settings:

{% content-ref url="widget-integration/annoto-local-plugin-settings" %}
[annoto-local-plugin-settings](widget-integration/annoto-local-plugin-settings)
{% endcontent-ref %}

### Adding the Annoto Dashboard <a href="#adding-the-annoto-dashboard" id="adding-the-annoto-dashboard"></a>

1. Login as Administrator
2. Enter: Site administration -> Plugins -> Activity modules -> External Tools -> Manage Tools.

<figure><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LRdI6n_jV_tV8BQXk-o%2Fuploads%2Fdk5S4zSDDUJ5cT7qQ9Wc%2Fimage.png?alt=media&#x26;token=ee0448f4-a121-4d82-b58b-510a075658d1" alt=""><figcaption></figcaption></figure>



3. In the text box labeled **"Tool URL..."** enter the specific link based on your deployment:

* EU: [https://auth.eu.annoto.net/lti/register\_dashboard](https://auth.eu.annoto.net/lti/register_dashboard)
* US: [https://auth.us.annoto.net/lti/register\_dashboard](https://auth.us.annoto.net/lti/register_dashboard)

4. Click on **"Add LTI Advantage"**

<figure><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LRdI6n_jV_tV8BQXk-o%2Fuploads%2FTC0iEnt4n3Z0vYffpcd8%2Fimage.png?alt=media&#x26;token=6e5e6f2e-fa56-47f5-ac92-0088c68e8cc5" alt=""><figcaption></figcaption></figure>

5. Enter the API Key (Client ID) and Registration Key (Received for each tool)
6. Click "REGISTER"

<figure><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LRdI6n_jV_tV8BQXk-o%2Fuploads%2FXUpXwYlgHXk4VAtg6RHm%2Fimage.png?alt=media&#x26;token=340db7f3-e418-4380-9fd0-b6a0d19401ab" alt=""><figcaption></figcaption></figure>

Now the new Tool is added:

<figure><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LRdI6n_jV_tV8BQXk-o%2Fuploads%2FdCCwpftKMhWY8kGMUiVj%2Fimage.png?alt=media&#x26;token=f7ec7b49-1ce2-4715-8926-24a780ff8dd6" alt=""><figcaption></figcaption></figure>

7. Click on the Edit icon
8. Change the "Tool configuration usage" type to "Show in activity chooser and as a preconfigured tool"

<figure><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LRdI6n_jV_tV8BQXk-o%2Fuploads%2FajcKMvJgVInAvutpPCPL%2Fimage.png?alt=media&#x26;token=04dd409a-bb10-49d3-8f99-e24dd8c7adfd" alt=""><figcaption></figcaption></figure>



### Adding Annoto Assignment <a href="#adding-annoto-assignment" id="adding-annoto-assignment"></a>

Repeat the steps 4-8 for Adding Annoto Assignment

* In the text box labeled **"Tool URL..."** enter the specific link based on your deployment:
  * EU:  [https://auth.eu.annoto.net/lti/register\_embed](https://auth.eu.annoto.net/lti/register_embed)
  * US: [https://auth.us.annoto.net/lti/register\_embed](https://auth.us.annoto.net/lti/register_embed)

When seeing this message:

<figure><img src="https://4216168529-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LRdI6n_jV_tV8BQXk-o%2Fuploads%2Fdr6ZnpldC1zM4Lejy93B%2Fimage.png?alt=media&#x26;token=3bcd6a84-99b4-4e43-bde3-3bdf79a9bac9" alt=""><figcaption></figcaption></figure>

Click on "Register as a new external tool"

**That's it!**

## **Interactive Step by Step for Adding Annoto Local Plugin**

{% embed url="https://guidejar.com/guides/49f273a7-ca3d-437a-8e31-a34eef61be9b" fullWidth="true" %}

## **Interactive Step by Step for** Annoto Dashboard and Annoto Assignment Tools

{% embed url="https://guidejar.com/guides/31e2f724-178f-481e-91e5-5ba5b66aed1f" fullWidth="true" %}

## Support

If you need any additional information or have any questions, please contact us at [Annoto Support](mailto:support@annoto.net?subject=Annoto%20Support)

## Last but not least

In order to learn more about all the wonderful things you can do with Annoto, visit: [Getting Started in Moodle](https://docs.annoto.net/guides/lms/moodle)
