Reading list Switch to dark mode

    Akeneo Custom Action Rule Conditions

    Updated 3 January 2024

    Introduction

    Akeneo Custom Actions Rules Conditions module provides a robust feature in Akeneo for maintaining the product information process faster.

    Admin can create the rules in Akeneo with the help of UI and can change the bulk product information as required.

    How does this extension help?

    The extension allows you to automate the product maintenance process. Create customized rules and conditions to perform actions for updating the product attribute values.

    Moreover, you can quickly enrich and edit the product information value in Akeneo. It will work with both the Akeneo Community and Enterprise versions.

    Basic Requirements

    • This module works with Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x., 6.0.x. and 7.0.x. Download Akeneo from here
    • Node and Yarn packages need to be installed.
    • This module is compatible with the Akeneo community and Enterprise(Flexibility) edition.
    • If you want to use this extension on Akeneo EE Serenity mode, please contact us.
    • For the Akeneo installation, your Akeneo server should meet these system requirements.

    Features

    • Add several attributes to create multiple conditions
    • Select a channel in condition
    • Select a local in condition
    • Add values in attribute local and channel-wise.
    • Perform action to concatenate the value
    • Perform action to remove whitespace
    • Add different attributes to perform multiple actions
    • Perform action to replace with the other attribute value
    • One-click button to execute rule on all products
    • View, edit or delete all the created rules, conditions, and actions.
    • This module is compatible with the latest Akeneo version 7.0.x

    Video Tutorial:

    Check out the following video tutorials below:

    Searching for an experienced
    Akeneo Company ?
    Find out More

    The workflow of Akeneo Custom Actions Rules Conditions

    J0mS5_4xGHY 

     

    Composer Installation

    Before beginning the composer installation

    1: Get the ACCESS KEYS [Create a support ticket]
    2: In Akeneo composer.json, add our repository as well as the installation script.

    For Akeneo 6.0.x and 7.0.x 

    {
      "scripts": {
            "post-update-cmd": [
               "vendor/webkul/akeneorulesconnector/src/Webkul/AkeneoRulesBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
            ],
            "post-install-cmd": [
               "vendor/webkul/akeneorulesconnector/src/Webkul/AkeneoRulesBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
            ],
            "post-create-project-cmd": [
              "vendor/webkul/akeneorulesconnector/src/Webkul/AkeneoRulesBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
           ]
       },
      "repositories": [{
        "type": "composer",
        "url": "https://akeneorepo.webkul.com/"
      }]
    }
    

    For Akeneo <=5.x 

    {
      "scripts": {
            "post-update-cmd": [
               
    "vendor/webkul/akeneorulesconnector/composer_install.sh"
    ], "post-install-cmd": [
    "vendor/webkul/akeneorulesconnector/composer_install.sh"
    ], "post-create-project-cmd": [
    "vendor/webkul/akeneorulesconnector/composer_install.sh"
    ] }, "repositories": [{ "type": "composer", "url": "https://akeneorepo.webkul.com/" }] }

    3: Use composer to install the extension.

             composer require webkul/akeneorulesconnector
    

    4: Complete the authentication form.
    5: Send a Message of Success
    6: Delete your browser’s cache.

    Installing Module for Version 6.0.x and 7.0.x

    •  After unzipping the appropriate extension zip, merge the “src” folder into the akeneo project.
    • From the PIM directory, run the following command over the NO-DOCKER Instance.
    ./src/Webkul/AkeneoRulesBundle/install/config.sh COMPOSER=false NO_DOCKER=true
    
    •  Run the command below over the PIM directory’s DOCKER instance.
    ./src/Webkul/AkeneoRulesBundle/install/config.sh COMPOSER=false NO_DOCKER=false
    

    Installing the Module for Version 4.0.x to 5.0.x

    Please follow these steps to install the Akeneo Custom Actions Rules Conditions module in your Akeneo PIM platform.

    1 – Unzip the respective extension zip then merge the “src” folder into the Akeneo project root directory.

    src_4_x-all-mod

     2 – Goto config/Bundles.php then add the line:

    Webkul\AkeneoRulesBundle\AkeneoRulesBundle::class => ['all' => true],

    in the return array.

    3 – Copy the “config” folder into the Akeneo project root directory for routing.

    config_all-mods

    4 – Run this command after ssh to your akeneo server by the terminal.

    php bin/console ca:cl --env=prod;php bin/console akeneo_rules:setup:install --env=prod;

    Installing the Module for Version 2.x to 3.x

    Please follow these steps to install the Akeneo Custom Actions Rules Conditions module in your Akeneo PIM platform.

    1 – Unzip the respective extension zip then merge the “src” folder into the Akeneo project root directory.

    upload the src folder

    2 – Goto app/AppKernel.php then add the line

    <span id="LC1" class="line" lang="plaintext">        new Webkul\AkeneoRulesBundle\AkeneoRulesBundle(),</span>
    <span id="LC1" class="line" lang="plaintext">in function registerProjectBundles()</span>


    Appkernel file in Akeneo

    3 – Goto app/config/routing.yml then add the lines mentioned below at top of the file.

    AkeneoRules:
        resource: "@AkeneoRulesBundle/Resources/config/routing.yml"
        prefix:   /
    

    config.yml in condition

    4 -You have to navigate to Akeneo Installation Directory(Ex. cd /opt/bitnami/apps/akeneo/htdocs ). Run this command after ssh to your akeneo server by the terminal.

    php bin/console ca:cl --env=prod;php bin/console akeneo_rules:setup:install --env=prod;

    Common Issues After Installation

    It might happen that even after proper installation, upon opening your Akeneo admin dashboard, you see a loading screen. In that case, do check for the following solution:

    • Webpack Installation: If you get the below error Webpack error It means that web pack is not installed in your system. Run the following command
      npm install --save-prod webpack
      npm install
      
    • Module routing.yml is not configured properly. Re-check the routing.yml file as mentioned in the 3rd step of Module Installation
    • Clear your browser cache.

    Uninstall Module: For Akeneo 6 and 7

    • From the PIM directory, run the command below over the NO-DOCKER Instance.
    ./src/Webkul/AkeneoRulesBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true
    
    • Run the command below over the PIM directory’s DOCKER instance.
    ./src/Webkul/AkeneoRulesBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false

    Workflow

    After installing the module in Akeneo, navigate to the Akeneo Dashboard. Here, you will see the Webkul Akeneo Item Rules icon on the left side of the screen.

    Dashboard-4

    Under the Akeneo Item Rules tab, the user can easily create new rules. Apart from that, the user can also view the already-created rules. Besides that, the user can also edit/delete the rules.

    Create a New Rule

    After clicking on the tab Akeneo Item Rules there will be two options documentation, rule, and support.

    custom-action-rule

    Then to create new rules click on Rules>>Create.

    Akeneo-Rules-Mapping-1-1

    After that, by clicking on the create rules button, the user will enter the name for the rule.

    Create-Akeneo-Item-Rules-4

    Scope Filter

    Then in this, you have to select the channel and locale in which the user wants to execute the rule.

    Edit-Akeneo-Item-Rules-6

     

    Add Conditions

    After entering the name, add a condition for the rule. Now select the family, time condition, and category, and after that user will select an attribute to create the condition for the respective rule.

    Edit-Akeneo-Item-Rules-1-1

    Now after selecting the attribute, the user will select the rule condition to apply to the attribute.

    Edit-Akeneo-Item-Rules-3-1

    After that, the user will add value to the condition that needs to be applied to the product.

    Edit-Akeneo-Item-Rules-4-1

    Add Action

    After that, the user will then add the attribute to which the rule action will get applied.

    Edit-Akeneo-Item-Rules-5-1

    Then after selecting the category and the attribute, the user has to select the action to be applied to the created rule.

    Edit-Akeneo-Item-Rules-6-1

    Note: Remove whitespace helps in the removal of white space from an attribute value.

    Scheduler 

    After adding the condition and action admin can also schedule the cron job.

    Edit-Akeneo-Item-Rules-7

    Execute Rule

    Lastly, the user will save the rule and can view the rule created successfully under rules.

    Akeneo-Rules-Mapping-2-1

    After that, the user will run the rule and needs to confirm before executing the rule.

    Akeneo-Rules-Mapping-3-1

    After executing the rule, the user can see a success message for the same.

    Akeneo-Rules-Mapping-4-1

    Product List – Rule Applied

    Now, the user can check the rule applied to the product. The product name is hat before the rule applied to it.

    Products-9

    The product name changes once the rule is executed, and cap is added to the product names that include hat.

    Products-10

    Therefore, the user can generate the rules as per the locale as well. The user can select a particular locale to apply the rule.

    The users can also apply the rule to a specific family.

    Edit-Akeneo-Item-Rules-8

    The user has created a rule for the locale “English”. Now, the user adds the actions to it.

    Edit-Akeneo-Item-Rules-10

    After that, pick a German local. The actions value are now added by the user.

    Edit-Akeneo-Item-Rules-11

    After creating the rule, the user needs to run the rule.

    Akeneo-Rules-Mapping-7

    After running the rule above, the user is now able to view the created rule. The user can also see a success message for the same.

    Akeneo-Rules-Mapping-8

    After that, the user checks the rule applied to the product and the product description gets added to the locale “German”.

    Product-Hat-cap-_-Edit-1

    The locale “English” receives a product description.

    Product-Hat-cap-_-Edit

    Support

    So, that was much about the User Guide of Akeneo Custom Action Rule Condition for any queries or doubts reach out to us at [email protected]. You can also raise a ticket at our HelpDesk System.

    Please explore our Akeneo Development Services and Quality Akeneo Extensions.

    Current Product Version - Akeneo 2 to 5 || 2.0.0, Akeneo 6 || 3.0.0 and Akeneo 7 || 4.0.1

    Supported Framework Version - 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x, 6.0.x and 7.0.x

    Blog Version - 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x, 6.0.x and 7.0.x
    • Version 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x
    • Version 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x, 6.0.x and 7.0.x
    • Version 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x and 6.0.x
    • Version 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x and 5.0.x
    • Version 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x and 3.2.x.
    . . .

    Leave a Comment

    Your email address will not be published. Required fields are marked*


    4 comments

  • Nima
    • Adarsh Shukla (Moderator)
      • Shaheed
        • Adarsh Shukla (Moderator)
  • Back to Top

    Message Sent!

    If you have more details or questions, you can reply to the received confirmation email.

    Back to Home

    Table of Content