Extension : Apollo QAX
Apollo adds and configures the Apollo Quality Assurance Extension, which helps to ensure the accuracy of Adobe Analytics data. It is a companion extension for Adobe Analytics that inspects each beacon prior to being sent, validating for syntax and content. View a demonstration of tag validation with Apollo QAX in the video below:
There are optional manual configurations users can make within this extension in Experience Platform Launch. It’s important to note that all settings changes must be saved and built into a relevant launch property library to take effect.
Enabled Environments
This option allows you to enable or disable the extension for libraries in any or all of the 3 launch environments.
Airbrake Integration
Apollo QAX includes an optional integration with Airbrake for logging errors. Airbrake is a paid tool for use with a subscription, which provides error monitoring and performance management for your implementation so you can be notified of and resolve issues faster.
The configuration to enable the Airbrake Integration with Apollo QAX requires the Airbrake Project ID and Project Key.
The Project ID and API Key can be retrieved from the Airbrake project settings after a project is created in Airbrake.
Other Settings
The other settings in the Apollo QAX extension affect how QAX validates Adobe Analytics tags. Apollo QAX enables these settings by default but users may choose to disable any of the validations. These settings include:
General Settings
Range Validations
Currency Code Validations
Miscellaneous Validations
s.events Validations
s.products Validations
If manual configuration changes are made within the extension after it’s configuration by Apollo, here is how Apollo will interact with those changes during subsequent builds:
Section | Manual Change Made | Apollo’s Treatment |
Installed | Disable Extension | Apollo does not overwrite the change |
Installed | Uninstall Extension | Causes deployment to fail (even redeployments of initial build that created the extensions) |
Enable Environments | Enable A Launch Environment | Apollo does not overwrite the change |
Enable Environments | Disable A Launch Environment | Apollo does not overwrite the change |
Airbrake Integration | Airbrake Project Id/Key Additions | Apollo does not overwrite the change |
General Settings | Increase Maximum Evar | Apollo does not overwrite the change |
Range Validations | Disable Props | Apollo does not overwrite the change |
Range Validations | Disable Evars | Apollo does not overwrite the change |
Range Validations | Disable Listvars | Apollo does not overwrite the change |
Range Validations | Disable Hierarchy Vars | Apollo does not overwrite the change |
Misc. Validations | Disable Variable Casing | Apollo does not overwrite the change |
Misc. Validations | Disable Byte Limits | Apollo does not overwrite the change |
Misc. Validations | Disable Pagetype | Apollo does not overwrite the change |
Misc. Validations | Disable Pagename With Pagetype | Apollo does not overwrite the change |
Misc. Validations | Disable Leading Spaces | Apollo does not overwrite the change |
Currency Code Validations | Disable Currencycode Format | Apollo does not overwrite the change |
Currency Code Validations | Disable Currencycode For Currency Events | Apollo does not overwrite the change |
Currency Code Validations | Currency Event Removals | Apollo does not overwrite the change |
Currency Code Validations | Currency Event Additions | Apollo does not overwrite the change |
S.Events Validations | Disable No Spaces | Apollo does not overwrite the change |
S.Events Validations | Disable No Repeating Commas | Apollo does not overwrite the change |
S.Events Validations | Disable Only Numeric Values | Apollo does not overwrite the change |
S.Events Validations | Disable Serialization Keys | Apollo does not overwrite the change |
S.Events Validations | Disable Serialization Key Character Limit | Apollo does not overwrite the change |
S.Events Validations | Disable Purchaseid For Purchase Event | Apollo does not overwrite the change |
S.Products Validations | Disable Setting Of Product Syntax Merch Vars | Apollo does not overwrite the change |
S.Products Validations | Product Syntax Merch Var Removals | Apollo does not overwrite the change |
S.Products Validations | Product Syntax Merch Var Additions | Apollo does not overwrite the change |
S.Products Validations | Disable Setting Of Non Product Syntax Merch Vars | Apollo does not overwrite the change |
S.Products Validations | Disable Byte Limit For Product String Category | Apollo does not overwrite the change |
S.Products Validations | Disable Byte Limit For Product String Name | Apollo does not overwrite the change |
S.Products Validations | Disable Product Name Exists | Apollo does not overwrite the change |
S.Products Validations | Disable Only 6 Parts In The Products Variable | Apollo does not overwrite the change |
S.Products Validations | Disable Product Quantity Is A Number | Apollo does not overwrite the change |
S.Products Validations | Disable Product Cost Is A Number | Apollo does not overwrite the change |
S.Products Validations | Disable Cost And Quantity On Non Purchase Beacons | Apollo does not overwrite the change |
Apollo QAX for Ensuring Tags are Vendor Complaint
For each of the enabled configuration options in the Apollo QAX extension and for each environment QAX is enabled, Apollo runs a compliance test on any outgoing Adobe Analytics tag. If you are using the Launch & DTM Switch Chrome Extension with Debug mode enabled you will see console logs of the test results when each Adobe Analytics tag is fired.
In the event that a test fails you will see both the log output from the initial running of the test as well as the error information. The error information includes the environment the error occurred in as well as more information around how the tag failed the test:
If the Airbrake Integration Settings are configured, then any errors are also logged and aggregated in Airbrake.
For more information on Apollo QAX, you can read the technical documentation for the extension here.