• v6.0
    • Versions
    • master

 

  • Migrate to Serenity (SaaS)
  • 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
      • Security best practices
      • 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
    • What is a Changelog?
    • Where is the Changelog?
    • How to upgrade to a minor version? (PIM version < 4.x)
    • How to upgrade to a major version?
      • Upgrade from 3.2 to 4.0
      • Upgrade from 4.0 to 5.0
      • Upgrade from 5.0 to 6.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
    • How to Configure the Event Subscription network restrictions
  • 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
      • How to purge events API logs
  • 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 & Consumers
      • 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
  • About Log4Shell Vulnerability for SaaS Users
  • About Log4Shell Vulnerability for Flexibility v5 Users
  • About Log4Shell Vulnerability for Flexibility users below v5.0

How to add a custom action in the rule engine¶

Quick Overview¶

This cookbook is about a feature only provided in the Enterprise Edition.

This cookbook assumes that you already created a new bundle to add your custom rule. Let’s assume its namespace is Acme\CustomBundle.

Create a custom action¶

In this cookbook we are going to see how to add a custom action in the rule engine. For this example, the goal of this rule is to concatenate attributes name, price and total megapixels into the description field.

First let’s see how to create the action. You need to create an ActionApplier object that will contain the logic:

#/src/Acme/Bundle/CustomBundle/ActionApplier/PatternActionApplier.php
<?php

namespace Acme\Bundle\CustomBundle\ActionApplier;

use Akeneo\Pim\Automation\RuleEngine\Component\Exception\NonApplicableActionException;
use Akeneo\Tool\Bundle\RuleEngineBundle\Model\ActionInterface;
use Acme\Bundle\CustomBundle\Model\ProductPatternAction;
use Akeneo\Tool\Component\RuleEngine\ActionApplier\ActionApplierInterface;
use Akeneo\Tool\Component\StorageUtils\Updater\PropertySetterInterface;

class PatternActionApplier implements ActionApplierInterface
{
    protected PropertySetterInterface $propertySetter;

    public function __construct(PropertySetterInterface $propertySetter)
    {
        $this->propertySetter = $propertySetter;
    }

    /**
     * {@inheritdoc}
     */
    public function applyAction(ActionInterface $action, array $products = []): array
    {
        $attributes = $action->getAttributes();
        $pattern    = $action->getPattern();

        foreach ($products as $index => $product) {
            $result = $pattern;

            foreach ($attributes as $attributeCode) {
                $value = $product->getValue($attributeCode);

                $content = null === $value ? '' : (string) $value;
                $result = str_replace('%%' . $attributeCode . '%%', $content, $result);
            }

            try {
                $this->propertySetter->setData(
                    $product,
                    $action->getField(),
                    $result,
                    $action->getOptions()
                );
            } catch (NonApplicableActionException $e) {
                unset($products[$index]);
            }
        }

        return $products;
    }

    /**
     * {@inheritdoc}
     */
    public function supports(ActionInterface $action): bool
    {
        return $action instanceof ProductPatternAction;
    }
}

Then we need to create the object that will handle the data.

Tip

Implementing the FieldImpactActionInterface will allow the attribute to be flagged as smart in the UI.

#/src/Acme/Bundle/CustomBundle/Model/ProductPatternAction.php
<?php

namespace Acme\Bundle\CustomBundle\Model;

use Akeneo\Tool\Bundle\RuleEngineBundle\Model\ActionInterface;
use Akeneo\Pim\Automation\RuleEngine\Component\Model\FieldImpactActionInterface;

class ProductPatternAction implements ActionInterface, FieldImpactActionInterface
{
    const ACTION_TYPE = 'pattern';

    protected string $field;
    protected array $attributes = [];
    protected string $pattern;
    protected array $options = [];

    /**
     * {@inheritDoc}
     */
    public function getType(): string
    {
        return self::ACTION_TYPE;
    }

    /**
     * {@inheritdoc}
     */
    public function getField()
    {
        return $this->field;
    }

    /**
     * {@inheritdoc}
     */
    public function setField($field)
    {
        $this->field = $field;
    }

    /**
     * {@inheritdoc}
     */
    public function getOptions(): array
    {
        return $this->options;
    }

    /**
     * {@inheritdoc}
     */
    public function setOptions(array $options = [])
    {
        $this->options = $options;
    }

    public function getAttributes(): array
    {
        return $this->attributes;
    }

    public function getPattern(): string
    {
        return $this->pattern;
    }

    public function setAttributes(array $attributes = []): void
    {
        $this->attributes = $attributes;
    }

    public function setPattern(string $pattern)
    {
        $this->pattern = $pattern;
    }

    /**
     * {@inheritdoc}
     */
    public function getImpactedFields(): array
    {
        return [$this->getField()];
    }
}

