PDF Catalog Publication

Transcription

1 PDF Catalog Publication Simply create categories and products as PDF

2 INSTALLATION Installation via Magento Marketplace If you purchased the extension via Magento Marketplace, you can install the extension via the setup wizard. For more information, see Manual installation with the zip file Unpack the zip-file and copy the content 1:1 by <magento>/app/code/snmportal/publication if the zip-file has an "app" folder, please go to <magento>/. Then open an SSH shell and navigate to your root folder of the shop and execute the following commands: sudo -uwww-data bin/magento setup:upgrade sudo -uwww-data bin/magento cache:clean Please ask your Magento administrator. Further information can also be found at :

3 Settings 1 Licence Enter the license key you received from SNM- Portal here, otherwise simply enter "123". Current Version The current version is displayed here, should there be a new version, you will be informed here. Log Messages Here you can activate the log file for support. If you have any questions, please send the file to our support.

4 Settings 2 Category Settings Here you can set whether a link to the respective category pages is desired. Product Settings Show Print Link Would you like a link in the detail page of the product Use Cache: Should the PDF be regenerated every time. Default Template: Here you can select the template to be used for all products. Mapping Product Template Here you can choose different templates for specific product SKUs. In the picture the template TFF-201 is used for all article numbers with "ME". Notice: Select "Do not use" as "Default" then only the products from the mapping table will receive a PDF. See also Step5.

5 Templates In the Templates area you can add, delete and rename new templates and change their visibility. The Designer is not included in the free pdfpublication version. It will be available for a fee in a later version. If you are interested in the editor or in customer-specific templates, you are welcome to request a quotation.

6 Styles In the Styles area you can add, delete and rename new styles and change their visibility. Furthermore, adjustments can be made for the respective style type. A more detailed description and the interaction with the templates is contained in the description of the designer. The styles are imported with the templates and generally do not require any adjustmen

7 Generator In the Generator area you can add, delete and rename new generators and change their visibility. A more detailed description and the interaction with the templates is contained in the description of the designer. The generators are imported with the templates (if required) and generally do not require any adaptation. They are used to generate more complex display areas.

8 Cache / Queue For a current generation of PDFs, especially of category catalogs, an activated CronJob for the Magento shop is necessary. Queue Newly generated catalogs are entered in a job queue and processed by the CronJob. Detected changes can be found in the upper list. If errors are detected during generation, the jobs are not deleted and remain with an error message. They can then be deleted using the "Purge Queue" button. A maximum of 1 job is processed per CronJob call. If the generation was successful, the PDF is available in the lower area. Cache The finished PDFs are displayed in the lower area. The cache can be cleared via "Flush Cache". Then the "Check Catalogs" command can be executed manually to enter new jobs. The "Check Catalogs" command is also executed periodically in the background to detect changes to the category structure. SSH Command Line (bin/magento) Check the PDF Cache for changes bin/magento snm:publication:check:cache List jobs currently in the queue bin/magento snm:publication:queue:list Process Queue bin/magento snm:publication:queue:process Purge old jobs bin/magento snm:publication:queue:purge

9 Creating a Category Catalog - Step by Step A PDF catalog can be selected from the logical areas Front Page Subcategories Product Page Back Page Table of contents (in preparation) Several variants can exist in a template for an area, for example, several product pages to display certain products differently.

10 Step 1 Download Template Open the pdfpublication-templates page and select a desired template. Notice : For this example please use the template "TCA-100", you will also find templates for M1, which are not optimized for M2. You should now have loaded the file "pdf-publication-tmpl-m2-tca-100.zip". Now open the backend of your shop and navigate to the mask [SNM-Portal>PDFPublication Templates]. Here you can see the grid view of all pdfpublication templates. Please click on the button "Add new Template".

11 Step 2 Import Template Please select the type: "Import from File". Then use the "Import File" button to select the loaded file pdf-publication-tmpl-m2-tca-100.zip Finish the import with the button "Save and Continue".

12 Step 3 Save Template In addition to further information messages, you should see the picture on the left. You have now loaded the first template and is ready for further use. You can change the name here, as well as whether this template should be used for further definitions via the "Enable," status. Further adjustments are not necessary. This template simultaneously imports the "TCA-Light" style definition and the "Product Attributes Price Flat" generator. Both are visible in the respective grid masks. These also do not require any further adjustments. Images: <magento>/pub/media/wysiwyg/snm-tca Fonts: <magento>/pub/media/pdfpublication/fonts After generation you will find more temporary files at <magento>/var/snm-portal/pdfpublication. Among others, the PDF cache.

