Redeem Now
Read More
Read now
Menu Close
    Start a Project Request quote Reading list Switch to dark mode
    hyperlocal-marketplace-guide

    Akeneo Product PDF Generator

    Akeneo Product PDF Generator: This module allows the store owner to generate PDF for any product and product model by using the custom PDF template. The admin can create multiple custom pdf templates and can select any template as per the requirement for the PDF. PDF can also be generated in bulk by using the Product PDF Export Job and Quick Export method. The admin can even download the pdf from the product page directly.

    Basic Requirement

    • This module works with Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x and 4.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

    • Export product pdf using simple export job
    • The admin has the advantage to create multiple templates as needed.
    • Also, the admin can select from the given list of orientations, i.e. Portrait or Landscape.
    • This module allows the admin to choose the pdf type for each product per pdf or product in single pdf
    • Export product pdf using quick export
    • Download product pdf from the product page

    Installing Module for Version 4.0.x

    Please follow these steps for installing Akeneo Product PDF Generator 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:

    in return array.

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

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

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

    Installing Module For Version 3.x

    Please follow these steps for installing Akeneo Product PDF Generator module in your 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 line

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

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

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

    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 web pack is not installed in your system. Run the following command.

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

    The workflow of PDF Generator

    After successful installation of the module, you will see Product PDF Generator icon on left side of dashboard as shown below:

    Tapping on Product PDF Generator tab will show two settings:

    1. Default Setting
    2. Custom Pdf Template

    Default Setting

    Goto default setting tab, in that fill the details of Default attribute mapping name and description of the pdf.

    After that fill the details of quick export default setting.

    • Default Pdf Template – In this you can select the default pdf template in which you want the pdf.
    • Default Pdf Orientation– In this you need to select the layout like landscape mode, portrait mode, etc.
    • Header Text – Add a description for the pdf header.
    • Footer Text – Add a description for the pdf footer.

    Custom PDF Template

    To create new pdf templates click on Create Template.

    After that a new page will open in that you need to add the Template Name and Pdf Logo.

    After that click to Save button. Then add details in the pdf layout.

    • Grid System – In this, you can select the grid in a pdf container.

    Drag the grid in the container to add the gird in container according to your need. Then you can remove the grid if that grid is not required.

    • Elements – In this you can add the elements in the grid-like name, description, etc. Drag the elements in the grid.

    After that the pdf layout will seen as shown in below image.

    Then click to Save button.

    Export PDF

    After that to export the pdf, first of all, you need to create the Export Profile. Therefore, navigate to Exports -> Create Export Profile as per the below image.

    This will redirect you to the Export Profile page. Therefore, you will enter a unique code, label, then select a job profile.

    After that click to Save button.

    Global Settings

    To export pdf you need to add details in export profile.

    • ZIP name format – In this you need to write where the zip file will be generated in the system,
    • Pdf file name format – In this, you need to write the format of the pdf file name
    • Template Layout – Select the layout in which you want to generate your pdf file.
    • Page Orientation – There are two orientation landscape and portrait mode select the orientation required in your pdf.
    • Pdf Type – Select the pdf type for each product per pdf (if you want each product in individual pdf) or product in single pdf (if you want all product in single pdf).
    • Header Text – Add the header name
    • Footer Text – Add the footer name

     After that go to the Content section and select Locale and Attribute for the exported products.

    Filter Products to Export

    You can decide which products you want to export and filter them using various options. To export a specific product you can enter its SKU in Identifier.

    Then click to Save button.

    Export Now

    After creating the export profile, click on the Export button as per the below image.

    After running the job you can check the execution detail.

    Generated PDF will look like as shown in the below image.

    Quick Export Job

    Akeneo Product PDF Generator has an amazing feature, where you can quickly create or export product(s) without going through all the job creation process. The Quick Export feature allows you to quickly export a product pdf. To do that, go to the Products page then a select product from the list then click Quick Export.

    Now select the   PDF Quick Export option. After that small slide notification will stating the Quick Export job has been launched.

    You can check the progress of the job, by going to Activity>Process Tracker. Also, once the quick export job is complete, then you can see the notification message on top. 

    Support

    Furthermore, for any issues related to this module, please create a support ticket at- https://webkul.uvdesk.com/en/customer/create-ticket.

    You can also check other Akeneo Modules. Also, for any pre-sales queries or customization discussion, please drop an email to support@webkul.com

    Current Product Version - 1.0.0

    Supported Framework Version - 2.x.x & 3.x.x & 4.x.x

    . . .

    Leave a Comment

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


    Be the first to comment.

    Back to Top
    css.php
    Hire Us!
    Brief us about your requirements and we'll get back to you.
    Woo! Hooy!
    We have just recieved your project brief and our expert will contact you shortly.
    Send Again
    Close

    Table of Content

    Hide Index