Skip to main content

Set up the test automation configuration file

  • Updated

For both automated testing integrations and the On-premise testing tool, you’ll need to set up the eA configuration file. The test automation configuration file tells the tool what pages to scan and where to push the results within the platform.

On this page:

Set up the test automation configuration file

Once you’ve successfully installed and set up one of the test automation tools or the On-premise tool, you need to set up the test automation configuration file.

To set up the test automation configuration file:

  1. Open the vendor folder.
  2. Open the ea-config.js file.
  3. Fill in the ea-config.js files using the table below.
Note: only configure the fields listed in the table.

If you have downloaded and set up the test automation configuration file prior to 3/24/23 you will have to remove ASLint from the configuration file. ASLint is no longer active and any scans that include ASLint as a testing tool will return an error.
Field name Description Example
platformUrl

Your company’s platform URL.

 https://yourcompany.essentia11y.com/
key

An API key generated from the API page.

Learn more about generating an API key in the platform.

 247ab467-ey4f-4bb0-80f2-0gga302c7b06
digitalPropertyId

The unique identifier for the website/app you want to send your results to.

Learn more about finding your website/app ID.

7280oiuh1b8677184dfac914
baseUrl The base URL of the website you want to scan. Shows as the Resolved URL on the Scans page. https://yourdevenvironment.com
sessionName Your scan title. Development local scan
scanTagId

The unique identifier for your scan tags.

Learn more about finding your scan tag ID. 		1244fa50e456be48ffda5w97

Scanner

The accessibility testing tools used in the scan.

Note: you may need to remove ASLint before scanning.

"ACE", "AXE-CORE"

Note: If you're using Cucumber, you may need to remove ACE.
viewport

The viewport size for your scan.

Note that updating the viewport size is optional.

 width: 1920, height: 1080
urlsToScan

The pages you want to scan.

Note that if you want to scan multiple pages, you need to enter them individually separated by a comma and in quotation marks.

 “https://yourdevenvironment.com”, “https://yourdevenvironment.com/contactus”

Your configuration should look something like this:

const config = {
    platformUrl : "https://yourcompany.essentia11y.com/",
    validateCertificate : true,
    key : "247ab467-ey4f-4bb0-80f2-0gga302c7b06",
    digitalPropertyId : "7280oiuh1b8677184dfac914",
    baseUrl: "https://yourdevenvironment.com",
    sessionName: "Development local scan",
    scanTagId : "1244fa50e456be48ffda5w97",
    scanners : ["ACE", "AXE-CORE"],
    viewport : { width: 1920,  height: 1080],
    urlsToScan: ["https://yourdevenvironment.com", "https://yourdevenvironment.com/contactus"],
    }

Add authentication details for the On-premise tool

If you’re setting up the On-premise tool, you can add authentication details for any password protected website. Learn more about the basic authentication, secure web authentication, and how to find your secure web authentication details.

Basic authentication

To add basic authentication details:

  • Fill in the basicAccessLoginInfo field with your username and password.

Your basic authentication configuration should look something like this:

basicAccessLoginInfo: { username: "yourusername", password: "yourpassword" },

Secure web authentication

To add secure web authentication details:

  1. Enter the URL of the website’s login page in the loginUrl field.
  2. Fill in the loginSelectors using the table below. Learn more about finding your login selectors.
  3. Enter your username and password in the loginInfo fields.
Field name Description Example
username

The HTML selector associated with the username or email field of the login page.

#email
password

The HTML selector associated with the password field of the login page.

 #password
submit

The button you select after you’ve entered your login credentials. (The button is often labeled “Log in” or “Sign in” but could have a different name.)

#loginPage > div > div.card-body > div > div > div > div > form > fieldset > div.row.margin-bottom > div > button
success An element that’s only visible once you’ve logged in to your website. It lets the scanner know that it has successfully logged in to your website and can begin the scan. #app-header > nav > div.row.w-100 > div > div.user-menu.d-none.d-sm-flex > div > a

Your secure web authentication configuration should look something like this:

loginUrl: https://devenvironment.com/login 
loginSelectors: {
   username: "#email",
   password: "#password",
   submit: "#loginPage > div > div.card-body > div > div > div > div > form > fieldset > div.row.margin-bottom > div > button",
   success: "#app-header > nav > div.row.w-100 > div > div.user-menu.d-none.d-sm-flex > div > a"
},
loginInfo: {
   username: "yourusername",
   password: "yourpassword"
},

Related to

Related articles