• v5.0
    • Versions
    • master

 

  • Install Akeneo PIM
    • Install Akeneo PIM for development with Docker
    • Install Akeneo PIM manually
      • System Requirements
      • System installation on Debian 10 (Buster)
      • System installation on Ubuntu 18.04 (Bionic Beaver)
      • System installation on Ubuntu 20.04 (Focal Fossa)
      • Installing Akeneo PIM Community Edition (CE)
      • Installing Akeneo PIM Enterprise Edition (EE) with the Archive
      • Setting up the job queue daemon
      • Setting up the Events API
    • How to customize the Dataset
    • How to Add Translation Packs
  • Upgrade Akeneo PIM projects
    • How to apply a patch?
      • How to apply a patch - Community Edition
      • How to apply a patch - Enterprise Edition - Flexibility Cloud offer
      • How to apply a patch - Enterprise Edition - On Premise offer
    • Where is the Changelog?
    • How to upgrade to a minor version?
    • How to upgrade to a major version?
      • Upgrade from 3.2 to 4.0
      • Upgrade from 4.0 to 5.0
  • Import and Export data
    • How import works
    • Understanding the Product Import
    • Understanding the Product Export
    • Formats
      • Localized labels
      • Scopable labels
      • Association types data structure
      • Attribute data structure
      • Category data structure
      • Family data structure
      • Family variant data structure
      • Group data structure
      • Options data structure
      • Product data structure
      • Product model data structure
    • Akeneo Connectors
    • How to Customize Import / Export
      • How to create a new Connector
      • How to import Products from a XML file
      • How to clean a CSV file during a Product import
      • How to automate imports/exports
  • Manipulate the Akeneo PIM data
    • How to Customize Mass Edit Operations
      • How to register a new bulk action
      • How to Register a New Mass Edit Action on Products
    • How to Manipulate Products
      • How to Query Products
      • How to Create Products
      • How to Update Products
      • How to Validate Products
      • How to Save Products
      • How to Remove Products
    • How to Manipulate Non-Product Objects
      • How to Query Non-Product Objects
      • How to Create Non-Product Objects
      • How to Update Non-Product Objects
      • How to Validate Non-Product Objects
      • How to Save Non-Product Objects
      • How to Remove Non-Product Objects
    • How to add a custom action rule
      • General information about rule format
      • How to add a custom action in the rule engine
    • How to Define Access Control List
    • How to Customize the Catalog Structure
      • How to Create a Reference Data
    • How To Customize Teamwork Assistant (Enterprise Edition)
      • Customize notifications
      • Add a calculation step
      • How to log calculation step
      • Remove projects impacted by a custom catalog update
    • How to store assets externally
    • How to Configure Measurement Limits
  • Maintain Akeneo PIM projects
    • First aid kit
    • Bug qualification
    • Common issues
    • Scalability Guide
      • Audit with 3 Representative Catalogs
      • More than 10k attributes?
      • More than 10k families?
      • More than 10k categories?
      • More than 500 attributes usable in the product grids?
      • More than 100k products to export?
      • More than 1GB of product media to export?
    • How to purge history
      • How to Purge jobs executions
      • How to adapt the version purger to your needs
  • Contribute to Akeneo PIM
    • How to report an issue?
    • How to translate the user interface?
    • How to enhance the documentation?
    • How to contribute to a Connector?
    • How to submit a patch to the PIM?
    • How to contribute to the frontend part of the application
    • How behavior tests are architectured in the PIM?
      • Establishing Decorator Pattern
      • Using Spin In Behat
  • Use SSO authentication locally
  • Reference Entities
    • Configure Entity Limits
    • Create a new Reference Entity Attribute type
    • Enrich Records with a new Reference Entity Attribute type
    • Add a Custom Property to Your Custom Attribute Type
    • Refresh records completeness
  • Troubleshooting guide
  • Technical overview
    • Product Information
    • Teamwork Assistant (Enterprise Edition)
      • Project creation
      • Project completeness
      • Project Completeness widget
      • Catalog update impact
      • Scalability guide
      • Users permission summary for Behat tests
    • Collaborative workflow
      • Simple workflow
      • Partial workflow
  • Technical architecture
    • Best Practices
      • Create a project
      • Create a reusable bundle
      • Code Conventions
      • Coding Standards
    • How to implement your business logic using the event system
    • Events
      • Storage events
      • Workflow events (Enterprise Edition only)
    • How to Localize your data
      • How to change the PIM locale
      • How to Use Localizers
      • How to use Presenters
    • How to Add a Notification
    • Performances Guide
      • Memory usage of rules execution (Enterprise Edition)
      • Memory leak fix in Rules Engine (ORM)
      • More than 100 WYSIWYG editors in a page
      • PHP7 and HHVM Compatibility?
      • Job product batch size
    • How to Use the Web REST API
    • Standard format
      • Products
      • Other entities
      • Usage
    • Application Technical Information
      • Application Technical Dependencies
      • Server side set up for hosting
      • System Requirements
      • Recommended configuration
      • Client side configuration and compatibilities
      • Operation processes
      • Flow Matrix
  • Akeneo Cloud Edition
    • Flexibility
      • Environment accesses
      • System Administration & Services Management
      • Periodic tasks & Crontab configuration
      • Composer settings
      • Queue Management & Workers
      • Disk Usage Management
    • Serenity
  • Akeneo Onboarder
    • Prerequisites
    • How to install the Onboarder bundle
    • Synchronization
    • How to update a minor version or to apply a patch
      • How to update the Onboarder bundle - Enterprise Edition - Flexibility Cloud offer
      • How to update the Onboarder bundle - Enterprise Edition - On Premise offer
    • How to upgrade to a major version
    • Troubleshooting
    • How to uninstall the Onboarder bundle
    • Environment variables
      • Using the DotEnv file
      • Using environment variables

