📘 This article provides information on how to set rules to monitor the quality of pages delivered to bots by SpeedWorkers.SpeedWorkers is part of Botify's Activation Suite, available as an option with a Botify Pro or Enterprise plan.
Overview
Quality controls help ensure that pages served to bots contain all of the useful content blocks needed for indexation. SpeedWorkers checks pages against the quality controls when rendered and provides warnings when expected items are not present in the HTML.
There are two types of quality controls:
Fail and Deliver: This type of quality control failure indicates the failure on the Render Quality page that your defined control was not met.
Fail and Do Not Deliver: This type of quality control failure indicates the failure and also prevents the cached page from being delivered to bots. When there is a quality control failure, the bot request is forwarded to the origin server.
See the Quality Control Fails chart on the Render Quality page for information on warnings and failures.
Defining Quality Controls
Access the Quality Control settings by navigating to Activation > Speedworkers > Settings > Quality Controls:
Defining quality controls includes the following steps:
To define a quality control:
If settings are not in Edit mode, refer to the Defining SpeedWorkers Settings article to enable editing.
Click the Create new control link, or hover over an existing control and click the pencil icon to edit.
Define the scope, and then click Next.
Set the goal, and then click Next.
Set the action, and then click Next.
Review your settings, then click Save to save the savings but not activate it yet, or click Save & Activate to put the control into effect immediately. If you choose only to save the control at this step, you can activate the control later.
👉 If you are editing an existing control that is currently active, only the Save button is displayed here.
Defining the Scope
The scope determines the pages to which the quality control will apply.
Provide a title and, optionally, a description to identify the control.
From the first dropdown list, select the element by which you want to define the scope (e.g., URL).
Select the operator from the second dropdown list that determines the relationship between the element you selected above and the string to be matched (e.g., contains).
In the text field, identify the string to be matched (e.g., "/product/").
Optionally, click the Add a Condition link to add another condition to be matched for this custom behavior.
In the Device section, select whether the control should apply to the desktop version of pages, the mobile version, or both.
Setting the Goal
The goal identifies the specific item to locate on the page defined by the quality control. Set a goal for the control by one of the following:
Setting Goals by Element
Click the Search for an element block.
Identify a CSS selector to locate the page element defined in the quality control. Please refer to the Using CSS Selectors in SpeedWorkers article for more information.
Choose the expected behavior for the element: either the element exists on the page or is found on the page according to a threshold of occurrences.
Setting Goals by Text
Click the Search for text block.
Identify a CSS selector that will locate the text being defined in the quality control. Please refer to the Using CSS Selectors in SpeedWorkers article for more information on using CSS Selectors in SpeedWorkers.
Identify the specific text to be located on the page:
First match found contains the searched text: The first occurrence of the identified CSS Selector contains the text.
All matches found contain searched text: All occurrences of the identified CSS Selector contain the text.
Choose the expected behavior for the text.
Testing the Control
To ensure your CSS Selector will work as expected, test the control before proceeding to the next step.
To test the control:
Scroll to the bottom of the Set Goal tab.
In the URL text box, type the full URL of a page within the defined scope, including the protocol (e.g., https://www.example.com). To test multiple URLs at the same time, type one per line.
Click the Test it button. A Results section displays one of the following results for each URL:
Success: The element or text was located on the page as defined by the CSS Selector.
Fail: The element or text was not located on the page as defined by the CSS Selector.
Not Cached: The page is not included in the defined scope of the quality control.
Setting the Action
The quality control action identifies what SpeedWorkers should do if the quality control fails.
To set the action, choose one of the following options:
Deliver the page: SpeedWorkers will provide a notification of the quality control failure but will still deliver the page to bots.
Do not deliver the page: SpeedWorkers will provide a notification of the quality control failure and will not deliver the page to bots. Bot requests will be redirected to the origin server.
👉 Quality control failures are reported on the Delivery Center and Render Quality pages.
Activating/Deactivating Quality Controls
The main Quality Controls page in SpeedWorkers settings shows the status of each control. To activate a control, slide the Status toggle to the right; to deactivate, slide the toggle to the left.
Deleting Quality Controls
To delete a quality control:
Hover over the control name on the main Quality Controls page in SpeedWorkers settings, then click the trash can icon.
Click Delete in the confirmation message.
Read next: