Back to Top

Guide for Akeneo Template Connector

Updated 13 August 2024

Akeneo Template Connector allows the store admin to create templates for text, text area, number, and price type product attributes.

In the Akeneo Template Connector, the admin can add product value in the multiple attributes

It can perform mathematical operations like +, -, *, /, and % to be used.

This module enables you to include dynamic product values in text, textarea, price, and number type attributes.

Admin can build slugs, product descriptions, special prices tied to other prices, and so on.

Searching for an experienced
Akeneo Company ?
Find out More

Additionally, If you want to remove the product image background, you can check Akeneo Image Background Remover.

Check the video for this feature –

rKu-4C2lLUY

Feature

  • Allows creating templates for text, text area, number, and price product type attributes.
  • Define templates for product attributes at product level i.e. can be different for each product.
  • Define templates for attributes at a global level i.e. will be the same in all the products that contain that attribute.
  • Multiple attribute types can be used while defining a template for Text and Textarea Attributes such as Date, Price, Boolean, etc.
  • Filters on the product grid for filtering the products and product models that have templates created.
  • Admin can use twig filters with the values by using the “|” operator. Like for date you can write “{{ release_date|format_date }}”.
  • Supports product & product models
  • Works with and without WYSIWYG enabled
  • Supports “value per channel” and “value per locale” attributes
  • Provides auto-completion for your attribute codes

Basic Requirements

  • This module works with 7.0.x., Download Akeneo.
  • Node and Yarn packages need to be installed.
  • If you want to use this extension in Akeneo EE Serenity mode, please contact us.
  • For the Akeneo installation, your Akeneo server should meet these system requirements.

Installation

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

  1. Composer Installation
  2. Manual Installation

Please explore our Akeneo Development Services and Quality Akeneo Extensions.

Installation using Composer

To know how to install Akeneo Connector via composer, 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 and 7.x

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

3: Use composer to install the extension.

composer require webkul/templatebundle

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

Manual Installation for Version 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/TextTemplateBundle/install/config.sh COMPOSER=false NO_DOCKER=true
  • Run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/TextTemplateBundle/install/config.sh COMPOSER=false NO_DOCKER=false

Uninstall Module: For Akeneo 7.x

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

Akeneo Template Connector – Workflow

After successfully installing the Akeneo Template Connector module in your Akeneo, the admin will log in to the Akeneo Dashboard.

akeneo product list

On the Akeneo dashboard, the admin will navigate to product -> Select / Create a product.

After selecting the product type, the admin will navigate to the product attributes.

product attributes page

At the top of the product attributes section, the admin finds the info icon.

Note: Only those product attributes that show the Info icon on the top allow creating templates for text, text area, number, and price product type attributes.

Now, the admin will enter the product details in the product attributes.

The admin can use the “@” operator to display a list of attributes that can be selected with a tab or by clicking on it in the product attributes field.

The Akeneo template connector supports multiple attribute types that can be used while defining a template for Text and Textarea Attributes:

  • Text
  • Date
  • Price
  • Number
  • Boolean (Yes/No)
  • TextArea
  • Identifier
  • Measurement
  • Simple Select
  • Multi Select

Note:

  • The number attribute supports only numbers
  • The price attribute supports numbers and price both.
creating template

After adding the template, it will show in the “{{ name }}” (double Curly bracket) on the product attributes field.

The admin can check the added templates by clicking on the Preview icon at the top of that attribute field.

viewing templates.

The admin can trigger multiple attributes in the product attribute field.

Like –

Admin can write a product description using multiple attributes triggered.

adding templates.

After clicking on the preview icon. It will display the content with your trigger attribute values.

viewing templates.

NOTE: The rich text editor attributes only allow the “@” operator to trigger attributes in the code view.

Product Filter Grid

This module allows the admin to filter the product in which the templates are created.

Now, two new options are available for the admin to filter the product.

product filter

Now, the admin can filter the product having templates.

  • Products with template – allows filtering of simple products and variant products, by using the template.
  • Product Models with template – allows filtering the customized products in the product list that are using templates.

Twig Filter Options

Admin can modify the variable in the product attributes using the Twig Filters.

Using the “|” operator, the admin can modify the variables in the product field.

Twig filters for product values in text and text area fields:

  • capitalize – With Capitalize, the admin can make the first letter of the template capitalize.
  • format_date – With format_date, the admin can change the date format in the product attribute.
  • lower – With lower, you can lowercase the words of the templates.
  • slug – Admin can create the slug with the help of a Twig filter.
  • title – The admin can create a title with this Twig filter.
  • upper – With upper, the admin can Uppercase all the words of the templates.

Like – In the rich text editor, the admin uses the{{name | upper}} to uppercase all the letters in the name keyword.

addming twig Filter

After clicking on the preview icon. It will display the content with your trigger attribute values.

Now, you can see “SUNGLASSES” will appear in the uppercase.

twig Filter

NOTE: These filters are only usable in the text and textarea fields.

Mathematical Operations

The admin can perform mathematical operations like +, -, *, /, and % on the product attributes.

These operators will only be used in the Number and Price type field.

The admin can perform multiple mathematical operations in one go.

Like –

The below image shows the admin performs multiple mathematical operations in the Response Time attribute fields.

mathematical operation.

After clicking on the preview icon, the admin saw the result of the operation.

mathematical operation.

Exporting Files

The admin can also add the product template manually by Importing and Exporting the product attribute details in the CSV/XLSX format.

To export the product and product model, the admin will navigate to the Export section on the Akeneo backend.

Exporting Product.

Next, the admin will navigate to configure the export setting.

First, the admin will configure the Global Setting as per their need.

manually trigger attribute

Then, configure the content settings and filter the product as per their need.

content export setting

Lastly, the admin executes the export product job and downloads the CSV/XLSX file by tapping on the DOWNLOAD GENERATED FILES.

Now, the Akeneo user will open the CSV file.

Export download file

For example –

The store owner can trigger multiple attributes in the product description attribute field.

The below content is visible in the product CSV file added in a product Description attribute field.

“Introducing {{name}} summer shades, crafted with Sunglasses light weight metal frames for that effortlessly cool vibe under the scorching sun.

These {{name}} not only shield your eyes but also elevate your style game with their modern design and abibas ‘ signature logo detailing.

Whether you’re lounging by the pool or strolling along the beach, these shades are your perfect summer companion, blending durability, functionality, and fashion effortlessly. product price is available in both currency {{price}}.”

The above content contains two attributes that are triggered.

  • Name – Sunglasses.
  • Price – 100 EUR, 200 USD.

After exporting the product CSV file all trigger attribute values are visible in the product description content.

trigger attributes

Now import a new or an existing product after adding the template in the product description attribute field and save the file in CSV/XlSX format.

Importing File

Now, the store owner will import the CSV/XLSX file by navigating to the import section.

importing CSV/XLSX file

Click on the file that you want to import.

After clicking, the admin will configure the import job setting.

Then, please select the file to upload it.

upload

Click on Upload and import now.

The file is uploaded.

In the product CSV file, the manually triggered attributes are visible in the CSV file.

trigger attributes

The above content contains two attributes that are triggered in the product CSV file.

  • Name – Sunglasses.
  • Price – 100 EUR, 200 USD.

The admin can check the update in the product attribute section to verify the changes.

manually trigger attribute

After clicking on the preview icon, the store admin will see the content in the description attribute field.

on preview manually trigger attribute value visible

Support

That’s all about the Akeneo Template Connector. Thank you for reading this documentation. For any queries or doubts, reach out to us at [email protected]. You can raise a ticket at our HelpDesk System.

Current Product Version - 1.0.0

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