Datasheet service for Akeneo – How to guide
Thank you for your activating our Datasheet service App for your Akeneo PIM system.
The following pages and How-to guide will explain in detail how to use our Datasheet service with your Akeneo PIM system.
This guide assumes that you have already activated our Datasheet services in your Akeneo PIM via the use of our Datasheet service App. If you have not done this yet, please start by using our Akeneo App available in the Akeneo App store.
Please follow the activation instructions available here:
Datasheet service for Akeneo
During the installation, several configurations were done on your Akeneo PIM.
Whether you are using our demo datasheet template or a specific template for your company, usage will be the same.
- Login into your Akeneo system
- Navigate to your products and display your product attributes
- In the Attribute Group menu, you will fin 2 new Attribute Groups that were created.
How you work with these will depend on how you manage your product data in Akeneo, whether it is on common (parent product level) or on variant (child product level). This can be simplified when in Production, when we know how you manage your product data.
Please select the appropriate Attribute Groups for you for the next step.
Priint datasheet service attributes
Please navigate to a product view such as the screen displayed under.
- Priint attribute Group
As explained above, please select the Priint datasheet service common or variant Attribute Group, based on what level you manage your product data. - Priint template
Please select the template that was installed during the installation process : Datasheet template 1
This is a basic template that works on all Akeneo systems and that will allow to demonstrate the generation of a PDF and upload of it back into your Akeneo PIM. In Production, it is possible to manage multiple templates for each product. Templates can of course be customized to exact customer and brand needs as part of the delivery phase. - Generate PDF
Click on the Generate PDF button under the product thumbnail to start the generation of your datasheet.
This button will immediately trigger communication with our priint:cloud server, it will transfer product data required by the selected template and upload the PDF back to you Akeneo system once it is generated.
Generating a datasheet
Datasheet uploaded in your Akeneo system
Once the datasheet is generated in the cloud, the PDF will be uploaded back to your system in the Datasheet (PDF) attribute as displayed under. This upload location is the defaut attribute in our demo use case.
In production, the PDF can be uploaded to any attribute that you want, or uploaded into the Akeneo DAM.
Viewing job progress
From your product page, displaying Attributes, you will find under EXTENSIONS, a priint:cloud Jobs option (1).
Click on the extension and you can see the progress of the generation job, you can view differents statuses (2) :
- PDF Generation in progress
- Error during the PDF Generation
- PDF Generated and Uploaded
In the event of an error, you can scroll this window to the right and click on Log to understand what went wrong.
the most common error is not selecting a template before starting the PDF rendering action.
Batch Generation of PDF
You can display a list of products, or do a search and select multiple products on which you want to generate PDF Datasheets.
On the screen under, select your products (1).
Then at the bottom of the screen, click on the GENERATE PDF button (2).
Tip: before doing a batch generation, please ensure that you have selected and saved a template for each of the products.
You can do this one product at the time or in Batch edit in Akeneo.
Limitation : Bulk actions are limited to 100 records at the time by Akeneo.
In Production, we will propose a different method to generate as many datasheets as needed via Akeneo Business rules.
Server-wide priint:cloud jobs view
You can review all priint jobs in progress on your server by following these simple steps :
- Click on Akeneo Activity icon to the left
- Scroll down the page, click on priint:cloud Jobs at the bottom (2).
There you will see all PDF generation jobs in progress, their satuses, which template was selected and eventual errors.
You can also display PDF generation logs in case you run into an error.
Test demo template
Here you can view an example of a datasheet genrated with our test template.
The design will not win us any designer of the year awards, but it will allow you to test a basic, universal, template on your product data.
The demo template wil display :
- Text type attributes
- Short description attribute (if existing)
- Long description attribute (if existing)
- Common names
- List of attributes found
- Reference entities
- Assets found
- The banner and text colors are based on family values
Tip : (select a product without too many assets)
Automatic datasheet generation
- Datasheets often need to be generated automatically, when product data in Akeneo changes
- Akeneo has a powerful Business rules engine, but it cannot access third party Apps
We have developped a priint:cloud scheduler, together with Akeneo Business rules engine, that allows to create any type of rules-based tasks to automatically generate updated datasheets when data changes in Akeneo, or on a time based event.
This is not available in demo mode, but can be easly activated when in Production.
Datasheet rendering time
The actual generation (rendering) of your datasheet is processed on our powerful priint:cloud server, the generation of the datasheets will take in general 2 to 3 minutes. The Datasheet service in Akeneo makes use of the Akeneo events, therefore jobs are sent to our priint:cloud server immediately when activated.
Delay then can vary based on your template, based on the quantity of data transfered and most of all on the file size of images transfered from Akeneo to our priint:cloud servers.
Customer specific Datasheet templates
Setting up and creating new customer specific datasheets requires some profesionnal services from the priint:group technical team. This is needed in order to adapt the selected templates to your exact data model and to match exact visual brand identity for each customer.
For more on this, please contact our Sales team at sales@priint.com
Custom Datasheet examples
Datasheet service Limitations
Intended limitations of the Datasheet Service :
- The Datasheet Service App is intended for fast generation of PDF datasheets form your Akeneo PIM
- Customer specific datasheets templates must be delivered by the customer, ideally in Adobe InDesign format
- Technical services fees apply to configure customer specific templates
- The Datasheet Service is intented for the generation of PDF format datasheets, please contact us if you need other types of file output (MS Powerpoint, Adobe InDesign, MS Word, etc)
- The Datasheet Service is not intended to generate multi-product documents such as price lists, catalogues or other types of publications. Please contact us if this is needed in your print project.
For any additional questions related to our Datasheet Service and how to use customer templates, please contact us directly at : sales@priint.com