- 08 May 2024
- 2 Minutes to read
XML Integration Validator
- Updated on 08 May 2024
- 2 Minutes to read
To prevent XML resources from being inserted into the catalog database without validation, you can use the XML Integration Validator. To reach the XML Integration Validator, navigate to Components > Product Catalog Management > XML Integration.
In this article, you can find answers to the following questions:
- How does XML Integration Validator work?
- What are the statuses?
- What are the details of the report?
- What are the common questions?
How does it work?
When you create a new XML source, or update an existing one, the system automatically starts to validate the XML and ensures that no XML file is inserted without being validated.
Whenever you make a change to the XML details or create a new XML resource, and want to activate it, the only option available will be "validate" against the product catalog on the Product Catalog Management listing page. If the validation is successful, you will be able to activate the XML.
Statuses
You will see 7 different statuses for the XML integrations.
- Active status means XML is being fetched and processed with the defined frequency.
- Passive status means it can be updated but it does not affect the catalog database.
- Validation Pending status is seen when you click the Validate button, and the initial checks are executed. It is a temporary status and quickly transforms into the Validating status.
- Validating status is seen when the system is downloading and processing the XML file. The duration might vary depending on the file size and internet connection.
- Ready to Activate status means the XML validation is successful and you can activate it. To do so, click the Activate option from the menu. If you face any optional attribute problems, you can click the Download icon against the catalog and see the results.
- Validation Failed status means the XML is not compatible with the minimum requirements and the XML file has some errors. You can download the report via the Download icon against the catalog, view the errors, and correct them.
- System Error status means the XML validation failed. In this case, contact Insider team.
The Report
The report consists of two parts which are summary and details.
- The first part is the summary and it includes the following fields shown with sample data:
Issue Time | 2023-03-23 03:23:23 |
Product Catalog Integration Method | XML |
Partner ID | MyPartnerID |
Partner Name | Mybrand |
Locale | en_US |
XML Configuration Name | XML - EN - 0123 |
XML Source | https://example.useinsider.com/feed/download?id=01&file=master_feed_insider.xml |
Report ID | ABC123123 |
Total Number of Products | 1.000.000 |
Successful / Eligible Product | 900.000 |
(Unique) Products with Errors | 100.000 |
- The second part shows the specific errors and their details. It lists all errors regarding the XML with product IDs (up to 10 for each error).
Issue Type | Data Limit Error |
Error Count | 1.234 |
Description | The attribute length must be less than or equal to 512 characters long. Please check the system rules. |
Error Message | Field is invalidated: "category[0]" is not allowed to be empty. |
Attribute | category |
Sample Product ID(s) | 12345, 123134, 13123, 132131, 131213, 13132 |
ID | Issue type+attribute name |
FAQ
Q: What happens if I update an active XML file?
A: It is automatically set as passive and the validation starts. The XML file being passive doesn’t interfere with the existing catalog or recommendations. They are not updated for a couple of hours until you correct the XML file integration. During this period, stock-out API, clickstream, and hit-checker will continue to make stock-out operations (if they are enabled for you).
Q: What happens if I want to work on the XML file more and don’t want to submit it for validation? Do I have to wait until the validation is completed each time I make a change?
A: No, you don't. You can always save your work as a draft on the editing screen.