Akeneo Web To Print

Akeneo Web To Print extension acts as a connector between Akeneo and Adobe InDesign. Using this extension, you can export products from Akeneo PIM to Adobe InDesign.

The products exported can be easily categorized into documents like print catalogs, brochures, magazines, and other print materials.

Print catalogs are one of the efficient ways by which retailers can advertise their products, by providing the pamphlets directly into the hands of the consumer.

Basic Requirements:

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

 Check out the following video tutorials below:

1. Create export jobs for exporting products data from Akeneo to Adobe InDesign
2. Re-fetch export data from Adobe InDesign
3. Send multiple images with the content
4. Also works with product models
5. Akeneo Web To Print is compatible with the latest Akeneo version 7.0.x
6. Filter products using categories, families, locales, identifier
7. Source code open for customization.

1- Composer Installation

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.

Akeneo 6 and 7

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

3: Use composer to install the extension.

         composer require webkul/web2printbundle

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

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

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

Please follow these steps for installing  Adobe Web To Print extension module in your Akeneo PIM platform.

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

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

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

in return array.

3 – Copy the “config” folder into akeneo project root directory for routing.

4 – Run this command after ssh to your akeneo server by the terminal

php bin/console Web2Print:setup:install

5. If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.

For Akeneo 5

sudo service php-fpm7.4 restart

For Akeneo 4

sudo service php-fpm7.3 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;

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;

Follow the below steps for installing Adobe Web To Print extension in the Akeneo PIM Platform.

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

2 – Goto app/AppKernel.php then add a line in function registerProjectBundles()

new Webkul\Web2PrintBundle\Web2PrintBundle(),

3 – Goto app/config/routing.yml then add these lines at the top of the file

web2print_connector:
    resource: "@Web2PrintBundle/Resources/config/routing.yml"
    prefix:   /

4 – You have to navigate first to Akeneo installation directory (Ex: cd /opt/bitnami/apps/akeneo/htdocs). After SSH, you have to run the command to your Akeneo server by the terminal.

php bin/console Web2Print:setup:install

5 – You have to restart your web server like Apache, Nginx. Run the command for the Apache webserver.

sudo service apache2 restart

6 – If you are using php-fpm. Then you need to restart the php-fpm services.

sudo service php-fpm7.2 restart

1. Enable PlayerDebugMode To turn on debug mode:

On Mac

In the terminal, type: defaults write com.. adobe.CSXS.11 PlayerDebugMode 1

On Windows

Open the registry key HKEY_CURRENT_USER/Software/Adobe/CSXS.11 and add a key named PlayerDebugMode, of type String, and value. You should only need to do this once.

Note: Directory CSXS.8 for InDesign 2008 or old version, CSXS.9 for InDesign 2019-2020, CSXS.10 for InDesign 2021, CSXS.11 for InDesign up to 2024, and CSXS.12 for InDesign 2025 & onwards.

Copying the extension into place. Download the web2print extension folder from this code.

Now that the system is ready to load custom extensions, the last thing we have to do is copy our extension into the shared extensions folder on disk:

On Mac

Copy the extension folder into ~/Library/Application Support/Adobe/CEP/extensions

On Windows

Copy the extension folder into %APPDATA%\Adobe\CEP\extensions

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:

1 – Webpack Installation: If you get the below error.

It means that a webpack is not installed in your system. Run the following command

npm install --save-prod webpack
npm install

2 – Module routing.yml is not configured properly. Re-check the routing.yml file as mentioned in the 3rd step of Module Installation

3 – Clear your browser cache.

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

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

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

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

To create a new product in Akeneo

1 – Go to Products > Create after that select the Product option.

2 – After that enter SKU then choose a product family.

3 – Fill in all the production information for this new product.

4 – Upload multiple images of a product

5 – Select a particular category for the product. You can also choose more than one category for a product.

Once you have created or imported the products in Akeneo, you can now move forward to the export process.

Export Asset

There is only one job to export in the module

• Web2Print Export with Zip File

1 – Go to Exports>Create Export Profile then enter any code, label, and select the ‘Web2Print Export with Zip file option.

2 -Select storage type and file path in which you want to export the data

Note:If the path is not updated, CSV and image files will be created in the PIM root directory.

After that, add details in the Global settings-

3- Save the profile go to the Content section then select your channel where your products will be exported. Choose the locales for deciding in what language you will be sending the content.

4 – You can make use of filters to exports only selected products. You can filter products based on family, status, completeness, category, and time condition.

If you want to export only one or more products, you can do that by entering the SKU value in the identifier section.

Once you have saved the export profile information, you can now click the Export Now button after that wait for the execution process to get completed.

You can see the progress of the export process as below. Moreover, if there is any error you can also see it here.

Follow the below process to configure Adobe InDesign for Adobe Web To Print extension on Windows.

Step 1 – Turn on the Debug Mode For InDesign  –

For CEP11 (FY 2021) –

Open the registry key Windows => HKEY_CURRENT_USER/Software/Adobe/CSXS.11 then add a key named PlayerDebugMode, of type String, and value 1.

or,

Set debug mode on Windows from CMD (Command line) Copy