We also need to create a denormalizer that will return our previous object that handles the data. It will convert the array into an object (needed for the import).

#/src/Acme/Bundle/CustomBundle/Denormalizer/ProductRule/PatternActionDenormalizer.php
<?php

namespace Acme\Bundle\CustomBundle\Denormalizer\ProductRule;

use Acme\Bundle\CustomBundle\Model\ProductPatternAction;
use Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer;

class PatternActionDenormalizer extends GetSetMethodNormalizer
{
    /**
     * {@inheritdoc}
     */
    public function denormalize($data, $class, $format = null, array $context = [])
    {
        return parent::denormalize($data, ProductPatternAction::class);
    }

    /**
     * {@inheritdoc}
     */
    public function supportsDenormalization($data, $type, $format = null): bool
    {
        return isset($data['type']) && ProductPatternAction::ACTION_TYPE === $data['type'];
    }
}

For our example we need to create an ExistingAttributeValidator that will check if the attributes provided in the rule file exist. It will raise a violation and skip this item if not.

#/src/Acme/Bundle/CustomBundle/Validator/Constraints/ExistingAttributesValidator.php
<?php

namespace Acme\Bundle\CustomBundle\Validator\Constraints;

use Akeneo\Pim\Structure\Component\Repository\AttributeRepositoryInterface;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;

class ExistingAttributesValidator extends ConstraintValidator
{
    protected AttributeRepositoryInterface $attributeRepository;

    public function __construct(AttributeRepositoryInterface $attributeRepository)
    {
        $this->attributeRepository = $attributeRepository;
    }

    /**
     * {@inheritdoc}
     */
    public function validate($attributes, Constraint $constraint): void
    {
        foreach ($attributes as $attribute) {
            if (null === $this->attributeRepository->findOneByIdentifier($attribute)) {
                $this->context->buildViolation($constraint->message, ['%attribute%' => $attribute])->addViolation();
            }
        }
    }
}

Here is the constraint message and its associated validation file:

#/src/Acme/Bundle/CustomBundle/Validator/Constraints/ExistingAttributes.php
<?php

namespace Acme\Bundle\CustomBundle\Validator\Constraints;

use Symfony\Component\Validator\Constraint;

class ExistingAttributes extends Constraint
{
    public string $message = 'There are no attributes with such code: "%attribute%"';

    /**
     * {@inheritdoc}
     */
    public function validatedBy(): string
    {
        return 'pimee_constraint_attributes_validator';
    }
}
#/src/Acme/Bundle/CustomBundle/Resources/config/validation/ProductPatternAction.yml
Acme\Bundle\CustomBundle\Model\ProductPatternAction:
    constraints:
        - Akeneo\Pim\Automation\RuleEngine\Bundle\Validator\Constraint\PropertyAction: ~
    properties:
        field:
           - Type:
                type: string
           - NotBlank: ~
           - Length:
               max: 255
           - Akeneo\Pim\Automation\RuleEngine\Bundle\Validator\Constraint\ExistingSetField: ~
        attributes:
            - Type:
                type: array
            - NotBlank:
                message: The "attributes" key is missing or empty.
            - Acme\Bundle\CustomBundle\Validator\Constraints\ExistingAttributes: ~
        pattern:
           - Type:
                type: string
           - NotBlank: ~
           - Length:
               max: 255

Don’t forget to add these classes in your service definition and to tag them with the proper tag. Also, do not forget to load your services.yml in your dependency injection, either in a bundle extension or in the config directory.

#/src/Acme/Bundle/CustomBundle/Resources/config/services.yml
services:
    acme.action_applier.pattern:
        class: Acme\Bundle\CustomBundle\ActionApplier\PatternActionApplier
        arguments:
            - '@pim_catalog.updater.property_setter'
        tags:
            - { name: akeneo_rule_engine.action_applier, priority: 100 }

    acme.denormalizer.product_rule.pattern_action:
        class: Acme\Bundle\CustomBundle\Denormalizer\ProductRule\PatternActionDenormalizer
        tags:
            - { name: 'pimee_catalog_rule.denormalizer.product_rule' }

    acme.validator.existing_attributes:
        class: Acme\Bundle\CustomBundle\Validator\Constraints\ExistingAttributesValidator
        arguments:
            - '@pim_catalog.repository.attribute'
        tags:
            - { name: validator.constraint_validator, alias: pimee_constraint_attributes_validator }

Here is an example on how you could write a rule.

rules:
    test_pattern:
        priority: 0
        enabled: true
        conditions:
            -
                field: family
                operator: IN
                value:
                    - camcorders
        actions:
            -
                type: pattern
                field: description
                attributes:
                    - name
                    - price
                    - total_megapixels
                pattern: '%%name%% -- %%price%% -- %%total_megapixels%%'
                options:
                    scope: ecommerce
                    locale: en_US

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