YuJa EqualGround supports direct integration with ScholarWorks websites for seamless inline remediation and analytics based on your website's accessibility compliance. To complete this integration, you will require the API key from your ScholarWorks instance and access to a YuJa EqualGround admin account.
Integrating a ScholarWorks site into YuJa EqualGround
- Log in to YuJa EqualGround as an admin.
-
On the left side navbar, select Configuration > Integration Settings.
-
Click CMS (Content Management System) and select ScholarWorks.
-
Select Add Key.
-
In the Add ScholarWorks API Key modal, enter your ScholarWorks API key and click Add to complete the process.
Ensuring that ScholarWorks is enabled for your account
- Log in to YuJa EqualGround as an admin.
-
On the left side navbar, select Configuration > Modules.
-
Select ScholarWorks from the Modules menu.
-
Ensure that the toggle is set to Enabled. If it is not enabled, please contact your Account Manager to enable it.
Initiating a scan for a ScholarWorks site
- On the left side navbar, click Sites.
-
Click Add New Site.
-
Under Scan Type, select Website. Click Continue.
-
Under Website Selection, enter the URL of the website that you would like to scan. Click Continue.
-
If you would like to scan the entire website, select Entire Website.
-
(Optional) If you would like to exclude pages from your scan, click Exclude Pages and type in the URL of the page(s) you want to exclude. Then, select Add.
Note: The entry point URL is the starting page of your website where the scan will begin. You can learn more about potential errors here.
-
From the scan frequency drop-down menu, select how often you would like to scan your website.
-
If you do not require any advanced configurations, click Start Scan to complete the process.
-
(Optional) If you require advanced configurations, select the Advanced Settings drop-down menu.
- (Optional) If you would like to start the scan from a page different than the URL you used in step 5, click Yes to, "Do you want to start the scan from a different page?"
-
Input the starting URL and click Add.
-
(Optional) If your website requires authentication through a login page, click Yes to, "Does your website require a username and password to access?", and then enter the necessary credentials to allow EqualGround to access your website for scanning.
-
(Optional) If your website uses a firewall or IP restrictions, click Yes to, "Does your website use a firewall or IP restrictions?" and copy the provided IP addresses into your websites firewall allowlist.
-
(Optional) If you would like to use your website's sitemap, select Yes to the corresponding question and input your sitemap URL. Next, click Add.
-
(Optional) If you would like to find web pages to scan separately, click Yes to Find Web Pages and Scan Separately. Then, select Find Web Pages to initiate your scan.