iseek.ai Embedded

Canvas Integration (LTI 1.3) - Getting Started

iseek search is added as an External App to your Canvas Account, Sub-Account, or Course:

Signed in as a Canvas Account Administrator, in the root Account click Developer Keys in the Account Menu and then click + Developer Key. Select the LTI Key option.
Select Method: Enter URL
Enter the following in the JSON URL field: //api.iseek.com/canvas/config.json
- Optional Settings: //api.iseek.com/canvas/config.json?launchInNewWindow=true&includePlacements=course,account
- launchInNewWindow - If you would like the search to open in a new window (rather than within Canvas), add "launchInNewWindow=true"
- includePlacements - This setting allows control over which area of Canvas displays the search. Include in the list, only those areas where you would like iseek to display to users (accounts and courses are enabled by default).
Enter a Key Name that provides context for administrators: iseek.ai Search
Click Save
Record the number (Client ID) seen in the Details column of your new Developer Key entry.
Navigate to the Account, Sub-Account, or individual Course in which you would like to add iseek search as a tool. Click the Settings link in the navigation menu.
Click the Apps tab.
Click the View App Configurations button.
In the dialog, select Configuration Type: By Client ID
Click Submit
In the list of Apps, click the cog menu at the right of the row and select Deployment ID. Copy this value.
Send both the Client ID (e.g. 109930000000000138) and Deployment ID (e.g. 350:4ea77b9a087da42c78e0aac53c02bebdb59817f7) to your iseek.ai Account Representative. Please also indicate whether you would like to be configured for the optional Search Box integration below.

Iseek will now show in your list of external applications. After refreshing the page, a new link iseek search will appear in the course, account, and user navigation menus. Please note that until the iseek.ai Team has configured your Client ID and Deployment ID, the search will not function.

Please note: The Client ID is used for all iseek.ai integrations in your Canvas site. The Deployment ID will be different for each sub-account in which iseek.ai is installed. Each Deployment ID may be configured separately for iseek.ai settings (e.g. The Medical School and Dental School may have unique settings if desired).

Next - Add Search Box to Canvas Header

Follow these instructions to replace the iseek search menu link with a search box in the breadcrumb area of Canvas.

Please note that by default iseek is configured to require the Search Box for Canvas and no LTI frame will be displayed until the Search Box is present on the page. If you do not wish to implement the Search Box, please contact your account representative and we will configure your search accordingly.
Click on Settings tab to return to general Account settings.
Enable Custom JavaScript and CSS Overrides by checking the box. If this checkbox is not visible, then it must be enabled at a higher level Canvas Account.
Enable Theme Editor as well, in the next checkbox.
Iseek uses JavaScript to write the Search Box to the page, so we must point Canvas to the code. This is done through the Canvas Theme Editor.
- Open the Theme Editor for the Sub-Account level that you wish to make the Search Box active.
- Click on the Upload tab, there should be an option to select a JavaScript file (if not, the account settings are incorrect for JavaScript).
- If there is currently no file used, save the following file locally, and then upload via the Select button: canvas_ui.js
- Otherwise, add the following snippet of JavaScript to your existing file:
```
															$.getScript("//api.iseek.com/dc/canvas_load.js?display_mode=0");
															
```
Finally, click Preview and then Apply.

The iseek search box will now appear in the Canvas breadcrumb navigation area when the course is active.

Please note: By default, the Search Box is shown only when the left-side Course navigation menu would otherwise display the "iseek search" menu item. See the following "Advanced" sections for other modes of Search Box display.

Advanced - Search Box Mode 1 (Dashboard)

In Mode 1, the Search Box is visible with the left-side navigation, as in the default Mode 0. Mode 1 adds display of the Search Box to the Dashboard after login.

Change the "display_mode=0" parameter to "display_mode=1" to enable this feature.

The iseek search box will now appear on the Dashboard after login. Because Canvas requires a Course or Account context to launch an External Tool like iseek, we must choose a Course for the user. Mode 1 selects the first Course (or Account) available in the list of enrolled Courses for the user.

Advanced - Search Box Mode 2 (All Pages)

In Mode 2, the Search Box is visible on all pages when a Course/Account context may be determined automatically.

