Reading list Switch to dark mode

    Akeneo UI Reference Entity

    Updated 10 July 2023

    Introduction

    The Akeneo UI Reference entity bundle provides the UI interface to create the entity and manage the entities’ value with the UI. Further, It helps to manage reference data and related views inside the Akeneo PIM.

    What is a reference Entity?

    Reference entity allow you to create and enhance common information that can be shared as well as connected to products.

    Check a brief overview of the plugin –

    rtOtGYTclbU

    Basic Requirement

    Before you begin, please see the minimum requirements for using this module:

    Searching for an experienced
    Akeneo Company ?
    Find out More
    • 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
    • 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

    • Create a Reference Entity of Type Simple and Multiple in Akeneo.
    •  Delete Reference Entity from UI.
    • You can add 8 types of fields text, number, boolean, Json, image, date, simple select, and multi-select.
    • Export/Import Reference entity values using CSV job added
    • All 8 Fields are validated within the required criteria.
    •  Create fields in a particular Reference Entity from UI.
    •  Remove fields from a particular Reference Entity from UI.
    • This module is compatible with the latest Akeneo version 7.0.x
    • Create multiple fields in one entity.
    • Additionally, you can create multiple entities.
    •  Add values of Reference Entity fields from UI.
    •  Delete values of Reference Entity fields from UI.
    •  Update values of Reference Entity fields from UI. 

    Installation

    Two different types of module installation processes are available for the module.

    1. Composer Installation
    2. Manual Installation

    Installation using Composer Installation

    Read This Blog

    Before beginning the composer installation

    1: Get the ACCESS KEYS [Create a support ticket]

    2: In Akeneo 6. x and 7.x composer.json, add our repository and the installation script.

    {
      "scripts": {
            "post-update-cmd": [
               "vendor/webkul/referanceentityuibundle/src/Webkul/ReferanceEntityUiBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
            ],
            "post-install-cmd": [
               "vendor/webkul/referanceentityuibundle/src/Webkul/ReferanceEntityUiBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
            ],
            "post-create-project-cmd": [
              "vendor/webkul/referanceentityuibundle/src/Webkul/ReferanceEntityUiBundle/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/referanceentityuibundle/composer_install.sh"
            ],
            "post-install-cmd": [
               
    "vendor/webkul/referanceentityuibundle/composer_install.sh"
            ],
            "post-create-project-cmd": [
             
    "vendor/webkul/referanceentityuibundle/composer_install.sh"
           ]
       },
      "repositories": [{
        "type": "composer",
        "url": "https://akeneorepo.webkul.com/"
      }]
    }

    3: Use composer to install the extension

             composer require webkul/referanceentityuibundle

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

    Manual Installation for Version 6.x and 7.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/ReferanceEntityUiBundle/install/config.sh COMPOSER=false NO_DOCKER=true
    • After that run the command below over the PIM directory’s DOCKER instance.
    ./src/Webkul/ReferanceEntityUiBundle/install/config.sh COMPOSER=false NO_DOCKER=false

    Manual Installation for Version 4.0.x to 5.x

    Please follow these steps for installing Akeneo UI Reference Entity in your Akeneo PIM platform.

    • Unzip the respective extension zip then merge the “src” folder into the Akeneo project root directory.
    src-reference-entity-
    • After that, goto config/Bundles.php then add the line:
      Webkul\ReferanceEntityUiBundle\ReferanceEntityUiBundle::class => ['all' => true],
    refernce-entity

    in return array.

    • Copy the “config” folder into akeneo project root directory for routing.
    Conf-refernce-entity
    • Run this command after ssh to your akeneo server by the terminal
    php bin/console ca:cl --env=prod && php bin/console uireference:setup:install --env=prod

    Docker Installation Command :

    For Akeneo 5

    alias docker_php='docker-compose run -u www-data --rm php php';
    alias docker_yarn='docker-compose run -u node --rm node yarn';
    docker_php bin/console cache:clear --env=prod;
    docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
    docker_php bin/console d:s:u --force;
    docker_yarn run webpack;
    docker_yarn run update-extensions;
    docker_yarn run less;

    For Akeneo 4

    alias docker_php='docker-compose run -u www-data --rm php php';
    alias docker_yarn='docker-compose run -u node --rm node yarn';
    docker_php bin/console cache:clear --env=prod;
    docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
    docker_php bin/console d:s:u --force;
    docker_yarn run webpack;
    docker_yarn run less;

    Manual Installation For Version 2.x to 3.x

    Please follow these steps for installing Akeneo UI Reference Entity in your Akeneo PIM platform.

    • Unzip the respective extension zip then merge the “src” folder into the Akeneo project root directory.
    src-reference-entity
    • Goto app/AppKernel.php then add the following line in the function registerProjectBundles(),
     new Webkul\ReferanceEntityUiBundle\ReferanceEntityUiBundle(),
    Appkernel
    • After that, go to app/config/routing.yml then add these lines at top of the file
    wk_referance_entity_ui:
        resource: "@ReferanceEntityUiBundle/Resources/config/routing.yml"
        prefix: /
    routing.yml
    • Then goto app/config/config.yml then add these lines under the import section.

    For Akeneo Version 2.x

        - { resource: "@ReferanceEntityUiBundle/Resources/config/2.x/config.yml" }

    For Akeneo Version 3.x

        - { resource: "@ReferanceEntityUiBundle/Resources/config/3.x/config.yml" }
    Config
    • Run this command after ssh to your Akeneo server by terminal
    php bin/console ca:cl --env=prod && php bin/console uireference:setup:install --env=prod

    Uninstall Module: For Akeneo 6 and 7

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

    How to Create an Attribute for a Reference Entity?

    First, you have to create the attribute and select Reference data multi-select and Reference data simple select.

    To create a new attribute you have to navigate to Settings>> Product Settings >> Attributes>>Create Attribute.

    Select Attribute Type

    Secondly, after clicking on reference data multi-select we will create an attribute for reference data multi-select.

    Create Attribute for Multi Select

    After that, fill in the code, attribute group, unique value, value per label,

    Enter for Multi Select Attribute(1)

    value per locale, type-specific parameter, and then the reference data type.

    Enter for Multi Select Attribute(2)

    If the entity is selected for Multi-select then multi-word will be added to that entity.

    Then click on the Save button.

    Multi word add in reference entity

    Create Attribute for Simple-select:

    Next, we will create an attribute for reference data Simple Select after entering the value in the label, and code and click on Confirm button. For this, you have to navigate Setting>> Attribute Create Attribute>>Reference data simple – select.

    Create Attribute (2)

    After that, fill in the code, attribute group, unique value, and value per label and locale

    Add value for reference entity

    Attribute Guidelines, Type-specific parameters, and then the reference data type. Similarly after selecting simple select then simple-word will be added to that entity.

    Add value for reference entity(2)

    Now we will navigate to Families>>Attributes>>Add Attributes to map these created attributes with attribute group.

    Add Attribute

    Then, click on the Save button.

    Next, we will map the created attribute with the attribute group inside the families. For this, we have to navigate to Settings>>Family>>Attribute>>Add Attributes

    Add Attribute to Attribute group(1)

    Similarly, we will assign the width attribute to the attribute group.

    Add Attributes to Attribute group

    Next, we will tap on the Product group and the added attributes are visible here.

    Now to create a new entity you have to navigate to UI Reference entity>>Entity Mapping>>Create Entity.

    Create Entity

    After clicking on Create Entity fill in the Entity Name.

    Entity name

    Then, click on to Save Button. As a result, a new entity will be created and you can edit and delete the entity.

    Edit Entity

    Now after creating the reference entity. Click on the entity and create new fields fill in details like fields:

    • Field Name – In this, you have to fill in the field name.
    • Field Type – In this you can add 8 types of fields Text, Date, Number, JSON, Boolean, Image, Simple Select, and Multi Select.
    • Field Length – From this, you can limit the size of input values.
    • Field Options- In this, you can enter values for simple and multi-select.
    • Field Required – In this, you have to select whether the field is required or not.
    • Field Used in Label – In this, you have to select whether the field is used for identification purposes or not. We can use only one field for label purposes.

    You can add multiple fields with different validation in one single entity.

    Similarly, you can add a field for image, Boolean, Simple Select, and Multi Select.

    Add Validation Entity(2)

    After creating the entity click on to Save Button then you can add values to those fields.

    Add Field Values

    Next, you can assign values to all those created fields after clicking on Add Field Values.

    Add Field Values(1)

    Also, we will add value in the other remaining fields.

    Add Field Value (2)

    Then after filling in the details in created fields click on the Save Button and enter the field data will visible.

    Entity  Field Values

    From the Product In Reference entity option, you are able to check the products associated with the particular reference entity.

    Product in Reference Entity

    Now you can add these already created attributes to the product. After that, to create a product you have to navigate Product>>Create Product.

    Create product

    After that, to create a Simple product click on the product. Then fill in the code and family.

    Select Family

    Then, fill in the product detail and Entity.

    Reference Entity In Product

    Export Profile

    You can use this function if you want to extract information from the PIM for your own use or if you want to give your product information to third parties like e-commerce platforms, mobile applications, suppliers, etc.

    Now to export your product data you need to create a job profile. First, go to Exports>Create Export Profile

    Create-Export-Profile

     After that enter a unique code, and the label then selects a job profile.

    Export Profile

    Click on to Save button.

    Global Settings:

    You can decide which reference entity you want to export and filter them using various options. To export a specific reference entity you can enter its file path.

    In this, you have to fill in the details in given below image like reference entity, file path, decimal separator, etc. After filling in all the details click to Save button.

    Export Profile Global Settings

    Reference Entity Export

    After creating and filtering data in the Export profile, you can see the Export Now button in Akeneo.

    Export Entity

    Once you click the  Export option, as a result, the execution process will run. After that, you can check the export progress in the Process tracker section.

    Track Export Reference Entity

    Once the completion of the export job is done, the products will appear in the file. You will be able to download the file by clicking on “Download Generated File“.

    Import Profile

    Data imports are quite practical, especially if you wish to update your catalog from outside sources like vendors or ERP. Now to import your product data you need to create a job profile and then execute it.

    First, go to Imports>Create Import Profile after that enter a unique code, and the label then selects a job profile.

    import profile

    Click on to Save button.

    Global Settings:

    The second step is you have to fill in the details given below in the image like reference entity, file path, decimal separator, etc.

    import profile setings

    Then after filling in all the details click on to Save button.

    Product Import

    import product

    Next to creating and filtering data in the import profile, you can see the Import Now button in Akeneo.

    Now after clicking on the Import Now button, Wait for the execution process to complete and check the errors. 

    Track import reference entity

    Support

    Thank you for reading this documentation. In case you have an issue with this module, please create a support ticket at – https://webkul.uvdesk.com/en/customer/create-ticket. For further queries or customization discussions, please send an email to [email protected]

    Please explore our Akeneo Development Services and Quality Akeneo Extensions.

    Current Product Version - Akeneo 2 to 5 || 3.0.0, Akeneo 6 || 4.0.0 and Akeneo || 5.0.0

    Supported Framework Version - 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

    Blog Version - 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
    • Version 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
    • Version 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 and 6.0.x
    • Version 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 and 5.0.x
    • Version Akeneo - 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x and 4.0.x.
    • Version 2.x, 3.x
    . . .

    Leave a Comment

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


    Be the first to comment.

    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