Integrations Documentation

About Integrity Advocate

Integrity Advocate partners with D2L to deliver proctoring directly the Brightspace Quizzes tool.

Integrity Advocate is an online proctoring, participation monitoring, and identification verification application that integrates with Brightspace. It combines AI technology with live reviewers to ensure that every learner session is carefully analyzed. Integrity Advocate requires no downloads for the user and works in all modern browsers (exceptions apply where the option to use a secure browser is selected).

This is the paper note and pencil icon used for notes.

Note: Administrators are required to follow the LTI 1.3 Dynamic Registration process to setup their tool and add the newly created LTI widget to course homepages.

Integrity Advocate availability and enablement

Integrity Advocate is an add-on purchase to the Brightspace core package. If you have questions about this integration or are interested in accessing Integrity Advocate at your institution, contact your Account Manager.

Enable and configure Integrity Advocate

Integrity Advocate is turned on by default at the instance level. However, it is turned off at the organization level.

To enable and configure Integrity Advocate:

From the Admin Tools menu, select Organization Tools.
Search for Integrity Advocate and toggle it on.
From the Admin Tools menu, select Config Variable Browser.
Search for the d2l.3rdParty.IntegrityAdvocate.AppId configuration variable.
Enter your full AppId provided by Integrity Advocate as the instance value.

To configure the Integrity Advocate settings:

From the Admin Tools menu, select Organization Tools.
Search for Integrity Advocate and toggle the switch on.
From the Admin Tools menu, select Integrity Advocate Settings.
For App ID, enter your Integrity Advocate App Id.
Note: This can be obtained by contacting Integrity Advocate at sales@integrityadvocate.com
Under Proctored Roles, select the role(s), such as Student and any other Learner roles, for which you want to have Integrity Advocate proctoring enabled.
Click Save and Close.

Register an external learning tool for Integrity Advocate

Make note of your AppId provided by Integrity Advocate.
From the Admin Tools menu, click Manage Extensibility.
In the LTI Advantage tab, click Register Tool.
Select the Dynamic radio button.
In the Tool initiation registration endpoint* field, enter the following URL, adding your AppId at the end:
https://www.integrityadvocateserver.com/integration/d2l/DynamicRegister?app_id={YourAppIdHere}
For example:
https://www.integrityadvocateserver.com/integration/d2l/DynamicRegister?app_id=xc186xxx-xxxx-xxxx-xxxx-xxacb09d5xxx
Select the Configure Deployment check box.
Click Register and follow the prompts. A success message appears.
Once complete, navigate to Manage Extensibility and check on your new tool registration and deployment.
At the deployment level, ensure you properly share the new tool deployment to the courses you want proctoring available to.
At the deployment level, also ensure the following security settings have been enabled:

Org Unit Information
First Name
Last Name
Email
User Id

Under Make tool available to, click Add Org Units.
Select the desired course(s) or just add the top level org unit and all descendents.
Click Add.
Click Save.
Scroll to the bottom and click View Links.
Click the Integrity Advocate LTI 1.3 link name.
Set the Height field to 1000.
Click Save and Close.

Enable proctoring on a quiz

In Brightspace, navigate to a course homepage.
In the Integrity Advocate widget, click on the Quizzes tab to view the list of quizzes in the current course.
Locate the quiz you want to enable proctoring on and select the check box in the Enable Integrity Advocate column.
To associate a grade item to the proctoring results, select the Use Grade Item check box.
Note: Enabling proctoring on a quiz also enables automatic grading, which ensures that quiz completions automatically navigate to a quiz submission view. All quizzes redirect to a default view, unless otherwise overridden in the quiz settings. See Quiz settings, Submission View tab options.

API Usage

Integrity Advocate leverages API calls to send and receive data from the Brightspace.

Users familiar with Brightspace APIs are aware that the first time a user accesses an API app from Brightspace, a permissions consent message appears. This message prompts an individual user to authorize the app to make API calls on their behalf. This prompt is kept in place for security purposes.

The integration makes use of the following Brightspace APIs:

Sync grade value for a specific grade object, for a particular user

Get details of a specific grade

Create a new grade item (pass/fail)

Update the value of a grade item (pass/fail)

Delete a grade item (pass/fail)

Get all quizzes in a specific course

Update quiz (header and instruction fields)

Create Integrity Advocate Service Account and Role

