Read More
Read More
Menu Close

    Akeneo UI Reference Entity

    Introduction

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

    Basic Requirement

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

    • 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 and 5.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 5 types of fields text, number, boolean, Json, and date.
    • Export/Import Reference entity values using CSV job added
    • All the 5 Fileds 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 5.0.x
    • Create multiple fields in one entity.
    • You can add 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 for Version 4.0.x to 5.0.x

    1- Composer Installation

    Read This Blog

    2- Manual Installation

    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:
    refernce-entity

    in return array.

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

    Docker Installation Command :

    For Akeneo 5

    For Akeneo 4

    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 function registerProjectBundles(),
    Appkernel
    • After that, goto app/config/routing.yml then add these lines at top of the file
    routing.yml
    • Then goto app/config/config.yml then add these lines under the import section.

    For Akeneo Version 2.x

    For Akeneo Version 3.x

    Config
    • Run this command after ssh to your Akeneo server by terminal

    Create a Reference Entity

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

    Entity Mapping

    After clicking on Create Entity fill the Entity Name.

    Create entity

    Then, click to Save Button. The entity will be created you can edit and delete the entity.

    Edit

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

    • Name – In this, you have to fill the field name.
    • Type – In this you can add 5 types of the field like Boolean, Text, Date, Number, and Json.
    • Length – In this, you have to add the length.
    • Required – In this, you have to select whether the field is required or not.
    Add field

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

    After creating the entity click to Save Button then you can filter the field value.

    Search code

    After that, click to Add Field Values.

    Create field

    Then after filling the details click to the Save Button.

    Entity Feild Mapping

    After that, you can select the entity in both Reference data multi-select and Reference data simple select.

    Attribute

    Add Entity in Reference data multi-select:

    For this, you have to navigate Setting>>Attribute>>Create Attribute>>Reference data multi-select.

    After that, fill the code, the label and selects the reference data type.

    Multiselect

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

    Code

    Then click to the Save button.

    Add Entity in Reference data Simple-select:

    For this, you have to navigate Setting>>Attribute>>Create Attribute>>Reference data simple – select.

    Then fill the code, label, and then select the reference data type.

    Properties

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

    Gerneral properties

    Then, click to the Save button.

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

    Note – To create the product in Akeneo click here – https://webkul.com/blog/create-product-and-product-model-in-akeneo/

    Create product

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

    SKU and family

    Then, fill the product Detail and Entity.

    Add entity in Product

    Export Profile

    Now to export your product data you need to create a job profile then execute it.

    First, go to Exports>Create Export Profile after that enter a unique code, the label then select a job profile.

    Export-profiles-management-4

    Click to Save button.

    Global Settings:

    In this, you have to fill in the details given below in the image like reference entity, file path, decimal separator, etc.

    Export-profile-Refenrece_entity_export-Edit-1

    After filling all the details click to Save button.

    Product Export

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

    Export-profile-Refenrece_entity_export-Show

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

    Export-executions-Details-3

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

    Export-executions-Details-4

    Import Profile

    Now to import your product data you need to create a job profile then execute it.

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

    Import-profiles-management-3

    Click to Save button.

    Global Settings:

    In this, you have to fill in the details given below in the image like reference entity, file path, decimal separator, etc.

    Import-profile-Reference_entity_import-Edit-1

    After filling all the details click to Save button.

    Product Import

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

    Import-profile-Reference_entity_import-Show

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

    Import-executions-Details-2

    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 - 3.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 and 5.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 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, 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
    . . .
    Discuss on Helpdesk

    Leave a Comment

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


    Be the first to comment.

    Back to Top

    Table of Content