Workflow events (Enterprise Edition only)¶

Workflow events are dispatched in the PIM on some workflow actions, mainly in product draft steps (sent for approval, rejected, deleted, approved…) and publication feature. They are basically useful if you want to add your business logic before or after those specific actions.

Publish Workflow Event Actions¶

When a product is published:

  1. pimee_workflow.published_product.pre_publish

  2. The product object is published

  3. pimee_workflow.published_product.post_publish (only on flush!)

When a product is unpublished:

  1. pimee_workflow.published_product.pre_unpublish

  2. The product object is unpublished

  3. pimee_workflow.published_product.post_unpublish (only on flush!)

pimee_workflow.published_product.pre_publish¶

This event is dispatched before a product is published.

Event Class: Akeneo\Pim\WorkOrganization\Workflow\Bundle\Event\PublishedProductEvent

pimee_workflow.published_product.post_publish¶

This event is dispatched after a product has been published.

Event Class: Akeneo\Pim\WorkOrganization\Workflow\Bundle\Event\PublishedProductEvent

Built-in PIM subscribers registered to this event

Listener Class Name

Priority

Akeneo\Pim\WorkOrganization\Workflow\Bundle\EventSubscriber\PublishedProduct\DetachProductPostPublishSubscriber

0

pimee_workflow.published_product.pre_unpublish¶

This event is dispatched before a product is unpublished.

Event Class: Akeneo\Pim\WorkOrganization\Workflow\Bundle\Event\PublishedProductEvent

pimee_workflow.published_product.post_unpublish¶

This event is dispatched after a product has been unpublished.

Event Class: Akeneo\Pim\WorkOrganization\Workflow\Bundle\Event\PublishedProductEvent

Draft/Proposal Workflow Event Actions¶

When a product draft is sent for approval:

  1. pimee_workflow.product_draft.pre_ready

  2. The product draft status is updated to be reviewed

  3. pimee_workflow.product_draft.post_ready

When a product draft change is approved (partial approval):

  1. pimee_workflow.product_draft.pre_partial_approve

  2. The product is fetched from the product draft

  3. pimee_workflow.product_draft.pre_apply

  4. The product object is updated with product draft values (but not saved yet)

  5. pimee_workflow.product_draft.post_apply

  6. The product is saved with the new values, and the draft is updated/removed

  7. pimee_workflow.product_draft.post_partial_approve

When a product draft change is rejected (partial reject):

  1. pimee_workflow.product_draft.pre_partial_refuse

  2. The product draft change is updated and is set to “in progress”

  3. pimee_workflow.product_draft.post_partial_refuse

