Product Readiness Overview

Summary

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.

Product Readiness helps you determine whether a product or product model is ready for a specific business purpose, such as publishing to a website, launching a campaign, supplying a marketplace, or releasing a seasonal collection.

Unlike Completeness, which checks whether required family attributes contain values, Product Readiness evaluates configurable business rules against the products, channels, and locales you choose.

How Product Readiness works

A Readiness Policy defines:

  • The products and product models to evaluate.
  • The entity levels to score: products, product models, or all levels.
  • The channels and locales where the scores apply.
  • Optional one-step locale fallbacks.
  • The requirements that determine whether an entity is ready.
  • By default, each requirement applies to all channels selected in the policy. You can limit a requirement to one or more of those channels. For a requirement group, the channel selection is defined on the group and applies to all its child requirements.
  • When Akeneo calculates a score for a channel, it includes only the requirements and requirement groups that apply to that channel.
  • When an enabled policy applies to an entity, Akeneo calculates one score for every selected channel and locale combination. Draft configurations are not evaluated and do not produce scores.
 

Understand readiness scores

A readiness score is the percentage of applicable top-level requirements that the entity meets:

Score = 100 × met applicable requirements ÷ total applicable requirements

The result is rounded to the nearest whole number.

Result Meaning
100% Every applicable top-level requirement is met for the selected configuration, channel, and locale.
1–99% At least one applicable requirement is met and at least one is unmet.
0% Requirements apply, but none are met.
N/A or Not evaluated No score is available. The entity may be outside the product selection, every requirement may have been skipped, or a recalculation may still be running.

Only applicable requirements count. For example, an attribute requirement is skipped when the attribute does not belong to the product's family. If every top-level requirement is skipped, no percentage can be calculated.

How groups affect the score

  • A configuration can contain up to 25 individual requirements, including requirements nested inside groups.
  • An AND group passes when every applicable child requirement passes.
  • An OR group passes when at least one applicable child requirement passes.
  • A group counts as one top-level requirement in the score, regardless of the number of children it contains.
  • Skipped child requirements are ignored. If every child is skipped, the group is skipped.

How locale fallbacks work

If the value for the evaluated locale is empty, a fallback can tell Readiness to evaluate another locale. Fallbacks support one step only. For example, fr_BE → fr_FR is supported, but fr_BE → fr_FR → fr_CA is not.

Configuration-specific and aggregated scores

Akeneo provides two complementary views:

  • Readiness: the score for one configuration, channel, and locale.
  • Readiness by channel: an aggregated score across all applicable configurations for a channel.

To calculate the aggregated score, Akeneo first averages the selected locale scores within each configuration. It then averages those configuration results with equal weight and rounds the final value.

Example: if one configuration averages 75% across its locales and another contributes 85%, the aggregated channel score is 80%.

View Product Readiness in the PIM

Product Edit Form

The product header shows readiness information for the selected channel and locales. Open it to review the applicable configurations and unmet requirements. In the Attributes tab, use All attributes with unmet requirements to display only the attributes involved in unmet requirements for the selected configuration, channel, and locale.

Product Readiness panel in the Product Edit Form

Unmet requirements for a Readiness Configuration in the Product Edit Form

Product Grid

In the column selector, open Product Health and add:

  • A configuration-specific Readiness column for a selected channel and locale.
  • An optional Readiness by channel column using all configured locales or selected locales.

The configuration-specific column can be sorted. The aggregated Readiness by channel column cannot be sorted.

Readiness Configuration columns in the Product Grid

Product Readiness vs Completeness

  Completeness Product Readiness
Purpose Checks whether required family attributes contain values. Checks whether configurable business rules are met.
Configuration One definition per family. Several configurations can run at the same time.
Scope Based on the product family. Based on selected products, entity levels, channels, and locales.
Result Complete or incomplete. A score from 0 to 100 for each channel and locale.

What can a requirement check?

Requirements can evaluate product organization and many attribute types, including:

  • Status, categories, and groups.
  • Identifiers, text, text areas, and rich text.
  • Numbers, measurements, prices, and currencies.
  • Dates and booleans.
  • Simple-select and multi-select options.
  • Images, files, tables, and asset collections.
  • Reference Entity records, including associated-record completeness.

The available operators depend on the selected field type.

Use Product Readiness outside the PIM

  • Use the REST API to retrieve and filter scores, aggregated scores, and unmet requirements.
  • Use standard exports or Quick Export to include readiness results in CSV or XLSX files.
  • Use the Event Platform to react when a product or product model becomes ready or not ready.

See the Readiness API documentation and the Readiness Event documentation.