13 Step 4 Category Catalog For this example we choose a category with several subcategories, here in the Magento demo the category "Women". This category has a new section "SNM PDF Catalog" in the lower right area. We open it and see the adjoining picture. Under Template we select the template "TCA-100".

14 Step 4/2 Catalog Definition We see the logical areas of a catalog. Front Cover Products Sub Categories Back Cover Table of contents (in preparation) Now the definition can be started. If an area is not defined, it is not generated. For example, you can only customize the product area, then a catalog without title page, sub-categories and back page will be created. We will create a complete catalogue here. Let's continue with the definition of the title page

15 Step 4/3 Catalog Front Cover Front Cover We select from the selection box Spread: 1 (Front Cover) Logo Background Picture Notice: The appropriate logical selection should always be made. For example, a front cover should always be assigned to a title page, and a template can also contain several variants of a logical area. Depending on the template, further parameters can now be offered, which can be adjusted. TCA-100 offers 4 parameters which can be adjusted. background picture, title, category name, logo You can change the image or text. Magento markup tags can also be used in text fields. The model objects "category" (current category) and "product" (current product) are also available. Examples: Category Name: {{var category.name}} Shop URL: {{config path="web/unsecure/base_url"}} Shop Name: {{config path="general/store_information/name"}} Telephone: {{config path="general/store_information/phone"}} Current Date: {{var helper.date()}} Title For further information Category Name

16 Step 4/4 Catalog Products MText1 MCategory MText2 MText3 Products We select from the selection box Spread: 3 (Products) The texts of the header area of the page are customizable here.

17 Step 4/5 Catalog Subcategories Sub Categories Background Picture We select from the selection box Spread: 2 (Sub Categeories) Here you can customize the background image.

18 Step 4/6 Catalog Back Cover Back Cover Background Picture We select from the selection box Spread: 4 (Back Cover) Customizable are the text and background picture. Phone Website Info

19 Step 4/7 Test / Activate Click on the "Preview" button to generate a current preview. The difference to the final catalogue is that only one product page is created per category. If you are so far satisfied, you can also make the catalog visible in the frontend using the "Enable PDF Catalog" option. Do not forget to save. (Option in the Settings must also be set) After the catalog has been generated completely by the system (CronJob or via the menu item "PDF - Build and Show" the catalog is available for download. Notice: Please leave the task to the system for larger categories with many products. The generation is very computation-intensive and can take a few minutes.

20 Step 4/8 Customization Subcategories With the current definition, the lower category nodes would adopt the information from "Women". Now two sub-category pages are created one after the other. 1. Cover Page 2. Sub-Category Page: Tops 3. Sub-Category Page: Jackets If you do not want this, but only the intermediate page for jackets, then define "Disable /Do not display" on the tops for "Sub Categories". If you also do not want to display any products, then do the same for the "Products" area, otherwise "Do not use". In the sub-categories of Tops (jackets,...) you can undo this and make other definitions. Notice: Currently it is only possible to use the same template for the whole tree structure. It is not possible to mix the templates.

21 Step 5 Product Catalog Open the pdfpublication-templates page and select a desired template. In our example the template TPA-100. Import the template as described in Step 2. Open the section Settings[SNM-Portal>Settings>PdfPublication] and define the desired templates under "Product Settings". Default Template: Works for all products, can also be set to "Do not use", then the template must be defined under "Mapping". Mapping Product Template: Here you can define the required template for certain SKUs. Or they can be excluded with the option "Do not use". In example image all products are displayed with TPA-100, SKUs with MP* do not get a PDF and WT* get another template. The PDF can be loaded in the frontend under "PRINT PRODUCT".

22 Further information Soon the Designer will also be available, visit us on the Extension Website for more information. You can also order us for a customer-specific template. Please contact us (support@snm-portal.com) and let us know your ideas. If possible with pictures. With our different possibilities of adaptability we can also realize your wish. Your SNM-Portal Team

23 Thank you for your interest You have any questions or suggestions, please contact us: Website: snm-portal.com Demo Frontend: m2demo.snm-portal.com Demo Backend: m2demo.snm-portal.com/snm Username: demo PW: demo123 Your SNM-Portal Team