Change the "display_mode=0" parameter to "display_mode=2" to enable this feature.

The iseek search box will now appear on the Dashboard, Calendar, and other pages. Because Canvas requires a Course or Account context to launch an External Tool like iseek, we must choose a Course for the user. Mode 2 selects the first Course (or Account) available in the list of enrolled Courses for the user.

Advanced - Search Box Mode 3 (Roles)

In Mode 3, the Search Box is visible on all pages, as with Mode 2. However, instead of automatically choosing a Course context, the Course target is determined by the Role of the current user. This allows specific Course targets to be chosen per Role - for example, a "Student Lounge" Course might be the landing site for Student roles.

Change the "display_mode=0" parameter to "display_mode=3" to enable this feature.
Iseek automatically determines the user Role, but you must configure the Course or Account target for each user Role for which you wish to display the Search Box.
For each Role you offer search, a &role_[role_label]=/courses/[course_id]/external_tools/[external_tool_id] parameter is added. Where [role_label] (e.g. role_student) is the Role of the current user, [course_id] is the numeric id of the Course, and [external_tool_id] is the numeric id of the iseek External Tool within the Course. Please note that [role_label] is the lower case form of the Role, with no "Enrollment" text included (e.g. ). "TeacherEnrollment" -> "role_teacher").
To determine the [course_id] and [external_tool_id] values, visit the Course to initiate a search with iseek. Record the URL of the browser during a search within the course. For example: https://iseek.instructure.com/courses/32/external_tools/24?q=test
Construct the parameter for the student Role using these values: role_student=/courses/32/external_tools/24
Repeat for each User Role. You may optionally supply a "role_default" target context for Users that do not match your configured roles. If "role_default" is not supplied, the Search Box will not appear on the Dashboard for Users without matching Roles.
Append your parameters to the original request: display_mode=3&role_admin=/accounts/23/external_tools/24&role_student=/courses/32/external_tools/24&role_teacher=/courses/33/external_tools/24&role_default=/accounts/23/external_tools/24

The iseek search box will now appear after login. Iseek will determine the most frequent Course enrollment Role of the user, and direct the user to the matching Course/Account context from your parameters. If the User is not enrolled in the target Course for their role, the Search Box will not be displayed on the Dashboard. The Search Box will always display within the Courses in which the User is enrolled (as is the basic behavior).

Canvas Integration - Getting Started

iseek search is added as an External App to your Canvas account:

Signed in as a Canvas Account Administrator, navigate to the Account or Sub-Account in which you would like to add iseek search. Click the Settings link in the navigation menu.
Click the Apps tab.
Click the Add New App button.
In the dialog, enter the following values and click Submit:
- Name: iseek
- Consumer Key: example_key
- Shared Secret: example_secret
- Configuration Type: By Url
- Configuration URL: //api.iseek.com/config/lti.xml

Iseek will now show in your list of external applications. After refreshing the page, a new link iseek search will appear in the course, account, and user navigation menus.

Please note: The Consumer Key and Shared Secret values are particular to your iseek search configuration and may be obtained through your iseek account representative. Feel free to use the example values for testing.

Optional - Add Search Box to Canvas Header

Follow these instructions to replace the iseek search menu link with a search box in the breadcrumb area of Canvas.

Click on Settings link in the Canvas Account navigation menu.
Click the Apps tab, find iseek in the list of external apps, and click the pencil/edit icon.
Add the value iseek_layout=header to Custom Fields and click Submit.
Click on Settings tab to return to general Account settings.
Enable Custom JavaScript and CSS Overrides by checking the box. If this checkbox is not visible, then it must be enabled at a higher level Canvas Account.
Enable Theme Editor as well, in the next checkbox.
Iseek uses JavaScript to write the Search Box to the page, so we must point Canvas to the code. This is done through the Canvas Theme Editor.
- Open the Theme Editor for the Sub-Account level that you wish to make the Search Box active.
- Click on the Upload tab, there should be an option to select a JavaScript file (if not, the account settings are incorrect for JavaScript).
- If there is currently no file used, save the following file locally, and then upload via the Select button: canvas_ui.js
- Otherwise, add the following snippet of JavaScript to your existing file:
Finally, click Preview and then Apply.