Integrity Advocate utilizes a service account role and user to make API calls to your D2L Brightspace instance.

To create the role:

Download the Role import file for configuring the Integrity Advocate service account.
From the Admin Tools menu, select Roles and Permissions.
Click Create/Copy.
Select Start Fresh and create the new role with the following settings:

Name: Integrity Advocate Service Account
Description: Service account role for Integrity Advocate integration
Enable Cascading Role

Select the following checkboxes:

Access inactive courses
Access past courses
Access future courses, selecting the following radio buttons:

Access all course sections
Access all course groups

Click Save.

On the Role Interactions page, ensure that any administrator accounts can Search For, Enroll, and Impersonate the new role by checking all the appropriate administrator checkboxes.

Click Save.

Click Import/Export.

Select Import role permissions from a CSV file and click Next.

Select the new Integrity Advocate Service Account role and click Next.

Click the Choose File control and select the role export file from Step 1 and click Next.

On the Preview Import page, ignore any errors and click Import.
Note: The errors are for controls you don’t have installed or enabled and can be safely ignored.

Click OK.

Set IMS Role Mappings for the Integrity Advocate Service Account

From the Admin Tools menu, select IMS Configuration.
Click Edit Role Mapping in the Institution Role column.
Check the boxes for Administrator, Faculty (1.1 Only), and Instructor.
Click Save.
Click Edit Role Mapping in the Context Role column.
Check the boxes for Administrator and Instructor.
Click Save.

Create the Integrity Advocate Service Account User

Integrity Advocate utilizes a service account role and user to make API calls to your D2L Brightspace instance.

To create the user:

From the Admin Tools menu, select Users.
Click New User.
On the new user creation page, enter the following details:

OrgDefinedId: ia.serviceaccount
Legal First Name: IA
Legal Last Name: ServiceAccount
Email: noreply@integrityadvocate.com
Role: Integrity Advocate Service Account
Username: ia.serviceaccount
Password: Generate a strong password
Note: D2L recommends using a random password generator, such as https://passwordsgenerator.net

Click Save.

Send the following information to your Integrity Advocate account manager:

Instance URL, for example https://yourorganization.brightspace.com
Password that you generated in Step 3, above.

Update Integrity Advocate Service Account Role

This topic only applies when upgrading Integrity Advocate and is not necessary when configuring a new install.

Integrity Advocate utilizes a service account role and user to make API calls to your D2L Brightspace instance. Integrity Advocate’s new D2L integration allows for the addition of Integrity Advocate to not just quizzes, but also Assignments and Content activities. An update of the role permissions is required to give our system access to these activities.

To update the role:

Download the Role import file for configuring the Integrity Advocate service account.
From the Admin Tools menu, select Roles and Permissions.
Click Import/Export.
Select Import role permissions from a CSV file and click Next.
Select the Integrity Advocate Service Account role and click Next.
Click the Choose File control and select the role export file from Step 1 and click Next.
On the Preview Import page, ignore any errors and click Import.
Note: The errors are for controls you don’t have installed or enabled and can be safely ignored.
Click OK.

Reset the Service Account Password

This topic only applies when upgrading Integrity Advocate and is not necessary when configuring a new install.

Integrity Advocate’s new D2L integration uses the existing service account we created when we initially set up Integrity Advocate on your instance. We will reset the password so that the new global Integrity Advocate app can be authorized to integrate with your instance.

Generate a new, strong password.
Note: D2L recommends using a random password generator, such as https://passwordsgenerator.net
From the Admin Tools menu, select Users.
Search for ia.serviceaccount and click on the account name to edit it.
Update the password to the one you generated in Step 1 and click Save.
Send the updated password to your Integrity Advocate account manager.

Setting up and Using the Integrity Advocate external tool (widget)

Integrity Advocate makes use of an LTI 1.3 tool to provide integrated functionality. Within this widget, you can review participant results, set admin options, review credit consumption, and read Integrity Advocate tool news/updates.

To register the Integrity Advocate external tool

