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

Overview: Installing Atomic Search in D2L/Brightspace

Use the below instructions to configure Atomic Search into your D2L/Brightspace environment. 

Brightspace Search Installation Guide

Register the tool & configure deployments

  1. Log in as a Super Administrator in Brightspace.
  2. In the upper right corner of the Homepage, select the Admin Tools gear and click on Manage Extensibility
  3. Click on the LTI Advantage tab and click the Register Tool button
  4. Choose Dynamic Registration
  5. Copy and paste the URL Registration endpoint for your region:  
    1. US  - https://search.atomicjoltapps.com/lti_dynamic_registrations
    2. Europe  - https://search.atomicjoltappsie.com/lti_dynamic_registrations
    3. Asia/Pacific - https://search.atomicjoltappsau.com/lti_dynamic_registrations
    4. Canada - https://search.atomicjoltappsca.com/lti_dynamic_registrations
    5. Beta - https://search.atomicjoltbetaapps.com/lti_dynamic_registrations
    6. Dev - https://search.atomicjoltdevapps.com/lti_dynamic_registrations
  6. Check the Configure Deployment checkbox and click Register.
  7. Atomic Search will be disabled initially. Click on the Atomic Search tool name to toggle the state to ENABLE and click the Save button.

  1. Scroll down to the bottom of the page and click on the "View Deployments" link. This link will launch a new tab where you will complete the next set of steps.

Configure the deployment

The deployment is initially available only to the root org unit, but it needs to be made accessible to all descendants so that it can be used in courses.

    1. Go back to Manage Extensibility 
    2. Go to the LTI Advantage Tab
    3. Click on the Atomic Search Instance
    4. Click on View Deployments
    5. Click on the existing Atomic Search deployment 
    6. Check the User ID box under ‘Security Settings’
    7. Click on the Add Org Units button 
    8. Find the root org unit; you can do this by filtering on the Unit Type "Organization"
    9. Check the box for the root org unit, and select the option “This org unit and all descendants.”
  • MAKE SURE YOU DO THIS. If the customer tries to add a course offering or something else other than an organization and all its descendants, make sure to override, or search will not work downstream.
  1. Save. 
  2. Scroll down to the bottom of the page and click on the "View Links" link. This link will launch a new tab where you will complete the next set of steps.

Configure Link

  1. Go back to Manage Extensibility 
  2. Go to LTI Advantage Tab
  3. Click into the Atomic Search Instance
  4. Click on View Deployments 
  5. Clck on View Links
  6. Click on the New Link button 
  7. Name: Atomic Search
  8. For the URL, copy and paste in the link for your region:  
    1. US - https://search.atomicjoltapps.com/lti_launches
    2. Europe - https://search.atomicjoltappsie.com/lti_launches
    3. Asia/Pacific - https://search.atomicjoltappsau.com/lti_launches
    4. Canada - https://search.atomicjoltappsca.com/lti_launches
    5. Beta - https://search.atomicjoltbetaapps.com/lti_launches
    6. Dev - https://search.atomicjoltdevapps.com/lti_launches
  9. Type: "Basic Launch"
  10. Save & Close

Add Atomic Search to the navigation bars

We recommend adding Atomic Search to the course and dashboard navigation bars. Navigate to the Admin Tools gear,  and choose Navigation & Themes.

Create a custom link

  1. Click on the Custom Links tab, then click on the Create Link button
    1. Name the link Atomic Search.
    2. Click on the Insert Quicklink button, find the External Learning Tools option, and choose “Atomic Search”
    3. Copy the generated URL value and save it somewhere. THE URL IS UNIQUE AND IS IN THE URL FIELD “EDIT CUSTOM LINKS”; it will be used later to set up the widget. It should look something like this:

    4. DO NOT COPY THIS. THIS IS AN EXAMPLE OF WHAT THE LINK LOOKS LIKE.

/d2l/common/dialogs/quickLink/quickLink.d2l?ou={orgUnitId}&type=lti&rcode=9ADACE5F-1B93-48C6-8E76-09AE53984D7F-1647&srcou=6606

  1. In the Behavior dropdown, choose "Same Window"
  2. Under Availability, enable the "Share with child org units" checkbox.
  1. Click Save.

Add the Atomic Search custom link to Navbars


If the customer wants to install the Navbar as the Org Unit level, they can go to the Settings Gear > Org Unit Editor > click the org unit you want > add the navbar item there.

There are two types of navigation used with Atomic Search: the Dashboard and Course-level navbars. The current course-level nav will be marked as "Default," and the Dashboard nav will be marked as "Active." You can edit these navbars or create a copy and make it the new active or default.


  1. Click on the Navbars tab, then click on the Navbar to which you want to add the link. 
  2. On the Edit page, click Add Links, in the popup and find the External Learning Tools option, and choose “Atomic Search”
  3. Save & Close.
  4. Repeat for the other navbar.

Add the Atomic Search JavaScript widget inline the Navbar


Brightspace apparently charges for JS management, but I was told that it was going to be included with customers going forward.  Put that note in the installation instructions to check with the customer to see if they have that option/permssion before you go through those steps

To add the Javascript widget inline on the navbar, 

  1. Create a new text file on your computer and copy the following code into your new file:

