AEP Web SDK Engineer Toolkit

Toolkit for AEP Web SDK engineers. Validate ExperienceEvents, inspect Batch Failure IDs, and view debug details.

AEP Web SDK Engineer Toolkit: The Ultimate Debugging and Validation Companion Stop guessing and start knowing. The AEP Web SDK Engineer Toolkit is an essential, comprehensive browser extension meticulously designed for developers, data engineers, and technical marketers who work daily with the Adobe Experience Platform (AEP) Web SDK. It dramatically simplifies the entire lifecycle of developing, debugging, validating, and troubleshooting your AEP implementation, turning complex data streams into a clear, manageable workflow. This toolkit was built to directly address the most common, time-consuming, and critical challenges faced during AEP development: Is my data being captured correctly? Does this complex, nested event payload actually match the XDM schema my data architect designed? Why did this critical batch of data fail during ingestion, and how can I fix it without hours of guesswork? Our toolkit provides immediate, actionable answers to these questions and more. KEY FEATURES IN-DEPTH: Powerful Real-Time Event Debugger: At its core, the toolkit provides a robust event debugger that captures all AEP Web SDK ExperienceEvents in real-time. As you navigate and interact with your site, every event is instantly captured and organized by the page it fired on. Events are displayed in a clean, intuitive, and collapsible tree view, allowing you to see the full event payload, including both xdm and data objects. This provides an immediate, unfiltered look at the data structure and values being sent to the Adobe Edge Network, eliminating the need to sift through network logs. Advanced XDM Schema Validation: This is where the toolkit truly shines. Instead of manually cross-referencing your event payloads with schema documentation, you can validate your data on the fly. After importing your official XDM schemas, the extension automatically compares every incoming event against the active schema. It instantly highlights three critical types of errors directly in the UI: * Data Type Mismatches: Flags fields where the data type (e.g., sending a string when an integer is expected) is incorrect. * Missing Required Fields: Alerts you when a field marked as "required" in your schema is missing from the event payload. * Unmatched Keys: Identifies any fields being sent in the payload that do not exist in the schema, helping you catch typos or deprecated fields. Seamless and Flexible Schema Management: A powerful validator is only as good as the schemas it uses. We provide multiple, flexible ways to import your custom XDM schemas to match your organization's workflow: API Import: Connect directly to the Adobe I/O API using your credentials to browse and import schemas from your various AEP sandboxes (Prod, Stage, Dev). This is the easiest way to ensure you're validating against the official source of truth. Manual Import: You can easily upload a schema file (in .json format) downloaded from AEP or simply paste the raw JSON directly into the extension's options. Intelligent Merging: When you manually import a schema, the extension is smart about it. It automatically detects and filters for just the "mixin" components from your file (ignoring the final, composed schema) and correctly merges them with the necessary standard AEP field groups to create a complete and accurate validation schema. Integrated Batch Inspector for Data Ingestion: Troubleshoot data ingestion failures without ever leaving the AEP UI. This unique feature streamlines a notoriously difficult process: First, configure your Adobe I/O API credentials securely in the extension's options. Then, when you navigate to a failed batch activity page within the Adobe Experience Platform UI, the extension's content script automatically detects the Batch ID and transforms it from plain text into a clickable link. Clicking this link tells the extension to fetch the detailed error logs for that specific batch via the AEP API. The results are displayed directly within the extension popup, helping you identify and fix the root cause of ingestion problems quickly and efficiently. Efficient and Customizable Workflow Tools: The toolkit is packed with features designed to speed up your debugging workflow: Powerful Search: Use the universal search bar to instantly find specific fields or values within complex event payloads. The search supports regular expressions for advanced queries. Advanced Filtering: Cut through the noise by filtering the event view. You can choose to show only events that have validation errors, or you can select specific fields with checkboxes and filter to show only the events containing those fields. Customizable View: Toggle between viewing the raw field name or the more descriptive "friendly name" from your schema. Keyboard Shortcuts: Navigate the extension and perform common actions like toggling capture, toggling validation, and clearing events using intuitive keyboard shortcuts. HOW TO USE: Event Debugging: Simply navigate to any website that has the AEP Web SDK installed and open the extension by clicking its icon in your browser toolbar. As you interact with the page, events will be captured and appear in the "Event Debugger" tab in real-time. Click on any page or event to expand it and view the data payload. Schema Validation: Click the gear icon in the extension popup or right-click the extension icon and select "Options." In the Options page, go to the "API Import" or "Manual Import" tab to add your organization's XDM schemas. Once imported, go to the "Manage Schemas" tab, find the schema you want to validate against, and select its radio button to set it as "active." Return to the Event Debugger. Validation will now run automatically, and any errors will be highlighted. Batch Inspection: First, go to the Options page and navigate to the "API Import" tab. Enter your Adobe I/O API credentials (Client ID, Client Secret, and Organization ID) and save them. Next, navigate to a data ingestion batch failure page within the Adobe Experience Platform UI (e.g., Datasets > a specific dataset > a failed batch). The extension will automatically make the Batch ID on that page a clickable link. Click the link. The extension popup will automatically switch to the "Batch Inspector" tab and display the detailed error report for that batch. The AEP Web SDK Engineer Toolkit is the indispensable tool for building, testing, and maintaining a robust and accurate AEP implementation.