From the Admin Tools menu, click Manage Extensibility.
In the LTI Advantage tab, click Register Tool.
Select the Dynamic radio button.
In the Tool Initiation Registration Endpoint field, enter the following Url, adding your Integrity Advocate app ID at the end. For example, https://www.integrityadvocateserver.com/integration/d2l/DynamicRegister?app_id=YOUR-APPID-HERE
Check the Configure Deployment checkbox.
Click Register.
A new window opens and displays the message “Success!”. Close the success message window and return to your D2L Brightspace instance.
From the Admin Tools menu, click Manage Extensibility.
Click the LTI Advantage tab and change from Enabled view to All view. Then click All.
Click the Integrity Advocate LTI 1.3 tool name.
Toggle the Enabled switch on.
Click Save.
Scroll to the bottom and click View Deployments.
Click the Integrity Advocate LTI 1.3 deployment name and check the following boxes under security settings:
- Org Unit Information
- First Name
- Last Name
- Email
- User ID
Under Make tool available to, click Add Org Units.
Select the desired course(s) or just add the top level org unit and all descendents.
Click Add.
Click Save.
Scroll to the bottom and click View Links.
Click the Integrity Advocate LTI 1.3 link name.
Set the Height field to 1000.
Click Save and Close.

Add the Integrity Advocate Widget to Homepages

From the Admin Tools menu, select Homepage Management.
Select the homepage that you want to include the Integrity Advocate widget.
NOTE: D2L recommends a full width display (Height 1000) for the Integrity Advocate widget. If you’re using the Basic layout, click Change Layout, then select Basic Plus and click Update.
Click Add Widgets in the full width section and search for Integrity Advocate.
Select Integrity Advocate LTI 1.3 and click Add.
Click Save and Close.

Using the Integrity Advocate Widget

There are four tabs within the Integrity Advocate LTI 1.3 widget.

Participants: Search for participant review results for all of the activities within this course that have Integrity Advocate enabled.

Activities: Manage the Integrity Advocate settings for each activity in your course. Enable/disable, create a grade item, and select rules for each activity.

Admin: Update the administrative settings (contact info) and review credit consumption details.

News: Review all of the latest updates on new Integrity Advocate features and upcoming/past releases.

Remove Integrity Advocate LTI 1.0 Widget from course home pages

This topic only applies when upgrading Integrity Advocate and is not necessary when configuring a new install.

The new D2L Brightspace/Integrity Advocate integration uses the LTI 1.3 standard to integrate with your Brightspace instance and provide you with access to Integrity Advocate participant results, admin options, credit consumption, etc.

Remove the existing Integrity Advocate LTI widget from any course home pages where it currently is displayed. To remove the Integrity Advocate LTI widget from a course page:

In the Admin Tools menu, select Homepage Management.
Click on the name of a homepage that has the Integrity Advocate LTI 1.0 widget on it.
Scroll to the Widgets section and click the X to remove the Integrity Advocate widget.
Click Save and Close.

Enable Integrity Advocate on an activity

To enable Integrity Advocate on a course activity:

Within the Integrity Advocate LTI 1.3 widget, click the Activities tab.
Find the activity you want to enable for Integrity Advocate proctoring.
Check the box for Enable Integrity Advocate for the desired activity.
If you wish to use a grade item, check the box Use Grade Item for the desired activity.
NOTE: This creates a new grade item updated by Integrity Advocate with a review status. Integrity Advocate does not change any grade items you may have set up.
Click Select Rules and check the boxes for the desired rules for the activity.
Click Submit.

Remove Integrity Advocate code from quizzes

This topic only applies when upgrading Integrity Advocate and is not necessary when configuring a new install.

The new D2L Brightspace/Integrity Advocate integration no longer requires instructors or admins to paste code into the Introduction, Header, and Submission views of quizzes. These code blocks must be removed on any quizzes you intend to use in the future.

To remove Integrity Advocate code from quizzes:

Determine which courses have quizzes that use Integrity Advocate.
On the applicable Course home page, click on Quizzes in the navigation bar, or click Course Toolsand select Quizzes from the drop down menu.
Find the quizzes that have Integrity Advocate installed.
Click on the applicable quiz name to edit the quiz settings.
In the Introduction field, click the </> icon in the editor and remove the following code:
<iframe src="/shared/IntegrityAdvocate/IntegrityAdvocateHeader.html" style="height: 0px; width: 0px; border: none;"></iframe>
In the Page Header click the </> icon in the editor and remove the following code:
<iframe src="/shared/IntegrityAdvocate/IntegrityAdvocateHeader.html" style="height: 0px; width: 0px; border: none;"></iframe>
Scroll up and click on the Submission Views tab.
Click the name of the submission view to edit it.
In the Message field, click the </> icon in the editor and remove the following code:
<iframe src="/shared/IntegrityAdvocate/IntegrityAdvocateClose.html" style="height: 0px; width: 0px; border: none;"></iframe>
Click Save.