The iseek search box will now appear in the Canvas breadcrumb navigation area when the course is active.

Advanced - Search Box Mode 1 (Dashboard)

In Mode 1, the Search Box is visible with the left-side navigation, as in the default Mode 0. Mode 1 adds display of the Search Box to the Dashboard after login.

Change the "display_mode=0" parameter to "display_mode=1" to enable this feature.

Advanced - Search Box Mode 2 (All Pages)

In Mode 2, the Search Box is visible on all pages when a Course/Account context may be determined automatically.

Change the "display_mode=0" parameter to "display_mode=2" to enable this feature.

Advanced - Search Box Mode 3 (Roles)

Change the "display_mode=0" parameter to "display_mode=3" to enable this feature.
Iseek automatically determines the user Role, but you must configure the Course or Account target for each user Role for which you wish to display the Search Box.
For each Role you offer search, a &role_[role_label]=/courses/[course_id]/external_tools/[external_tool_id] parameter is added. Where [role_label] (e.g. role_student) is the Role of the current user, [course_id] is the numeric id of the Course, and [external_tool_id] is the numeric id of the iseek External Tool within the Course. Please note that [role_label] is the lower case form of the Role, with no "Enrollment" text included (e.g. ). "TeacherEnrollment" -> "role_teacher").
To determine the [course_id] and [external_tool_id] values, visit the Course to initiate a search with iseek. Record the URL of the browser during a search within the course. For example: https://iseek.instructure.com/courses/32/external_tools/24?q=test
Construct the parameter for the student Role using these values: role_student=/courses/32/external_tools/24
Repeat for each User Role. You may optionally supply a "role_default" target context for Users that do not match your configured roles. If "role_default" is not supplied, the Search Box will not appear on the Dashboard for Users without matching Roles.
Append your parameters to the original request: display_mode=3&role_admin=/accounts/23/external_tools/24&role_student=/courses/32/external_tools/24&role_teacher=/courses/33/external_tools/24&role_default=/accounts/23/external_tools/24

Brightspace Integration - Getting Started

Please follow these instructions to enable LTI 1.3 launches of the iseek.ai search tool.

Signed in as a Brightpsace Administrator Account, navigate to Admin Tools by clicking the cog icon in the top right. A list of options will appear. Click the Manage Extensibility link under the Organization Related section.
Click the LTI Advantage tab, and then the Register Tool button.
Choose the Standard registration option.
Enter the following information in the Register a Tool form.
- Name: iseek.ai
- Description: iseek.ai is a curriculum search tool
- Domain: https://api.iseek.com
- Redirect URLs: https://api.iseek.com/lti13/launch
- OpenID Connect Login URL: https://api.iseek.com/lti13/login_initiation/brightspace
- Target Link URI: https://api.iseek.com/lti13/launch
- Keyset URL: https://api.iseek.com/brightspace/.well-known/jwks.json
Once the tool is registered, Brightspace will provide Registration Details, please copy all items and email to your iseek Account Representative as this information is required to complete the configuration on the iseek side.

Please note: The search itself will not be enabled until the Registration Details and Deployment Details (next section) have been shared with your Account Representative and iseek has been configured for your deployment.

Tool Deployment

Follow these instructions to deploy the iseek.ai search tool to one or more Org Units.

From either the Creation or Edit Tool screen, click on the New Deployment button.
Select iseek.ai from the list of registered tools.
Enter "iseek.ai" for Name.
Under Security Settings check Org Unit Information and User Information.
Under Configuration Settings check Open as External Resource.
Now click Org Units and select the desired organizational units you wish to allow to use the iseek search tool. Note that you may check This org unit and all descendants to make the tool available to all child orgs.
Finally Brightspace will display the Deployment Details. Please copy the Deployment ID and share that along with the Tool Registration Details to your iseek Account Representative.

Create the LTI 1.3 Link - Deployment Level or Course Level

A link created at the Deployment Level will be readily available to add to a Course as an Activity.

