Skip to content
English
File a Support Ticket Customer Portal Sign in
  • There are no suggestions because the search field is empty.

Atomic Search 1.3 Installation - Canvas

1. Uninstall other installs of Atomic Search

If Atomic Search was installed during an evaluation, remove those installs first, or the Search menu will appear multiple times.

In the Canvas account or course where it was installed, go to Settings > Apps > View App Configurations, click the gear menu next to Atomic Search, and choose Delete.

2. Create and assign the Atomic Search service user role

If you installed a trial of Atomic Search you can skip this step as the service user should have been created as part of the trial. If you have not yet created the service user please complete these additional steps. 

Create the User Account

    1. Log in as a Canvas Root Admin and go to the root level account and click on the People section

    2. Create a new service user with a unique email address and set a password for the Canvas user. Save the credentials. You will need to log in as this user later.

Define Permissions

    1. Create a new Canvas Account level role for Atomic Search under the Permissions section.
    2. Limit the permissions of the Atomic Search role as described in the table below:
# Permission Why it is needed:
1 Announcements - view Retrieve announcement content for indexing.
2 Course Content - view Retrieve course content for indexing.
3 Courses - view list List the courses in an account for indexing.
4 Discussions - view Retrieve the name and description of discussions for indexing.
5 Assignments and Quizzes - edit Find out if assignments and quizzes are published or unpublished.
6 Manage LTI  Install the Atomic Search external application into a course or sub-account. This permission can be removed after Atomic Search is installed.
7 Question banks - view and link Retrieve quiz and question content for indexing.
8 Users - view list Find out what courses a user is enrolled in and what their role is in those courses. Atomic Search uses this information to limit what the user can search. 

Assign the service user this role:

    1. Browse back to the root account and go to Settings > Admins
    2. Scroll to the bottom and click on +Account Admins.
    3. Select the Atomic Search user role from the Add More drop-down list.
    4. Enter the service user's email or SIS ID, click Continue, confirm the user resolves correctly, and select OK Looks Good, Add This 1 User.

3. Enable the Atomic Jolt Application Installer developer key

    1. Browse to the root/sub-account level. Select Developer Keys in the left-hand Canvas navigation menu.
    2. Click on the Inherited tab near the top.
    3. Scroll to the bottom of the page and click Show All Keys.
    4. Scroll down until you see the Atomic Jolt Application Installer developer key.
    5. If the key is not On, select On.


4. Create the Atomic Search LTI Dynamic Registration key

To install, you must create a new LTI Key under the Developer key section.

    1. Go to the Developer Keys menu and navigate to the Account tab.
    2. Click on + Developer Key button and choose + LTI Dynamic Registration.
    3. Copy and Paste the URL for the region you are installing in, your data will live in the following servers so ensure that you select the correct region.
      1. US/Canada/Central and South America - https://search.atomicjoltapps.com/lti_dynamic_registrations
      2. Europe, Africa - https://search.atomicjoltappsie.com/lti_dynamic_registrations
      3. Asia, Australia, Pacific Islands -
        https://search.atomicjoltappsau.com/lti_dynamic_registrations
    4. Follow the prompts to complete dynamic registration. Save and Enable the Key to turn the key on (beneath State).
    5. Copy the Client ID (from the Details column) to complete do the install in Canvas.

5.  Install Atomic Search by Client ID

    1. Browse to the Canvas account in which Search will be installed and select: Settings > Apps > View App Configuration.
    2. Select +App. Select ‘Configuration Type’ = By Client ID.
    3. Enter the Client ID that the customer provided after creating the new Developer LTI Key in Step 4.

6. Index your Content

    1. Log out of the root admin user and in a new private browser window log in to Canvas as the Atomic Search Service user with the credentials you created earlier.
    2. Once you log in as the Atomic Search Service user account, you will navigate to the root level of the Atomic Search tool – either in the global navigation or by going to the root account settings and accessing "Search".
    3. Click on the triple dot menu in the upper right of the Atomic Search screen and in the list of options you should see an option Manage Integrations. If you do not see this option, you may need to enable it first under the Admin Settings option first.
    4. In Manage Integrations, Click on the Canvas API authentication to authorize. It will launch a new tab to authenticate and verify you are using the service user to complete the authentication steps.

Once completed, contact Atomic Jolt so that they can verify the install was successful and content has started indexing on the backend.