reg add HKEY_CURRENT_USER\SOFTWARE\Adobe\CSXS.11 /t REG_SZ /v PlayerDebugMode /d 1 /f

For CEP10 (FY 2020) –

Open the registry key Windows => HKEY_CURRENT_USER/Software/Adobe/CSXS.10 then add a key named PlayerDebugMode, of type String, and value 1.

or,

Set debug mode on Windows from CMD (Command line) Copy

reg add HKEY_CURRENT_USER\SOFTWARE\Adobe\CSXS.10 /t REG_SZ /v PlayerDebugMode /d 1 /f

For CEP9 (CC 2019 & 2020) –

Open the registry key Windows => HKEY_CURRENT_USER/Software/Adobe/CSXS.9 then add a key named PlayerDebugMode, of type String, and value 1.

or,

Set debug mode on Windows from CMD (Command line) Copy

reg add HKEY_CURRENT_USER\SOFTWARE\Adobe\CSXS.9 /t REG_SZ /v PlayerDebugMode /d 1 /f

For CEP8 (CC 2018) :

Open the registry key Windows => HKEY_CURRENT_USER/Software/Adobe/CSXS.8 then add a key named PlayerDebugMode, of type String, and value 1.

or,

Set debug mode on Windows from CMD (Command line) Copy

reg add HKEY_CURRENT_USER\SOFTWARE\Adobe\CSXS.8 /t REG_SZ /v PlayerDebugMode /d 1 /f

You should only need to do this once.

Relocating web2print extension folder. Find the web2print extension folder in the zip file that you have downloaded.

 Now that the system is ready to load the custom extension, the last thing we have to do is copy our extension into the shared extensions folder on disk.

Step 2 – Copy the extension folder into %APPDATA%\Adobe\CEP\extensions

(If the directory CEP\extensions doesn’t exist inside Adobe, you can create it manually then put the extension folder web2print inside extensions folder)

Step 3: Restart the System

Open InDesign, Go to Menu panel >> Window >>Extensions >> Akeneo Web2Print

Follow the below process to configure Adobe InDesign for Adobe Web To Print extension on Mac.

Step 1 – Turn on the Debug Mode For InDesign  –

For CEP11 (FY 2021) –

Open the registry key Mac =>  ~/Library/Preferences/com.adobe.CSXS.11.plist then add a key named PlayerDebugMode, of type String, and value 1.

or,

Set debug mode on Mac from CMD (Command line) Copy

defaults write com.adobe.CSXS.11.plist PlayerDebugMode 1 && killall -u `whoami` cfprefsd

For CEP10 (CC 2021) –

Open the registry key Mac =>  ~/Library/Preferences/com.adobe.CSXS.10.plist then add a key named PlayerDebugMode, of type String, and value 1.

or,

Set debug mode on Mac from CMD (Command line) Copy

defaults write com.adobe.CSXS.10.plist PlayerDebugMode 1 && killall -u `whoami` cfprefsd

For CEP9 (CC 2019 & 2020) –

Open the registry key Mac =>  ~/Library/Preferences/com.adobe.CSXS.9.plist then add a key named PlayerDebugMode, of type String, and value 1.

or,

Set debug mode on Mac from CMD (Command line) Copy

defaults write com.adobe.CSXS.9.plist PlayerDebugMode 1 && killall -u `whoami` cfprefsd

For CEP8 (CC 2018) :

Open the registry key Mac =>  ~/Library/Preferences/com.adobe.CSXS.8.plist then add a key named PlayerDebugMode, of type String, and value 1.

or,

Set debug mode on Mac from CMD (Command line) Copy

defaults write com.adobe.CSXS.8.plist PlayerDebugMode 1 && killall -u `whoami` cfprefsd

You should only need to do this once.

Relocating web2print extension folder. Find the web2print extension folder in the zip file that you have downloaded.

 Now that the system is ready to load the custom extension, the last thing we have to do is copy our extension into the shared extensions folder on disk.

Step 2 – Copy the extension folder into ~/Library/Application Support/Adobe/CEP/extensions

(If the directory CEP\extensions doesn’t exist inside Adobe, you can create it manually then put the extension folder web2print inside extensions folder)

Step 3: Restart the System

Open InDesign, Go to Menu panel >> Window >>Extensions >> Akeneo Web2Print

Now that the extension has been configured, we are ready to create a print document in Adobe InDesign. Follow the below process:

1 – After that go to Menu panel >> Window >>Extensions >> Akeneo Web2Print

2 – Enter the Akeneo credentials then fetch data.

3 – After that click on the “Add data to data merge” button.

4 – Go to ‘Data merge Panel’ in Indesign from Menu panel >> Windows >> Utilities >> Data merge

5 – Create a template for a product, place placeholders in it by dragging them from Data merge panel.

6 – After that click on Create merged document icon, Select options for data merge then Merge data.

7 – Using special text, you can add break lines, bullets, and number lists in the export job. As shown in the image you can add a bullet to the para.

8- Then you will get the Merged Document.

So, that was much about the User Guide of the Akeneo web-to-print module for any queries or doubts reach out to us at support@webkul.com. You can also raise a ticket at our HelpDesk System.

Please explore our Akeneo Development Services and Quality Akeneo Extensions.