Guide for Shopify Akeneo Meta field Definitions Addon

Shopify Akeneo Meta field Definitions Addon is an addon of Shopify Akeneo Connector. This add-on allows you to create and export meta field definitions from Akeneo to the Shopify platform. 

Meta fields definition: They act as a template that defines which parts of your store a certain meta field applies to as well as the possible values for that meta field.

Also, for importing and exporting product data between Akeneo and Shopify you can make use of the Akeneo Shopify App.

Check the workflow of the plugin –

Please Note:

• This module is an add-on to Shopify Akeneo Connector, so it must be installed first.
• 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.

Basic Requirements

• This module works with Akeneo, Akeneo 5.0.x and 7.0.x. Download Akeneo from here
• Node and Yarn packages need to be installed.
• Also works with Akeneo Cloud Flexibility Mode which is a PAAS Edition of Akeneo

• Export Meta field Definitions from Akeneo to Shopify.
• Create Meta field Definitions.
• Export Meta field Products & product variants to Shopify.
• This module is compatible with Akeneo version 7. x
• The source code is 100% open for customization.

Read This Blog

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

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

3: Use composer to install the extension.

         composer require webkul/metafielddefinitionsbundle

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

• 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/MetafieldDefinitionsBundle/install/config.sh COMPOSER=false NO_DOCKER=true

•  Run the command below over the PIM directory’s DOCKER instance.

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

For installing this module in Akeneo, please follow the further steps:

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

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

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

in the return array.

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

5 – After that run this command after ssh to your akeneo server by the terminal.

rm -rf var/cache && php bin/console ca:warmup && php bin/console MetafieldDefinitions:setup:install

6 –  If you are using php-fpm then you need to restart the php-fpm services and apache web server.

sudo service php-fpm7.4 restart

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;

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

• It means that the 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.

• From the PIM directory, run the command below over the NO-DOCKER Instance.

./src/Webkul/MetafieldDefinitionsBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true

• Run the command below over the PIM directory’s DOCKER instance.

./src/Webkul/MetafieldDefinitionsBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false

Note: The only functionality that this add-on supports is the export of product meta fields definition. From Akeneo to Shopify, you can only export meta fields definition.

After successfully installing the Shopify Akeneo connector and Shopify Akeneo Meta field Definitions Addon module in Akeneo, the Meta field Definition button will be visible on the top.

For more details about the setup credentials in Akeneo, You can refer Shopify Akeneo connector user guide. Click here to know more. Shopify Akeneo Connector.

These akeneo attributes support the following metafield definition types:-
1. Text (Single line text, Color, Rating and URL)
2. Simple select (Single line text)
3. Yes/No (True or False)
4. Measurement (Volume, Weight and Dimension)
5. Text Area (Multi-line text and JSON)
6. Multi select (Multi-line text)
7. Date (Date)
8. Number (Interger and Decimal)

To view the list of meta field definitions in Akeneo, click on Metafeild definition. You may then add a new definition based on your requirements.

After that to add a new definition click on add definition button:

Once you will click on add definition it will redirect you to a new page. Then you have to add details as shown in the image.

• Meta field definition type: In this, you have to select whether you want to export the meta field defined as a product or variant in Shopify.
• Akeneo attribute: In this, you have to select the attribute to whom you want to export to Shopify as meta fields.
• Name: Enter a name for your definition in this field.
• Content-Type: In this, you have to select the content type such as text, rating, file, URL, and many more.
• Namespace and key: Your meta field unique identifier is created by the namespace and key worked together in this. The only characters allowed are letters, numerals, underscores (_), and hyphens (-); they are separated by a comma.
• Description: Information about the values to be entered in the meta field should be provided.

Click the Save button once you’ve finished adding the details. Once your definition has appeared in the list, turn on the button shown in the image below to mark it as a pin.

Pin or unpin Meta field definitions to determine the order in which your meta fields are displayed.

Now to export your meta field definition data you need to create a job profile and then execute it. First, go to Exports>Create Export Profile.

 After that enter a unique code, and label, and select a job profile.

Meta feilds Definition:

First, you need to export the definition to Shopify. Once you will add the details you need to click on the Save button.

Execution Process

Wait for the execution process to complete then check the errors. After the completion of the export job, the meta fields definition will appear on Shopify.

Definition in Shopify

When all of the meta field definitions have been exported, go to Settings>>Metafileds>>Product to view the list.

After clicking, the product of all the exported meta fields definitions will be visible here.

Variants in Shopify:

Go to Settings>>Metafileds>>Variants to view the list.

Meta fields Product:

Now, you need to export meta fields product create an export profile and filter the data then click on the Save button:

Note:  You must export the product and product model in Shopify first before exporting the meta field definitions product in Shopify.

Execution Process

Wait for the execution process to complete then check the errors. After the completion of the export job, the meta fields products will appear on Shopify.

You can export meta fields variants in the same way from Akeneo to Shopify.

Meta fields Product in Shopify:

Once all the value has been exported to Shopify, you may check the meta field product value in your products.

Once all the variant value has been exported to Shopify, you may check the meta field variant value in your product model.

So, that was much about the  User Guide of Shopify Akeneo Meta field Definitions Addon 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.