Click View Links from the View Deployments page.
Click New Link and enter the following information (you may name the link as you would like):
- Name: iseek.ai
- URL: https://api.iseek.com/lti13/launch
Now that the link has been added, you may find it at the Course level by choosing an existing Module (or creating a new one). Click on Existing Activities and then External Learning Tools. Choose the link created previously.

Follow these instructions to create a link directly at the Course Level.

Assuming the LTI Deployment has been shared with the Course (see Org Unit selection in Tool Deployment), you may click Existing Activies and then External Learning Tools.
Click New Link and enter the following information (you may name the link as you would like):
- Name: iseek.ai
- URL: https://api.iseek.com/lti13/launch
- Tool: Select "iseek.ai"
Click Create and Insert.

Brightspace Integration - Getting Started

An iseek Widget can be added as a external widget to your Brightspace account's course homepages.

Signed in as a Brightpsace Administrator Account, navigate to Admin Tools by clicking the cog icon in the top right. A list of options will appear. Click the Remote Plugins link under Organization Related.
Click the New Plugin button.
Use the following configuration to add a widget to your course homepage content.
- iseek Search Box
  - Plugin Type:Widget
  - Height:100
  - Name:iseek Search Box
  - Launch URL://api.iseek.com/lti/widget/small
  - Consumer Key: example_key
  - Shared Secret: example_secret
  - Make Available to:[Add your course homepages here]

Add Widget to Brightspace Course Homepage

Follow these instructions to add the iseek Search Widget to the relevant course homepage

Navigate to your course homepage by clicking the course gallery icon (6 boxes in a square) in the navbar.
Once you are on the course page you wish to place the iseek Search Widget on, click the floating button with an ellipsis icon located at the bottom right of the page. An option menu will appear, click the option to Edit the homepage.
Scroll to the bottom of the page. You have the option to choose a different content layout.

It is suggested to apply a layout with a smaller width column if adding the iseek Search Box widget.

Click the Add Widget button on one of the columns, where you want the widget to be place on the page. A dialog will appear, type "iseek" in the search bar to find the iseek Widget. Click the checkbox on the iseek Widget and then click the Add button at the bottom.
Once you have added the remote plugin widget you want, click the Save and Close button at the bottom of the page.

Advanced - Create a Custom Widget for a Brightspace Course Homepage

Follow these instructions to allow your remote plugin to be inserted as a Quicklink

Signed in as a Brightspace Administrator account, navigate to the Admin Tools dropdown by selecting the cog icon in the top right. Under the Organization Related header, select the External Learning Tools link.
Scroll down and find the remote widget you created in the “Getting Started” tutorial, named iseek search box. Click the dropdown arrow next to iseek search box and select Edit Link.
Under the Visibility header, click the checkbox so that it is checked to Allow users to view this link.
Select Save and Close and you will be redirected back to the External Learning Tools page with the message Saved Successfully.

Follow these instructions to create a iseek Custom Widget

Signed in as a Brightspace Administrator Account, navigate to the Course Homepage. Click Edit Course in the Course navigation bar.
Click the Widgets option, under the Site Setup Header. Click Create Widget, fill in the Name Input field, “iseek Search Box”.

If you have not done so, complete the tutorial above on allowing your remote plugin to be inserted as a Quicklink.

Now click the Content tab, and a HTML editor will appear. Click the Insert Quicklink icon in the editor and scroll to and select the option named External Learning Tools. You should see the quicklink of the remote plugin you created and shared in the Allowing your Quicklink to be seen in External Learning Tools tutorial above
You will see a link appear in the HTML editor. Click the Source Editor icon at the bottom of the HTML editor. Copy the html element text below and paste in the source editor under the text that is there.
```
<iframe src="/d2l/common/dialogs/Quicklink/quicklink.d2l?ou={orgunitid}&amp;type=lti&rCode={Insert rCode}&srcou={Insert srcou}" width="100%" frameborder="0" height="100"> </iframe>
```
In the link element text that was in the source editor when you opened it, you will see rCode, copy the text from rCode until the "\&".
- For example, the rCode text will look like 971FF31D-2BEB-4A8B-9515-AC00142F16A2-4084
Paste the copied text into the <iframe> element you inserted by replacing the text {Insert rCode}
Repeat step 6 for the value srcou and then remove the code text for the link.
- For example, the srcou text will look like 1752.
You will see the iseek search box appear in the Widget Content editor. Now select Save and Close. Refer to the instructions in Adding a widget to a course page in order to add your new custom widget.