When a product draft is approved:

  1. pimee_workflow.product_draft.pre_approve

  2. The product is fetched from the product draft

  3. pimee_workflow.product_draft.pre_apply

  4. The product object is updated with product draft values (but not saved yet)

  5. pimee_workflow.product_draft.post_apply

  6. The product is saved with the new values, and the draft is updated/removed

  7. pimee_workflow.product_draft.post_approve

When a product draft is rejected:

  1. pimee_workflow.product_draft.pre_refuse

  2. The product draft status is updated

  3. pimee_workflow.product_draft.post_refuse

When a product draft is deleted:

  1. pimee_workflow.product_draft.pre_remove

  2. Product draft is removed from the DB

  3. pimee_workflow.product_draft.post_remove

pimee_workflow.product_draft.pre_ready¶

This event is dispatched before a product draft status is set to “ready”.

Event Class: GenericEvent

pimee_workflow.product_draft.post_ready¶

This event is dispatched after a product draft’s status has been set to “ready” and saved to DB. The product draft now becomes a proposal, ready to be reviewed.

Event Class: GenericEvent

Built-in PIM subscribers registered to this event

Listener Class Name

Priority

Akeneo\Pim\WorkOrganization\Workflow\Bundle\EventSubscriber\ProductDraft\SendForApprovalSubscriber

0

pimee_workflow.product_draft.pre_approve¶

This event is dispatched before a product draft is approved.

Event Class: GenericEvent

pimee_workflow.product_draft.post_approve¶

This event is dispatched after a product draft has been approved. The product is updated and saved with the new values, and the product draft is removed or updated.

Event Class: GenericEvent

Built-in PIM subscribers registered to this event

Listener Class Name

Priority

Akeneo\Pim\WorkOrganization\Workflow\Bundle\EventSubscriber\ProductDraft\ApproveNotificationSubscriber

0

pimee_workflow.product_draft.pre_partial_approve¶

This event is dispatched before a product draft is partially approved. A partial approve is about a specific single change of the product draft.

Event Class: GenericEvent

pimee_workflow.product_draft.post_partial_approve¶

This event is dispatched before a product draft is partially approved. The product is updated and saved with the new values, and the product draft is removed or updated. A partial approve is about a specific single change of the product draft.

Event Class: GenericEvent

Built-in PIM subscribers registered to this event

Listener Class Name

Priority

Akeneo\Pim\WorkOrganization\Workflow\Bundle\EventSubscriber\ProductDraft\ApproveNotificationSubscriber

0

pimee_workflow.product_draft.pre_apply¶

This event is dispatched before a product object is updated from draft values.

Event Class: GenericEvent

pimee_workflow.product_draft.post_apply¶

This event is dispatched after a product object has been updated from draft values. Note that the product is not saved yet, only the product object is updated.

Event Class: GenericEvent

pimee_workflow.product_draft.pre_refuse¶

This event is dispatched before a product draft is refused.

Event Class: GenericEvent

pimee_workflow.product_draft.post_refuse¶

This event is dispatched after a product draft has been refused. The product draft is updated in the DB.

Event Class: GenericEvent

Built-in PIM subscribers registered to this event

Listener Class Name

Priority

Akeneo\Pim\WorkOrganization\Workflow\Bundle\EventSubscriber\ProductDraft\RefuseNotificationSubscriber

0

pimee_workflow.product_draft.pre_partial_refuse¶

This event is dispatched before a product draft is partially refused. A partial refuse is about a specific single change of the product draft.

Event Class: GenericEvent

pimee_workflow.product_draft.post_partial_refuse¶

This event is dispatched before a product draft is partially refused. The product draft is removed or updated. A partial refuse is about a specific single change of the product draft.

Event Class: GenericEvent

Built-in PIM subscribers registered to this event

Listener Class Name

Priority

Akeneo\Pim\WorkOrganization\Workflow\Bundle\EventSubscriber\ProductDraft\RefuseNotificationSubscriber

0

pimee_workflow.product_draft.pre_remove¶

This event is dispatched before a product draft is removed.

Event Class: GenericEvent

pimee_workflow.product_draft.post_remove¶

This event is dispatched after a product draft has been removed.

Event Class: GenericEvent

Built-in PIM subscribers registered to this event

Listener Class Name

Priority

Akeneo\Pim\WorkOrganization\Workflow\Bundle\EventSubscriber\ProductDraft\RemoveNotificationSubscriber

0

Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!