Product Readiness is in beta. It is available for evaluation and early use, but its features, configuration options and API contracts are still evolving and may change, or be removed, before general availability. We recommend against relying on it for business-critical workflows until the full release.
Once Product Readiness has been configured, you can monitor readiness scores directly from the Product Grid and Product Edit Form to understand which products are ready for publication and which still require attention.
Monitor Readiness from the Activity Dashboard
The Activity Dashboard provides an overview of Product Readiness across your catalog.
- Open the Activity Dashboard.
- Locate the Readiness over Channels and Locales widget.
- Keep All Readiness selected to combine every enabled Readiness Configuration, or select one configuration from the Readiness filter.
- Review the progress bars for each Channel and Locale.
- The Channel progress bar shows the share of evaluated Products that are ready for every applicable Locale and Readiness Configuration on that Channel.
- Each Locale progress bar shows the share of evaluated Products that are ready for that specific Channel and Locale.
- A Product is ready when every applicable score included in the selected view is 100%.
Products without an applicable Readiness Configuration or without a computable score are not included in the evaluated Product count.
Monitor readiness in the Product Grid
The Product Grid provides an overview of readiness across many products, making it easy to identify products that still require work.
- Open the Products page.
- Add the Readiness column if it is not already displayed.
- Review each product's readiness score.
- Filter or sort products to prioritise your enrichment work.
Products may have multiple readiness scores if more than one Readiness Configuration applies.
Review a product's readiness
Open a product to see exactly why it is or is not ready.
- Open a product.
- Select the required Channel and Locale.
- Review the Readiness panel.
- Expand the unmet requirements.
- Update the product information until all requirements have been satisfied.
Navigate between applicable Readiness Configurations
Open the Readiness information in the Product Edit Form to review every configuration that applies to the current Channel.
- The panel displays the score for each configured Locale.
- Select a Readiness Configuration to make it the active configuration in the Product Edit Form.
- If no previous valid selection exists, the Product Edit Form selects the applicable configuration with the lowest score for the current Channel and Locale.
- Your selection is kept for the current browser session while it remains applicable.
- If your role can access Readiness Configurations, use the configuration link to open its definition.
The selected configuration controls the unmet requirements displayed in the Attributes tab. Requirement reasons appear next to the affected Attributes, and the attribute filter can display only Attributes involved in unmet requirements.
Understand readiness results
| Result | Meaning |
|---|---|
| 100% | The product satisfies every applicable requirement. |
| 1–99% | One or more requirements still need attention. |
| 0% | No applicable requirements have been met. |
| N/A | No requirements apply to the selected product. |
Improve product readiness
To improve a product's readiness score:
- Complete missing attribute values.
- Correct invalid values.
- Ensure products belong to the correct categories or groups.
- Complete any required reference entity associations.
- Verify channel-specific and locale-specific content.
Readiness scores update automatically after products or Readiness Configurations are modified.
Filter products by readiness
Use Product Grid filters to focus on products requiring attention.
For example, you can:
- Find products below 100% readiness.
- Find products that are fully ready.
- Filter products using a specific Readiness Configuration.
Available Readiness filters
Select a Readiness Configuration, Channel, and Locale before choosing the result you want to find.
| Filter | Returned Products and Product Models |
|---|---|
| Ready | Entities with a score of 100% for the selected configuration and context. |
| Not ready | Entities with a score below 100% for the selected configuration and context. |
| Evaluated | Entities for which a readiness score is available. |
| Not evaluated | Entities without an available score. The configuration may not apply, no requirement may be computable, or calculation may still be in progress. |
You can also use the unmet requirement filter to select a Readiness Configuration and one or more requirements. The Product Grid then returns the entities that do not meet those requirements in the selected context.
Identify scores being recalculated
When an enabled Readiness Configuration is being recalculated, the Product Grid displays a warning next to the affected Readiness columns and filters.
If your role can access the Process Tracker, use the link in the warning to review the associated background job.
Scores and filters can temporarily reflect the previous calculation while the background job is running.
Use Product Readiness outside the PIM
Product Readiness results can be retrieved through the Akeneo REST API, included in product exports, and used to trigger external processes through the Akeneo Event Platform.
These capabilities let you connect readiness results to syndication, publishing, reporting, workflow, and other external systems.
Retrieve readiness results with the REST API
Readiness results are available on the standard product and product model REST API endpoints through the with_readiness query parameter.
| Value | Returned information |
|---|---|
scores_only |
Returns the aggregated score and the scores for each applicable channel and locale. |
detailed |
Returns readiness scores and the unmet requirements associated with each result. |
API request examples
GET /api/rest/v1/products?with_readiness=scores_onlyGET /api/rest/v1/products-uuid?with_readiness=detailedGET /api/rest/v1/product-models?with_readiness=detailed
Use scores_only when you only need to know whether products are ready. Use detailed when the receiving system also needs to understand why products are not ready.
Filter products by readiness
You can filter products and product models according to their readiness results.
This allows an external system to retrieve only the products relevant to its process. For example, you could retrieve:
- Products that have reached 100% readiness
- Products below a specified readiness score
- Products matching a score for a specific configuration
- Products matching several readiness conditions using AND or OR logic
A syndication process can use these filters to retrieve only products that meet the required publishing conditions.
See the dedicated Readiness API documentation for the complete response structure and filtering syntax.
Export products by readiness
Readiness conditions can also be used when selecting products for an export.
Add readiness filters to a product or product model export profile when you need to export products based on whether they meet a particular business goal.
Include Readiness results in the exported file
Filtering an export by Readiness determines which Products or Product Models are included. To add Readiness results to the generated file, configure the Readiness output in the export profile.
- Exporting scores adds one column for each Readiness Configuration, Channel, and Locale combination.
- Exporting detailed Readiness also adds one column containing the unmet requirements for each combination.
- Unmet requirements are exported as human-readable descriptions.
Readiness column headers use the following formats:
readiness_ratio-{configuration}-{channel}-{locale}readiness_unmet_requirements-{configuration}-{channel}-{locale}
For a configured product or Product Model export, select the Locale used to describe unmet requirements. If no description Locale is configured, the descriptions are generated in English.
For Quick Export, unmet requirements use the current user's UI Locale.
For example, you can configure an export to include:
- Only products that are fully ready
- Products that still require enrichment
- Products evaluated by a particular Readiness Configuration
- Products matching several readiness conditions
Readiness filters determine which products are included in the export. The attributes and other product information included in the generated file are still controlled by the export profile.
React to readiness changes with the Event Platform
The Akeneo Event Platform publishes an event when a product or product model crosses the readiness threshold.
External systems can subscribe to these events and automatically start a follow-up action. For example, a subscriber could begin syndication as soon as a product becomes ready.
Available readiness events
| Event type | When it is published |
|---|---|
com.akeneo.pim.v1.product.became-ready |
A product moves from below 100% to 100% readiness. |
com.akeneo.pim.v1.product.became-not-ready |
A product that was at 100% drops below 100%. |
com.akeneo.pim.v1.product-model.became-ready |
A product model moves from below 100% to 100% readiness. |
com.akeneo.pim.v1.product-model.became-not-ready |
A product model that was at 100% drops below 100%. |
Information included in an event
Each event identifies the affected item and the publishing contexts whose readiness state changed.
- Product events include the product UUID and identifier.
- Product model events include the product model code.
- Events include the exact channel and locale combinations on which the state changed.
Subscribers can use this information to act only on the product and context concerned.
Events are published only when readiness crosses the 100% threshold. They are not published after every readiness calculation.
What can trigger a readiness event?
A readiness state can change after:
- A product or product model is created
- Product information is updated
- A classification or association used by a requirement changes
- A Readiness Configuration is updated
Updating a configuration may affect many products at once. Each product that crosses the readiness threshold can produce an event.
Consider the potential event volume before making significant changes to a configuration used by a large product selection.
See the dedicated Readiness Event documentation for complete payload examples and subscription details.
Choose the right integration method
| Method | Best used for |
|---|---|
| REST API | Retrieving the current readiness state on demand. |
| Product export | Producing scheduled or manually generated files containing a selected set of products. |
| Event Platform | Reacting automatically when a product becomes ready or is no longer ready. |
Example integration flow
- A user completes the missing product information in the PIM.
- The Readiness Engine recalculates the product's score.
- The product reaches 100% readiness for a channel and locale.
- The Event Platform publishes a
became-readyevent. - An external system receives the event.
- The system retrieves the latest product information through the REST API.
- The product is published or syndicated to the appropriate destination.
Frequently asked questions
Why does the same product have several readiness scores?
A product can be evaluated by multiple Readiness Configurations. Each configuration produces its own readiness score.
Why is the score N/A?
None of the configuration's requirements apply to the selected product, so no readiness score can be calculated.
Why hasn't my score updated?
Readiness is recalculated automatically after products or configurations change. Large updates may take time to process.
Can I manually recalculate readiness?
No. Readiness calculations are managed automatically by Akeneo.
Can readiness differ between channels and locales?
Yes. Each channel and locale combination is evaluated independently, so a product may be ready in one context but not another.