Akeneo UI Reference Entity

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,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.

• 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. 

{
  "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/"
  }]
}

{
  "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/"
  }]
}

         composer require webkul/referanceentityuibundle

./src/Webkul/ReferanceEntityUiBundle/install/config.sh COMPOSER=false NO_DOCKER=true

./src/Webkul/ReferanceEntityUiBundle/install/config.sh COMPOSER=false NO_DOCKER=false

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

php bin/console ca:cl --env=prod && php bin/console uireference:setup:install --env=prod

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;

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;

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.

• Goto app/AppKernel.php then add the following line in the function registerProjectBundles(),

 new Webkul\ReferanceEntityUiBundle\ReferanceEntityUiBundle(),

• 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: /

• 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" }

• 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

• 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

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.

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

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

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

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

Then click on the Save button.

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.

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

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.

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

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

Similarly, we will assign the width attribute to the 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.

After clicking on Create Entity fill in the 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.

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.

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

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

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

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

From the Product In Reference entity option, you are able to check the products associated with the particular 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.

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

Then, fill in the product detail and Entity.

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

 After that enter a unique code, and the label then selects a job 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.

Reference Entity Export

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

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.

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“.

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.

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.

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

Product Import

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. 

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 support@webkul.com

Please explore our Akeneo Development Services and Quality Akeneo Extensions.