Delete the Integrity Advocate Shared Files

This topic only applies when upgrading Integrity Advocate and is not necessary when configuring a new install.

As part of the original Integrity Advocate installation, files would have been added to the Shared Files section of your instance. The new version of the integration does not use these files and they should be deleted.

To delete the Integrity Advocate shared files:

In the Admin Tools menu, select Shared Files.
Locate the Integrity Advocate folder and check the checkbox next to it.
Click the trash can icon at the top of the folder and file list to delete the folder.

Troubleshooting and FAQs

Proctoring does not start when taking a quiz

As a learner, if you take a quiz that does not start proctoring, there may be a deployment issue for that quiz.

In the Integrity Advocate widget, on the Quiz Settings tab, verify that the quiz is enabled to be proctored.
Ensure the Integrity Advocate tool is turned ON at both the course and organization level.
Ensure your configuration variables under d2l.3rdParty.IntegrityAdvocate. are configured with the correct values.

API calls for the integration are failing

This integration makes use of basic GET calls (see above) to get particular objects from the courses. If the widget does not load a list of quizzes, it’s likely that the user viewing the widget does not have permissions to get/view the list of quizzes.

Typically hidden/invisible quizzes won’t be available to learners.
Quizzes that haven’t started yet likely won't appear to learners.
Typically, all objects appear to instructors and administrators whether they are set to be visible or not.

Proctoring results are not appearing in the widget

If you note that proctoring results do not appear in your Integrity Advocate homepage widget:

It’s possible the user does not have their proctoring session closed. In such cases you need to wait for the automatic 10 minute timeout before their session is closed and submitted for review.

Can't see the Integrity Advocate widget on the homepage

If a user says they cannot see the Integrity Advocate widget on their course homepage:

Ensure the widget is added to the homepage currently in use for the course.
Ensure the widget is shared to the course by updating the LTI 1.3 deployment sharing rules.

The system flagged a session as failed but it should be a pass

To override the course level activity results in the Integrity Advocate widget:

Click on the Participants tab.
Select a submission and click Override to manually override proctoring results.

Note that overrides cause all associated Integrity Advocate Pass/Fail grade items to be updated respectively. This override is a course level change and does not reflect an individual activity.

Existing Client Looking To Upgrade

Are you an existing Integrity Advocate client? If you setup your integration prior to May 2021, you are using the classic version of Integrity Advocate. With this release, D2L recommends that all existing clients consider upgrading to the latest version of Integrity Advocate, which provides improved work flows and greater flexibility in everyday use.

D2L tips and best practices for using the newest version:

The classic integration uses LTI 1.1. The latest version uses LTI 1.3. Both integrations can live within your platform in tandem and will not conflict with each other.
For example, you can have the LTI 1.1 widget and the LTI 1.3 widget added to the same homepage. Both widgets will show the same page. However, D2L only recommends having one on a page at a time to avoid user confusion.
Set up the new version of the integration, while leaving the existing integration in place. Do not remove or delete the existing configurations you have. To safely manage user access, we recommend only removing Sharing Rules for your LTI Tool Providers, LTI Links, and Remote Plugin.
Remove the classic LTI 1.1 widget from course homepages. Doing so simply removes it from your homepages and does not delete or remove any course data. Adding it back to the homepages, brings back all course data.
While removing the old widget, add the new LTI 1.3 widget.
Let instructors know that they no longer need to copy and paste HTML scripts into their quizzes. Enabling proctoring within the widget is everything they need to get up and running.

Additional Resources

IntegrationHub: Integrity Advocate

Integrity Advocate

Partners Brightspace Community Group

Release Notes

Subscribe to Brightspace Release Notes Updates to ensure you receive notifications for new updates. You can also view the Integrity Advocate Release Notes.

Looking for Help?

Reach out to your Account Manager for questions about:

Purchasing Integrity Advocate
Account Set Up
Billing

Reach out to D2L Support if you need technical support related to the integration to Brightspace.

Reach out to Integrity Advocate to submit a ticket if Integrity Advocate is not functioning as expected.