(() => {

  const script = document.createElement('script');

  script.src = 'https://js.atomicsearchwidget.com/brightspace_enhanced.js';

  window.atomicSearchCustomConfig = {

    link: 'INSERT LINK HERE ',

    showBranding: 'on',

    supportedOrgs: [],

  };

  document.getElementsByTagName('head')[0].appendChild(script);

})();

  1. In the highlighted section, paste the custom link generated in the “Create a custom link” section above into the quotes and save your file as a .JS file
  2. The value of showBranding can be changed to ‘off’ if the customer doesn’t want to see the ‘Powered by Atomic Jolt’ text. 
  3. If you need to limit the availability of the widget to specific orgs and their descendants, add them to the ‘supportedOrgs’ list, separated by commas. Examples:
    1.  limit to org 5000 only: supportedOrgs: [5000]
    2. Limit orgs 5001 and 5001: supportedOrgs: [5001, 5002]
  4. Go to the Admin Tools gear, and choose JavaScript Management (located under the Product and Tool Administration section).
  5. Click on Import Module.
  6. Name the module: Atomic Search Widget
  7. Upload your . JS file and click the Add button.
  8. Enable the Module status to ON. 
  9. Click the arrow next to the module name, then Manage Roles, turn it on for every role you want to access the widget. It will prompt you to confirm with each role.

Check for Custom IMS Roles: Verify if the customer has any custom IMS roles that need to be mapped in Atomic Search. If they do, inform Atomic Jolt so that the necessary roles can be added/mapped in the back-end Catalyst system.

This step ensures clarity for both the customer and your internal team during the installation process.


Add the Atomic Search Widget box to homepages

We can add a widget box to the course and dashboard homepages in addition to the navbar placements. 


Navigate to the Settings Gear, Homepage Management

  1. Create the widget by clicking on the 'Widgets' tab, then click the Create Widget button
    1. Under the Properties tab
      1. Name: Atomic Search
      2. Widget Security: Uncheck sandboxing and iframe settings
    2. Under the Content tab
      1. In the RCE, click the Source Code button, (Looks like: </>)
      2. Enter the following HTML as the source


<div id="atomic-jolt-search-widget"></div>

<div><script>

        window.atomicSearchConfig = {

      orgTypeId: "{OrgUnitTypeId}",

            link: "[URL copied from link earlier]",

            showBranding: "on",

        }

        var atomicSearchWidgetScript = document.createElement("script");

        atomicSearchWidgetScript.src = "https://js.atomicsearchwidget.com/brightspace.js";

        document.getElementsByTagName("head")[0].appendChild(atomicSearchWidgetScript);

    </script></div>
  1. Replace the link value in the script (currently says: “[URL copied from link earlier])” with the link value you copied in the “Create a Custom Link” steps above.
  2. The value of showBranding can be changed to ‘off’ if the customer doesn’t want to see the ‘Powered by Atomic Jolt’ text. 
  1. Click Save & Close.

Add the widget to homepages

The homepages are structured similarly to navbars; an 'Active' applies to the dashboard and a 'Default' one applies to courses. The widget needs to be added to both.

  1. Go to Homepage Management
  2. Go to the Active and/or Default Homepage (you will see the indicator on the right)
    1. Default makes it show up in all courses
    2. Active makes it show up on the current homepage
  3. Click on it/them
  4. Scroll down, and then find an Add Widget button where you desire and place the Atomic Search widget there.


Indexing LMS content

Create OAuth application

To maintain an index of your content we need to create a new OAuth 2.0 authentication.
 

  1. Navigate to the Admin Tool Gear, click on Manage Extensibility
  2. Click on the OAuth 2.0 tab
  3. Click on the Register an app button
    1. Application Name: Atomic Search
    2. Redirect URIs:
      1. US - https://search.atomicjoltapps.com/brightspace_install/redirect
      2. Europe - https://search.atomicjoltappsie.com/brightspace_install/redirect
      3. Asia/Pacific -  https://search.atomicjoltappsau.com/brightspace_install/redirect
      4. Canada - https://search.atomicjoltappsca.com/brightspace_install/redirect
      5. Beta - https://search.atomicjoltbetaapps.com/brightspace_install/redirect
      6. Dev - https://search.atomicjoltdevapps.com/brightspace_install/redirect
    3. Scope: checklists:checklist:read,write content:file:read,write content:modules:readonly content:toc:read content:topics:manage,read,readonly core:*:* discussions:forums:readonly,manage discussions:topics:readonly,manage managefiles:files:read managefiles:folders:read organizations:organization:read quizzing:quizzes:read,write surveys:surveys:read,update  
    4. Access Token Lifetime: 72000
    5. Prompt for user consent: yes
    6. Enable refresh token: yes
    7. Accept terms: yes
  4. Send the Client ID and Client Secret that generate securely to Atomic Jolt. 
  5. A new Site will be created in the admin panel and the CLIENT ID and CLIENT Secret needs to be added. 

Obtain a token (needs to happen on an Org launch, not a course launch)

  1. As an Admin (make sure you are on the top most part of your site, and not the course level), launch Atomic Search using the navbar link or widget from your homepage. 
  2. In Atomic Search, open the 3-dot menu and select Admin settings. In the popup, click the Set up content indexing button. 
  3. This will open up a new tab that walks you through an OAuth process. After completing the process, it will tell you it was successful, and you can close the tab.
  4. Atomic Jolt will notify the Search development team so we can track the indexing status.