1. Introduction
Welcome to the QualiBooth Portal! This guide is designed to assist you in navigating and maximizing the features of the QualiBooth Portal. By adhering to the steps outlined in this document, you will streamline your workflow and boost your efforts in web accessibility compliance.
2. Registration
2.1. Start Your Journey
Navigate to the QualiBooth website and click the “Start Free Trial” button located in the top right corner.
2.2. Sign Up
Complete the registration form or opt for a quick sign-in with your existing Google or Microsoft account.
2.3. Onboarding Steps
- Step 1: Specify your Organization’s name and the domain you wish to assess first.
- Step 2: Choose the right plan for your needs. Our offerings include Standard, Advanced, Premium, and Enterprise plans, with Monthly and Annual billing options. Opting for an Annual subscription grants up to a 20% discount. Select the plan that best accommodates the number of users, sites, and organizations you intend to manage. For bespoke needs, the Enterprise plan awaits. Contact our sales team at sales@qualibooth.com for a custom solution tailored to your requirements.
- Step 3: Provide payment details. Companies within the EU must ensure accurate country and VAT number submission.
2.4. Confirmation
Review your plan selections and associated charges. Once confirmed, you’re all set to explore the full capabilities of QualiBooth.
3. Browser Script Installation
Upon completing registration, you’ll be directed to the “My Sites” dashboard. Here’s how to activate QualiBooth on your site:
3.1. Tracking Code
Locate and click the “Tracking Code” button for your site to reveal the script.
3.2. Script Embedding
Copy the script and embed it within your website’s header, footer, or body tag.
3.3. Status Update
Monitor the status transition from “Not Active” to “Active,” which signifies successful script integration. This process can take several minutes, but there’s no need to wait; if correctly placed, our engine begins data collection immediately.
4. My Sites
4.1. Active Sites
This section provides a comprehensive overview of the user’s organization’s websites. The quantity of manageable sites is contingent upon the chosen subscription package, ranging from a singular site to multiple.
Features for Site Management
- Dashboard Access: Clicking the designated icon navigates the user to the site-specific dashboard for detailed insights (refer to section 5.0 Dashboards).
- Reports Access: Selecting this icon directs the user to the site’s reports page for analytical data (refer to section 6.0 Reports).
- Development Assistant: Engaging this icon initiates the development assistant, showcasing the home page of the selected site (refer to section 7.0 Development Assistant).
- Tracking Code Allocation: Each site is assigned a unique tracking code. Embedding this code within your site’s HTML (header, footer, or main body) activates data collection.
- Site Status Indicators: The status transitions to ‘Active’ upon successful tracking code integration and data receipt. Conversely, a ‘Not Active’ status implies issues like script removal, lack of site visits, or ongoing maintenance.
- Site Deletion: Clicking this icon removes the site from the active roster. Post-deletion, the system halts data intake from the site but retains existing information for a 30-day grace period, within which site restoration is possible. Restoration reactivates scanning, data processing, and analysis, provided the tracking script remains intact.
- Adding New Sites: Utilize the “Add Site” feature located in the upper-right section to incorporate a new site.
- Initiate by selecting “Add Site.”
- Input the site’s valid domain name.
- Finalize by clicking “Add Site.”
- Upon completion, apply the newly generated tracking code to the desired location on your site (header, body, or footer).
4.2. Deleted Sites
This segment catalogs sites that have been removed and are within the 30-day retrieval window. Sites and their data beyond this timeframe are irreversibly purged.
- Restoration Option: Reviving a deleted site reinstates scanning, processing, and analytical functionalities. Should reactivation not occur, verify the presence of the tracking code on your site, or reinstall it as necessary.
5. Dashboards
Upon integrating QualiBooth into your digital ecosystem, its browser script immediately springs into action, evaluating your website’s accessibility. This seamless process is designed to ensure your site remains inclusive and compliant with accessibility standards. How it works: Each visit to a page on your site triggers an automatic scan, assessing the page for accessibility barriers. These scans collect data which is then synthesized and relayed to our analytical engine for processing.
Dashboard Insights: Gain a comprehensive view of your website’s accessibility through the dashboard, which aggregates and displays data shortly after installation. While initial statistics might take a few hours to appear, updates occur hourly, enriching your overview with the latest information.
5.1. Filters
- Site Selection (Mandatory): Choose a specific site for dashboard analytics.
- Tag Filtering (Optional): Refine results using site-specific tags for more targeted insights.
- Date Range (Mandatory): Define the analytics period across all charts except for the Accessibility Score, which is always displaying the most accurate and updated score for your website.
- Last 24 hours: selecting this filter will result in displaying results for the last completed 24 hours. Since the processing engine is aggregating results on every round hour, if current time is 14:47 on 02/Jan/24, the last completed hour will be 13:00:00 to 13:59:59 on 02/Jan/24 and the charts will display results for the period 14:00:00 pm on 01/Jan/24 till 13:59:59 on 02/Jan/24.
- Last 7 days: results shown will be for the last completed 7 days. Daily aggregations happen at 00:00:00 so if the current time is 14:47 on 10/Jan/24, the last completed day will be 09/Jan/24 and the charts will display results for the period 03/Jan/24 – 09/Jan/24 (7 days).
- Last 30 days: same as above, however period is 30 days.
- Last 12 months: Monthly aggregations are happening at the start of a new month, so if current date is 01/Jan/24, selecting this filter will provide results for the period Jan/23 – Dec/23 (12 months).
- Custom date range: select this one to define custom period in days.
5.2. Accessibility Score
A dynamic metric offering a snapshot of your site’s accessibility level, with real-time scoring based on the most recent data, primarily reflecting the previous day’s score for accuracy. For new customers to QualiBooth (less than a day), initial scores are based on the latest hour’s scan, evolving to daily updates as more data becomes available.
- 5.2.1. Score levels
- High (Green): Scores 85-100 signify strong compliance with accessibility standards.
- Medium (Orange): Scores 60-85 highlight partial compliance, indicating areas for improvement.
- Low (Red): Scores below 60 denote significant accessibility barriers.
- 5.2.2. How scoring works: For each page visited on your site, QualiBooth’s accessibility scanner performs a scan on the page, analyzes the issues found and sends a summary to the processing engine, containing all issues found and a page score. The page score is determined based on the total weight of issues found and the elements scanned on a page. Critical issues have the highest weight, then come High, Medium and Low.Scoring Algorithm: Calculates a page score from the total weight of issues found versus elements scanned, aiming for a balance between thoroughness and accessibility.
- 5.2.3. Hourly score: The hourly score is an average value from all page visits’ score during that hour. If there are more heavily visited pages on a website (for example its homepage), those will have higher weight in determining the hourly score since there will be more processed scans for such pages compared to others. Thus, the score is based on the average user’s experience and not just an average number for all scanned different pages.
- 5.2.4. Daily score: Same as above, for 24 hours.
5.3. Scan History
Visualize your website’s accessibility journey through various charts, detailing changes over time. Whether you’re interested in the past hour or year, these graphs enable targeted reviews and strategic planning. There are a total of 4 different scan history charts:
- 5.3.1. Accessibility Score Chart: Used to track trends of how site’s score fluctuates, identifying patterns or areas for improvement.
- 5.3.2. Accessibility Issues: Used to discover the volume of accessibility challenges uncovered during specific periods. If an issue is present on a page, it will be included in the results for every single hour/day until fixed.
- 5.3.3. Issue’s view count: Understand the real-world impact of accessibility barriers through the eyes of your visitors. For instance, if two individuals encounter the same two issues on your homepage, the view count for those issues doubles, offering a deeper insight into user experiences. A single error on a website’s homepage may have thousands of view counts. This is used to stress the importance of some issues over others.
- 5.3.4. Pages Affected: Shows the number of affected pages on your website.
5.4. Issues found by severity
Display results for the selected period based on the issues severity level. Issues severity levels are (highest to lowest) Critical, High, Medium and Low.
5.5. Issues found by violation level
WCAG 2.1 guidelines are categorized into three levels of conformance to meet the needs of different groups and different situations: A (lowest), AA (mid-range), and AAA (highest). Issues marked as A are a must have, AA – should have, AAA stands for good to have. Addressing level A and level AA issues is usually enough to meet accessibility compliance. Addressing AAA as well will make your website fully accessible and easy for use to people with different kinds of disabilities using different types of devices.
6. Reports
The Reports section stands as a detailed repository for investigating the accessibility challenges identified on your website. It provides a structured examination of each detected issue, facilitating an orderly review process. Here’s how to navigate and utilize the Reports for optimal insight:
6.1. Issues List
This section enumerates all discovered accessibility concerns for your website within the chosen timeframe, including:
- Issue (Rule) Name: Clicking this will direct you to a page with further details on the issue (for additional information, refer to section 6.3).
- Severity: Indicates the severity level of each issue.
- Violation: Specifies the violation level associated with each issue.
- Count: Represents the total instances of this issue type identified on the site.
- Page Count: The count of pages detected with this particular issue.
- View Count: The frequency at which this issue type has been encountered by users.
Issues are methodically arranged based on their impact and the frequency of their occurrence. Those with the highest view counts—indicative of critical errors—take precedence. This prioritization underscores the significance of addressing the most impactful problems first, as they pose the greatest barriers to your customers.
6.2. Filters
- Site (Mandatory): Choose a specific site to display its report findings.
- Tag (Optional): Use tags to refine your search results for more precise analysis.
- Date Range (Mandatory): Defines the timeframe for the reported statistics (refer to section 5.1.3).
- Severity (Optional): For details, see section 5.4.
- Violation (Optional): For more information, consult section 5.5.
6.3. Issues Details Page
Upon selecting an issue, you’re directed to a detailed page that outlines where the issue is present. This feature allows for targeted investigation and remediation planning.
For actionable insights and solutions, click the Development Assistant icon adjacent to any page listing. This integration bridges the gap between identification and resolution, streamlining the process of making your website more accessible.
7. Development Assistant
The Development Assistant is an advanced tool within QualiBooth designed to provide a comprehensive analysis of accessibility concerns on your web pages. Here’s how it empowers you to improve accessibility:
7.1 Comprehensive Scans
Automatically evaluates your web pages for accessibility issues, offering a clear score and identifying potential legal risks associated with each page.
7.2 Guided Resolution
Supplies detailed recommendations and visual highlights on your pages to pinpoint and resolve accessibility issues efficiently.
Utilizing the Development Assistant:
Initiating Analysis:
- Access the Development Assistant by selecting its icon either from an issue’s detail page or directly from the main menu.
- Upon activation, the tool will switch your current view to the Development Assistant mode, focusing on the page or site selected for review.
Performing Scans:
- Initiate the scan by clicking on the “Scan the page” option. The tool will then proceed to analyze the selected page in its entirety.
- Following the scan, a comprehensive report detailing all discovered accessibility issues will be presented alongside the page’s overall accessibility score and any associated lawsuit risks.
Issue Resolution:
- Navigate through the reported issues by clicking on each to reveal detailed information about its occurrences on the page.
- For targeted action, click on a specific issue, referred to as a “node.” This action will highlight the issue directly on the web page, visually indicating where adjustments are needed.
- The tool provides clear instructions within the issue description section, offering step-by-step guidance on how developers can rectify the problem, ensuring compliance with accessibility standards.
The Development Assistant streamlines the process of identifying and addressing web accessibility issues, making it an essential component of your onboarding journey with QualiBooth. By following these steps, you can significantly enhance the usability and compliance of your site, contributing to a more inclusive digital environment.
8. Organizations
The Organization within QualiBooth represents the top-level namespace that allows a customer to manage their sites effectively.
A client subscribed to a QualiBooth plan has its own organization.
Clients using Standard, Advanced, or Premium plans are limited to one organization per account, however, they can be part of multiple foreign organizations.
Access the Organizations menu from “My Organizations” item in the main menu.
8.1. Add Organization
There are scenarios for adding organizations, differentiated by customer type:
8.1.1. Non-Enterprise Customers
- These customers may have only one organization.
- If they already have one, they cannot create more, hence the “Add Organization” feature is disabled.
- If a non-enterprise customer is part of a foreign organization without having created their own, they can add an organization via the “Add Organization” button at the bottom of the My Organizations component.
- To add, click on “Add Organization,” enter the Organization name, and confirm.
8.1.2. Enterprise Customers
- Enterprises can manage multiple organizations under a single QualiBooth account, enhancing accessibility management efforts.
When to Consider Multiple Organizations:
- Agencies: Managing separate organizations for different clients simplifies workflows and reporting.
- Large Enterprises: For companies with regional structures, subsidiaries, or distinct divisions, setting up individual organizations for each can enhance organizational clarity.
8.2. Leave Organization
- Users can leave a foreign organization at any point but cannot leave their own organization(s).
- The leave button is located next to the organization name in the My Organizations component (accessed from the main menu -> My Organizations).
8.3. Delete Organization
- Owners of multiple organizations can delete all but one.
- The delete button is positioned alongside the leave button. Owners can delete their organizations, while foreign organization affiliations can only be left, not deleted, so a user will have either only “Delete” option or “Leave” option.
9. User Management
Collaborate for Greater Impact: Elevate your team’s capabilities by adding more users to your QualiBooth account. This feature is available for plans above the Standard level.
9.1. Users
- Overview: The users’ list displays all active users within an organization. The number of allowed users depends on the subscription plan:
- Standard Plan: Limited to one admin user.
- Advanced Plan: Allows for up to 3 users.
- Premium Plan: Supports 10 users.
- Enterprise Customers: No limit on the number of users.
9.1.1. Edit User
- Functionality: Utilize the edit button to modify a user’s role within the organization.
9.1.2. Remove User
- Procedure: Employ the delete button to remove a user from the organization.
9.2. User Invitation Process
- Steps: To invite a new user, select “Invite New User,” enter their email address, assign their role within the platform, and confirm to dispatch the invitation.
9.3. Pending Invites
- Overview: This section shows all users who have been invited to join the organization but have not yet accepted.
- Management Options: Admin/Power users can cancel pending invites, halting the invitation process, or resend invites if necessary.
9.4. Roles
- Fixed Definitions:Roles within QualiBooth are predefined and immutable.
- Admin: The organization’s sole admin user is its creator. Admins have full feature access and can invite new users as either power or regular users.
- Power User: Nearly identical to the admin in privileges, except for the inability to access subscription & billing, thus cannot modify subscription plans or edit billing details. Power users can invite others as either power or regular users.
- User: Regular users lack access to user management, subscription & billing, and configuration menus. They cannot add a new site, delete an existing one, or restore a site that has been deleted.
10. Configuration
10.1. Tags
- Purpose: Utilize tags to narrow dashboard/reports results to specific pages/categories on your website that are of special interest.
10.1.1. Tags List
- Functionality: Expanding a website from the tags list reveals all configured tags for it.
10.1.2. Add Tag
- Process:
- Step 1:Click on the “Add Tag” button next to the site you wish to tag.
- Step 2:Choose a condition. Conditions include:
- Starts with: Targets a page and its subpages. For example, “starts with https://example.com/products” captures the main products page and all subpages like https://example.com/products/shoes.
- Equals: Specifies a particular page. “Equals https://example.com/products” focuses solely on this page, excluding subpages like https://example.com/products/shoes.
- Contains: Aims for a specific phrase across your site. “Contains ‘shoes'” matches various URLs like https://example.com/products/shoes or https://example.com/articles/why-shoes-matter.
- Step 3: Name your tag and confirm to finalize.
- Application: Your tag is now ready for use within dashboards or reports.
10.2. Scanning Options
- Overview: Determines the extent of scanning the browser script performs on your organization’s websites.
- Default: Set at 100%, indicating full scanning of every page visited.
- Adjustment: Altering this to 50% means every second page visited across your websites will be scanned.
11. Subscription & Billing
Our subscription and billing structure is designed to accommodate a wide range of websites, from small personal blogs to large enterprise platforms. Below is a detailed overview of our available plans, subscription management features, account usage, billing details, and financial records.
11.1. Available Plans
- Standard Plan: Ideal for small websites.
- Limits: 1 site, 1 user, 1 organization, up to 100,000 page views/month.
- Advanced Plan: Suitable for small to medium websites.
- Limits: 3 sites, 3 users, 1 organization, up to 1,000,000 page views/month.
- Premium Plan: Best for medium to large websites with high traffic.
- Limits: 5 sites, 10 users, 1 organization, up to 10,000,000 page views/month.
- Enterprise Plan: Tailored for enterprise customers with very high traffic websites.
- Limits: Unlimited sites, unlimited users, multiple organizations, over 10,000,000 page views/month
11.2. Subscription Management
- Free Trial: New customers are granted a 7-day free trial, with a 10,000 page view cap, across all plans.
- Auto-renewal: Plans automatically continue into the next billing cycle unless cancelled beforehand.
- Plan Modification: Customers can switch plans or billing frequencies at any time, with immediate effect for upgrades and end-of-cycle effect for downgrades.
- Cancellation: Subscriptions can be cancelled to remain active until the current cycle ends.
- Trial Conversion: Allows immediate plan activation if the trial’s page view limit is reached.
- Reactivation: Previously cancelled plans can be resumed without additional charges.
- Expired Subscriptions: Users with expired plans need to choose a new plan to continue services without a new free trial.
11.3. Account Usage and Billing
- Usage Monitoring: Keep track of your current usage and compare it against your plan’s limits.
- Billing Details: Access and update your billing information conveniently.
11.4. Financial Records
- Invoices: Manage your invoices and download copies for your records.
- Transactions: Review your account’s detailed transaction history for complete financial oversight.