Product Readiness Overview

Summary

Product Readiness helps you determine whether a product is ready for a specific publishing goal, channel, or locale.

Unlike native Completeness, which checks whether required family attributes contain values, Product Readiness lets you define custom business requirements and apply them to the products you choose.

How Product Readiness works

Product Readiness evaluates products against the requirements defined in a Readiness Configuration. It then calculates a readiness score for every applicable channel and locale.

  1. Create a Readiness Configuration from Settings → Readiness.
  2. Select the products, channels, and locales covered by the configuration.
  3. Define the requirements products must meet.
  4. Akeneo automatically evaluates the selected products and calculates their readiness scores.
  5. Review unmet requirements and update the product information until the product is ready.

Readiness scores are calculated automatically. You do not need to trigger the calculation manually.

Understand readiness scores

A readiness score represents the percentage of applicable requirements that a product meets for a particular configuration, channel, and locale.

  • 100% means the product meets every applicable requirement.
  • A score below 100% means one or more requirements still need attention.
  • N/A means the product is covered by the configuration, but none of its requirements can be evaluated against it. The product is in scope — there is simply nothing to check.
  • A product that is not selected by the configuration has no score at all, rather than N/A. It is not evaluated and does not appear in that configuration's results.

The score is calculated using the following formula:

Score = 100 × met requirements ÷ applicable requirements

The result is rounded to the nearest whole number.

Only applicable requirements count towards the score, not every requirement in the configuration. A product whose family contains only two of the five attributes checked by a configuration is scored on those two. Scores are therefore not always calculated from the same number of requirements, and two products both showing 100% may have been checked against a different number of requirements.

Readiness Configuration columns in the Product Grid

How requirements affect the score

  • A Readiness Configuration can contain up to 25 requirements.
  • Requirements can be grouped using AND or OR logic. A requirement group counts as one requirement in the score.
  • A requirement does not apply to a product when it checks an attribute that is not part of the product's family. Requirements that do not apply are skipped and removed from the calculation.
  • A requirement group is only skipped if every requirement inside it is skipped. If at least one requirement in the group applies, the group is still evaluated.
  • If every requirement is skipped, the product receives an N/A score. This does not mean the product has been excluded from the configuration. It means the configuration's requirements have nothing to check on this product, usually because they were designed around attributes belonging to a different family.

If you see N/A on products you expected to be scored, review the families of those products against the attributes used in your requirements. A configuration covering several families may need requirements that apply across all of them.

View Product Readiness

Product Readiness results are available directly in the PIM, allowing users to understand whether a product is ready and identify what still needs to be corrected.

Product Edit Form

The Product Edit Form displays a Readiness panel in the product header.

  1. Open a product in the Product Edit Form.
  2. Select the Channel and Locale you want to review.
  3. Review the readiness score displayed in the panel.
  4. If several configurations apply, open the panel to switch between them.
  5. Expand the unmet requirements to see what needs to be corrected.
Product Readiness panel in the Product Edit Form
Review a product's readiness score and unmet requirements from the Product Edit Form.

Product Grid

You can also monitor Product Readiness across multiple products from the Product Grid.

Add Readiness information to the grid to compare scores, identify products that need attention, and focus enrichment work on products that are not yet ready.

Product Readiness vs Completeness

Completeness and Product Readiness provide different ways to measure product information quality.

Completeness Product Readiness
Based on required attributes in the product family. Based on configurable business requirements.
Checks whether required attribute values have been provided. Checks whether products meet the conditions of a specific publishing or business goal.
Defined through the product data model. Defined through Readiness Configurations.
Primarily supports the enrichment process. Can support publishing, syndication, compliance, campaigns, and other workflows.
Uses the required attributes of the product's family. Allows several configurations to apply to the same product.

Completeness tells you whether required product information has been provided. Product Readiness tells you whether the product meets the requirements of a particular business goal.

What can a Readiness Configuration check?

Readiness requirements can evaluate product attributes and system information, including:

  • Whether an attribute contains a value
  • Boolean values
  • Text content
  • Dates
  • Prices and currencies
  • Simple-select and multi-select options
  • Media, image, and table attributes
  • Categories and groups
  • Reference entity associations
More Unmet requirements for a Readiness Configuration in the Product Edit Form

Requirements can be limited to particular channels or locales so that the same product can have different readiness results in different publishing contexts.

Common use cases

You can create separate Readiness Configurations for different business goals, such as:

  • Publishing products on an ecommerce channel
  • Syndicating products to a retailer or marketplace
  • Preparing products for a regional launch
  • Checking legal or regulatory information
  • Validating campaign-specific content
  • Triggering an external process when a product reaches 100%

Use Product Readiness outside the PIM

Product Readiness results can also be used by external systems through the Akeneo REST API and Event Platform.

  • Use the REST API to retrieve readiness scores and unmet requirements for products and product models.
  • Use the Event Platform to react when a product or product model becomes ready or is no longer ready.

For example, an external system could automatically begin syndication when a product reaches a readiness score of 100%.

See the dedicated Readiness API documentation for endpoint and filtering details.

 

See the dedicated Readiness Event documentation for available events and payload details.

 

Next steps

  • Create and manage a Readiness Configuration.
  • Define the product selection and requirements.
  • Monitor readiness scores in the Product Grid and Product Edit Form.
  • Select the relevant channels and locales.