*******NEEDS REVIEWING BY RADU AS THERE IS MORE TO ADD********
Use the new debug information on marketplace product records to verify where a product description is coming from, how it is transformed, and whether it is being included correctly in marketplace payloads.
Tags: admin-tools, marketplace-products, debugging, product-description, reviseXml, encodeRevise, encodeAdd
The debug button now exposes additional description-tracing information for admin users. This is intended to help confirm whether a product description change has propagated through the field rebuild process and into the generated marketplace payloads.
Use this when investigating description-related issues such as:
A changed product description not appearing in marketplace output.
Marketplace payloads appearing to use stale description content.
Differences between the overlay value, stored XML, and runtime encoded payloads.
Confirming whether encodeRevise()or encodeAdd()is using the expected description.
Example Test Product
Use a product that currently has stock.
Product URL:
https://m2.omnivore.com.au/product/view?retailerCode=breville&sku=BES870BSS#marketplace-ebay
Marketplace Product URL:
https://m2.omnivore.com.au/marketplaceProduct/view/86807786?retailerCode=breville
Test Description Change
On the product record, edit the product description so the first sentence is:
***Testing description change***
This string is deliberately obvious so it can be searched for directly in the marketplace product debug output.
Revalidate Product
After editing the description, run:
process map validate
This rebuilds all fields so the changed description can be traced through the marketplace product data and payload generation flow.
Verify the Description in the Marketplace Product
Open the marketplace product record:
https://m2.omnivore.com.au/marketplaceProduct/view/86807786?retailerCode=breville
Use the debug button and search for:
***Testing description change***
The string should appear in these locations:
The overlay.
The stored
reviseXml.The runtime
encodeRevise()output.- The runtime encodeAdd() output.
What Each Location Proves
1. Overlay
Finding the string in the overlay confirms that the rebuilt field data contains the updated product description.
If the string is missing from the overlay, the issue is likely before marketplace XML generation. Check whether the product description was saved correctly and whether process map validate was run after the change.
2. Stored reviseXml
Finding the string in stored reviseXml confirms that the saved revise payload contains the updated description.
If the string appears in the overlay but not in stored reviseXml, the issue is likely in the process that generates or stores the revise XML.
3. Runtime encodeRevise()
Finding the string in runtime encodeRevise() confirms that the revise payload generated at runtime is using the updated description.
If the string appears in stored reviseXml but not in runtime encodeRevise(), compare the stored payload generation path with the runtime encoding path.
4. Runtime encodeAdd()
Finding the string in runtime encodeAdd() confirms that the add/listing payload generated at runtime is also using the updated description.
If the string appears in encodeRevise() but not in encodeAdd(), the add and revise encoding paths may be sourcing or transforming the description differently.
Admin Debug Button Behaviour
The debug button shown in the screenshot is the admin control used to open the marketplace product debug output.
The debug output now includes more detail about:
Where the description value is sourced from.
Which intermediate value is being used.
How the description is transformed before being placed into marketplace payloads.
Whether the transformed value appears in stored and runtime XML outputs.
This makes it easier to separate data-source problems from payload-generation problems.
Expected Result
For the test case above, the search string:
***Testing description change***
should be visible in all four checked areas:
Overlay
Stored
reviseXmlRuntime
encodeRevise()Runtime
encodeAdd()
When it appears in all four places, the description change has successfully propagated from the product description into the marketplace product overlay and both runtime payload generation paths.
Troubleshooting Guide
| Search Result | Likely Meaning | Next Check |
|---|---|---|
| Missing from overlay | Field rebuild did not pick up the updated description, or the product description was not saved | Confirm the description was saved, then rerun process map validate |
Present in overlay, missing from stored reviseXml | Stored revise XML was not regenerated correctly | Check the XML generation/storage path |
Present in stored reviseXml, missing from runtime encodeRevise() | Runtime revise encoding is not using the same source or transformation | Compare stored revise generation with runtime revise generation |
Present in encodeRevise(), missing from encodeAdd() | Add and revise payloads may be using different description logic | Compare description sourcing and transformation in both encoding paths |
| Present in all four locations | Description propagation is working as expected | No propagation issue found |
Notes
This debug flow is for admin/internal investigation only. It should not be treated as a customer-facing validation process.
Use a product with stock when testing marketplace payload behaviour, because out-of-stock products may not exercise the same marketplace update paths.