Blackboard Integration - Getting Started

The iseek.ai curriculum search may be added to Blackboard as both a System Tool and/or Course Tool.

Signed in as a Blackboard Administrator Account, navigate to the Administrator Panel by clicking the "System Admin" tab in the top right.
Select the LTI Tool Providers link within the Integrations panel.
Click the Register LTI 1.3/Advantage Tool button.
Use Client ID: 766747ec-6c22-4dcd-a234-307c5d47b295 and click "Submit".
Record the Deployment ID (e.g. 22330dd4-ecda-469c-9b7b-116b80ca1e62) and email the value to your iseek.ai account representative.
Optional: By Default, iseek will be available as both a System and Course Tool. If you wish to remove a placement, visit "Manage Placements" for the iseek Tool Provider. You may then "Delete" the placement.

Please note: The Tool Provider Deployment ID must be sent to your iseek account representative to complete the configuration of your search.

Add Tool Link to Course Menu

Follow these instructions to add the iseek.ai tool link to the relevant course homepage. You should be signed-in as an Instructor, or a user enrolled in the course in order to view the tool.

Navigate to your course homepage by selecting the "Courses" tab.
Once you are on the course page in which to place the iseek.ai tool link, click the "plus" icon located at the top left of the menu area.
Click Submit and the link will now appear in the course menu.
When a user clicks on the iseek.ai search link, a query box and search results will be presented within the course content area.
Please let us know if you wish to have colors or logos modified in the iseek.ai search page.

Moodle Integration - Getting Started

An iseek activity may be added to your course pages.

Signed in as a Moodle Administrator Account, navigate to the Site Administration page and Plugins tab.
Click Manage Tools.
Under Add tool, enter the iseek Moodle configuration URL: //api.iseek.com/config/lti.moodle.xml
Use the following settings to configure the tool.
- Consumer Key: example_key
- Shared Secret: example_secret
- Save changes
The "iSEEK Search" external tool is now available to be added as an activity to your course.
Within your course, change to "edit mode" and click to "Add an activity".
Select "External Tool" in the list of Activities, click "Add". Apply the following settings to the new Activity.
- Activity Name: iseek.ai
- Preconfigured tool: iSEEK Search
- Launch container: New window
- Submit
Click on the Activity to begin an iseek search. You may also move the Activity or use it Menus or Blocks.

Moodle Advanced - iseek Plugin

You can embed the iseek Search Plugin right on your Moodle Dashboard by uploading the iseek plug-in:

Download the iseek Moodle Plugin v1.3 here.
While signed in as a Moodle Administrator user, navigate to the Site Administrator page.
Click on the Plugins tab and then click on Install plugins.
Drag and drop the compressed (.zip) folder you downloaded beforehand, or you can select "Choose a file.." to browse your local directory for the folder.
Once you see the iseek-moodle-plugin.zip folder loaded on the page, select "Install plugin from the ZIP file" below.
During the installation process, you will have to select "Continue" after the plugin has been validated.
On the next page select "Continue" again. Then, on the next page, you will have to select "Upgrade Moodle database now".
You should be redirected back to Site Administration page. Click into the Plugins tab again and select Plugins Overview. Then select Additional Plugins, and you should see the iseek search Plugin name.
Select Settings for the iseek search plugin.
Use the following settings to configure the tool:
- LTI Key: example_key
- LTI Secret: example_secret
- LTI Url: https://api.iseek.com/lti/launch
After you input the new settings values, click Save Changes.
Now navigate to your Dashboard page. Select Customise this page in the top right, and then Add a block on the left side menu.
Select iseek Search from the Add a Block menu. The plugin will display on your dashboard and you will be able to position the plugin as you want with the move icon that is located on the top right of the plugin.

Please note: The LTI Key and Shared Secret values are particular to your iseek search configuration and may be obtained through your iseek account representative. Feel free to use the example values for testing.