Transcription
Module Global PDFUser Manualwww.boostmyshop.com – Global PDF English1 / 13
SummaryOverview . 3Installation . 3File upload . 3Settings . 3General . 4How to use. 5Improved Invoice PDF . 5Improved packing slip PDF . 5Improved credit memo PDF . 5Print product sheet . 5Print cart . 5Build PDF catalog . 5Customize PDF . 6Themes . 6Templates . 6Syntax rules . 6Template items. 7Additional advices . 8Usable codes . 8General . 8Product . 8Invoice . 8Creditmemo. 10Cart . 11Order . 12Order / invoice / creditmemo items . 12www.boostmyshop.com – Global PDF English2 / 13
OverviewGlobalPDF is a Magento extension design to customize Magento PDF documents but also add newones Fully customizable invoices, packing slip, credit memoAutomatically generate PDF from product sheet : Global PDF supports simple, configurableand bundle products with custom optionsNew PDF to allow customer to print its cartNew PDF to print orderProduct PDF catalog generator : select products from a category or from scratch and create aPDF catalogAll PDF are fully customizable using human readable XML templatesInstallationFile e/media/CommentOnce all files are uploaded, refresh magento cache, logout and login again to magento admin panelSettingsAll settings are available using menu System Configuration General GlobalPDFNote : if you get an error message (access denied), you need to logout and login to Magento Adminpanel to reset permissionswww.boostmyshop.com – Global PDF English3 / 13
GeneralSettingThemeLogoAdressLegal informationEnable cacheDebug modewww.boostmyshop.com – Global PDF EnglishDescriptionDirectory name to use for xml templates (formore information, please read "Customize PDF"section)Picture to display in PDF headersYour postal address (displayed on invoices,shipments and credit memoText displayed in PDF footerImprove product PDF generation timeIf enabled, display every PDF item areas for4 / 13
debug purposeHow to useGlobal PDF improve magento PDF design and add ne ones : here is a tour of the different featuresImproved Invoice PDFTo view invice PDF, print an invoice using menu sales invoices [select an invoice] print buttonImproved packing slip PDFTo view packing slip PDF, print a shipment using menu sales shipments [select a shipment] printbuttonImproved credit memo PDFTo view credit memo PDF, print a credit memo using menu sales creditmemo [select a creditmemo] print buttonPrint product sheetOn the front side, select any product and click on the "print" button (close to the "add to cartbutton")Print cartOn the front side, add any product and once your are on the cart page, click on the "print" button(close to the "Place order")Build PDF catalogWith Global PDF, you can easily build a PDF catalog with selected products.To create a catalog, select menu catalog Build PDF catalog : fill in catalog name, select a category ormanually select product using the bottom grid and then, click on the "Build Catalog" button : GlobalPDF then ask you to download PDF catalogwww.boostmyshop.com – Global PDF English5 / 13
Customize PDFThe most interesting Global PDF feature is the ability to fully customize all PDF using xml templates.ThemesIf you wish to customize templates, we recommend to create a new theme to keep original templatefiles. To create a new theme, follow these instructions Create a new "my theme" directory in media/GlobalPDF/Copy all media/GlobalPDF/default content in your "my theme" directoryEnable your theme in system configuration global pdf theme : fill in my theme intheme textboxTemplatesTemplates are xml files with instructions to build PDF content. All templates are in your themedirectory : shipment.xml : template for packing slip pdfproduct.xml : template for product pdforder.xml : template for order pdfinvoice.xml : tempate for invoice pdfheader.xml : template for all pdf headerfooter.xml : template for all pdf footercreditmemo.xml : template for creditmemo pdfcatalog.xml : template for the first product catalog pagecart.xml : template for cart pdfSyntax rules {xxx} : used to print a dynmaic value. For example, {name} return product name in theproduct PDF.[xxx] : used to translate a label : for example, [invoice] will be converted to "facture" ifwebsite is in frenchTo customize template items, you can use these markups :MarkupPositionSizeFontExample positionleft "20" top "0"mode "relative"/ size width "10"height "100" / fontface "Helvetica"size "10"align "left" / DescriptionConfigure item position. Mode can be "relative" or "absolute".Using absolute mode, top and left are the shift from the currentposition in PDF. Using "absolute" mode, top and left set itemposition from the top left corner (in pixels)Item width and heightText font, size and alignment. (Alignment cant be used for multitextitems). You can use zend framework fonts : Courier, Courier-Bold,Courier-Oblique, Courier-BoldOblique, Helvetica, Helvetica-Bold,Helvetica-Oblique, Helvetica-BoldOblique, Symbol, Times-Roman,Times-Bold, Times-Italic, Times-BoldItalic, ZapfDingbatswww.boostmyshop.com – Global PDF English6 / 13
Template itemsYou can use items in templates to draw picture, rectangle, text. Here are the different availableitems :ItemDescriptionrectangleDraw a recangetextDraw text (single line)imgInsert a pictureifDraw items if condition istruemethodCall a PDF functionMultitextDraw multi line textRepeaterUsed to loop oncollection (for example,used to print orderitems)www.boostmyshop.com – Global PDF EnglishAttributesborder : border sizebordercolor : bordercolorbgcolor : backgroundcolorvalue : text to drawsrc : picture serverpathmode : draw mode :Zoom keep productproportion, useshrink to fit picture toareacondition : conditionto test (you can use{values}operator :comparison type :use "neq" fordifferent, "eq" forequal value : value tocompare to conditionname : method to call: increment y,increment x, set x,set y, set store,set footer heightvalue : methodparametervalue : text to printincrement y : if 1,the system willincrease y value usingtext heightmax lines : max linesto drawsource : collection tousemax occurences :max time to loopSub itemszindex, position, sizezindex, position, size,fontzindex, position, sizeAll itemsnonezindex, position, size,fontAll items7 / 13
Additional advices Never edit default template, always create a custom themeLook at existing template, edit them (in your custom theme) to understand behaviourTo easily set items position and size, use system configuration global pdf debug modeUsable codesCodes are dynamic values using {} to print a value from the current object (product, invoice, cart .)Generalcurrent store idstore addresslegal informationlogoglobalpdf image directorycatalog image directorystore currencyCurrent store idStore address (set in system configuration global pdf)Legal information (set in system configuration global pdf)Logo path (set in system configuration globalpdf)Current theme image directoryMagento product image directoryCurrency for current storeProductentity id, entity type id, attribute set id, type id, sku, has options, required options, created at,updated at, exclude from supply needs, external logistic run id, sent to logistic company,name, meta title, meta description, image, small image, thumbnail, url key, url path,custom design, page layout, options container, image label, small image label, thumbnail label,gift message available, price, special price, cost, weight, status, tax class id, is recurring, visibility,enable googlecheckout, is imported, default supply delay, allow individual quote request,description, short description, meta keyword, custom layout update, special from date,special to date, news from date, news to date, custom design from, custom design to,media gallery, tier price, tier price changed, stock item, is in stock, is salable, additional images,custom options, has custom options, additional information, has additional information,configurable attributes, configurations, has configurations, bundle items, has bundle itemsNote : you can also use any custom product attributeInvoiceinvoice.entity id, invoice.store id, invoice.base grand total, invoice.shipping tax amount,invoice.tax amount, invoice.base tax amount, invoice.store to order rate,invoice.base shipping tax amount, invoice.base discount amount, invoice.base to order rate,www.boostmyshop.com – Global PDF English8 / 13
invoice.grand total, invoice.shipping amount, invoice.subtotal incl tax,invoice.base subtotal incl tax, invoice.store to base rate, invoice.base shipping amount,invoice.total qty, invoice.base to global rate, invoice.subtotal, invoice.base subtotal,invoice.discount amount, invoice.billing address id, invoice.is used for refund, invoice.order id,invoice.email sent, invoice.can void flag, invoice.state, invoice.shipping address id,invoice.cybersource token, invoice.store currency code, invoice.transaction id,invoice.order currency code, invoice.base currency code, invoice.global currency code,invoice.increment id, invoice.created at, invoice.updated at, invoice.hidden tax amount,invoice.base hidden tax amount, invoice.shipping hidden tax amount,invoice.base shipping hidden tax amount, invoice.shipping incl tax,invoice.base shipping incl tax, order.entity id, order.state, order.status, order.coupon code,order.protect code, order.shipping description, order.is virtual, order.store id, order.customer id,order.base discount amount, order.base discount canceled, order.base discount invoiced,order.base discount refunded, order.base grand total, order.base shipping amount,order.base shipping canceled, order.base shipping invoiced, order.base shipping refunded,order.base shipping tax amount, order.base shipping tax refunded, order.base subtotal,order.base subtotal canceled, order.base subtotal invoiced, order.base subtotal refunded,order.base tax amount, order.base tax canceled, order.base tax invoiced,order.base tax refunded, order.base to global rate, order.base to order rate,order.base total canceled, order.base total invoiced, order.base total invoiced cost,order.base total offline refunded, order.base total online refunded, order.base total paid,order.base total qty ordered, order.base total refunded, order.discount amount,order.discount canceled, order.discount invoiced, order.discount refunded, order.grand total,order.shipping amount, order.shipping canceled, order.shipping invoiced,order.shipping refunded, order.shipping tax amount, order.shipping tax refunded,order.store to base rate, order.store to order rate, order.subtotal, order.subtotal canceled,order.subtotal invoiced, order.subtotal refunded, order.tax amount, order.tax canceled,order.tax invoiced, order.tax refunded, order.total canceled, order.total invoiced,order.total offline refunded, order.total online refunded, order.total paid,order.total qty ordered, order.total refunded, order.can ship partially,order.can ship partially item, order.customer is guest, order.customer note notify,order.billing address id, order.customer group id, order.edit increment, order.email sent,order.forced do shipment with invoice, order.gift message id,order.payment authorization expiration, order.paypal ipn customer notified,order.quote address id, order.quote id, order.shipping address id, order.adjustment negative,order.adjustment positive, order.base adjustment negative, order.base adjustment positive,order.base shipping discount amount, order.base subtotal incl tax, order.base total due,order.payment authorization amount, order.shipping discount amount, order.subtotal incl tax,order.total due, order.weight, order.customer dob, order.increment id, order.applied rule ids,order.base currency code, order.customer email, order.customer firstname,order.customer lastname, order.customer middlename, order.customer prefix,order.customer suffix, order.customer taxvat, order.discount description, order.ext customer id,order.ext order id, order.global currency code, order.hold before state,order.hold before status, order.order currency code, order.original increment id,order.relation child id, order.relation child real id, order.relation parent id,www.boostmyshop.com – Global PDF English9 / 13
order.relation parent real id, order.remote ip, order.shipping method,order.store currency code, order.store name, order.x forwarded for, order.customer note,order.created at, order.updated at, order.total item count, order.customer gender,order.hidden tax amount, order.base hidden tax amount, order.shipping hidden tax amount,order.base shipping hidden tax amount, order.hidden tax invoiced,order.base hidden tax invoiced, order.hidden tax refunded, order.base hidden tax refunded,order.shipping incl tax, order.base shipping incl tax, order.stocks updated, order.fullstock date,order.estimated shipping date, order.payment validated, order.is valid, order.anounced date,order.anounced date max, order.external logistic run id, order.sent to logistic company,order.logistic status, order.billing address, order.shipping address, order.payment method,invoice.items, invoice.historyCreditmemocreditmemo.entity id, creditmemo.store id, creditmemo.adjustment positive,creditmemo.base shipping tax amount, creditmemo.store to order rate,creditmemo.base discount amount, creditmemo.base to order rate, creditmemo.grand total,creditmemo.base adjustment negative, creditmemo.base subtotal incl tax,creditmemo.shipping amount, creditmemo.subtotal incl tax, creditmemo.adjustment negative,creditmemo.base shipping amount, creditmemo.store to base rate,creditmemo.base to global rate, creditmemo.base adjustment, creditmemo.base subtotal,creditmemo.discount amount, creditmemo.subtotal, creditmemo.adjustment,creditmemo.base grand total, creditmemo.base adjustment positive,creditmemo.base tax amount, creditmemo.shipping tax amount, creditmemo.tax amount,creditmemo.order id, creditmemo.email sent, creditmemo.creditmemo status, creditmemo.state,creditmemo.shipping address id, creditmemo.billing address id, creditmemo.invoice id,creditmemo.cybersource token, creditmemo.store currency code,creditmemo.order currency code, creditmemo.base currency code,creditmemo.global currency code, creditmemo.transaction id, creditmemo.increment id,creditmemo.created at, creditmemo.updated at, creditmemo.hidden tax amount,creditmemo.base hidden tax amount, creditmemo.shipping hidden tax amount,creditmemo.base shipping hidden tax amount, creditmemo.shipping incl tax,creditmemo.base shipping incl tax, order.entity id, order.state, order.status, order.coupon code,order.protect code, order.shipping description, order.is virtual, order.store id, order.customer id,order.base discount amount, order.base discount canceled, order.base discount invoiced,order.base discount refunded, order.base grand total, order.base shipping amount,order.base shipping canceled, order.base shipping invoiced, order.base shipping refunded,order.base shipping tax amount, order.base shipping tax refunded, order.base subtotal,order.base subtotal canceled, order.base subtotal invoiced, order.base subtotal refunded,order.base tax amount, order.base tax canceled, order.base tax invoiced,order.base tax refunded, order.base to global rate, order.base to order rate,order.base total canceled, order.base total invoiced, order.base total invoiced cost,order.base total offline refunded, order.base total online refunded, order.base total paid,order.base total qty ordered, order.base total refunded, order.discount amount,order.discount canceled, order.discount invoiced, order.discount refunded, order.grand total,order.shipping amount, order.shipping canceled, order.shipping invoiced,www.boostmyshop.com – Global PDF English10 / 13
order.shipping refunded, order.shipping tax amount, order.shipping tax refunded,order.store to base rate, order.store to order rate, order.subtotal, order.subtotal canceled,order.subtotal invoiced, order.subtotal refunded, order.tax amount, order.tax canceled,order.tax invoiced, order.tax refunded, order.total canceled, order.total invoiced,order.total offline refunded, order.total online refunded, order.total paid,order.total qty ordered, order.total refunded, order.can ship partially,order.can ship partially item, order.customer is guest, order.customer note notify,order.billing address id, order.customer group id, order.edit increment, order.email sent,order.forced do shipment with invoice, order.gift message id,order.payment authorization expiration, order.paypal ipn customer notified,order.quote address id, order.quote id, order.shipping address id, order.adjustment negative,order.adjustment positive, order.base adjustment negative, order.base adjustment positive,order.base shipping discount amount, order.base subtotal incl tax, order.base total due,order.payment authorization amount, order.shipping discount amount, order.subtotal incl tax,order.total due, order.weight, order.customer dob, order.increment id, order.applied rule ids,order.base currency code, order.customer email, order.customer firstname,order.customer lastname, order.customer middlename, order.customer prefix,order.customer suffix, order.customer taxvat, order.discount description, order.ext customer id,order.ext order id, order.global currency code, order.hold before state,order.hold before status, order.order currency code, order.original increment id,order.relation child id, order.relation child real id, order.relation parent id,order.relation parent real id, order.remote ip, order.shipping method,order.store currency code, order.store name, order.x forwarded for, order.customer note,order.created at, order.updated at, order.total item count, order.customer gender,order.hidden tax amount, order.base hidden tax amount, order.shipping hidden tax amount,order.base shipping hidden tax amount, order.hidden tax invoiced,order.base hidden tax invoiced, order.hidden tax refunded, order.base hidden tax refunded,order.shipping incl tax, order.base shipping incl tax, order.stocks updated, order.fullstock date,order.estimated shipping date, order.payment validated, order.is valid, order.anounced date,order.anounced date max, order.external logistic run id, order.sent to logistic company,order.logistic status, order.billing address, order.shipping address, order.payment method,creditmemo.items, creditmemo.historyCartentity id, store id, created at, updated at, converted at, is active, is virtual, is multi shipping,items count, items qty, orig order id, store to base rate, store to quote rate,base currency code, store currency code, quote currency code, grand total, base grand total,checkout method, customer id, customer tax class id, customer group id, customer email,customer prefix, customer firstname, customer middlename, customer lastname, customer suffix,customer dob, customer note, customer note notify, customer is guest, remote ip,applied rule ids, reserved order id, password hash, coupon code, global currency code,base to global rate, base to quote rate, customer taxvat, customer gender, subtotal,www.boostmyshop.com – Global PDF English11 / 13
base subtotal, subtotal with discount, base subtotal with discount, is changed, trigger recollect,ext shipping info, gift message id, anounced date, anounced date max, x forwarded for, items,shipping amount, shipping description, tax amountOrderentity id, state, status, coupon code, protect code, shipping description, is virtual, store id,customer id, base discount amount, base discount canceled, base discount invoiced,base discount refunded, base grand total, base shipping amount, base shipping canceled,base shipping invoiced, base shipping refunded, base shipping tax amount,base shipping tax refunded, base subtotal, base subtotal canceled, base subtotal invoiced,base subtotal refunded, base tax amount, base tax canceled, base tax invoiced,base tax refunded, base to global rate, base to order rate, base total canceled,base total invoiced, base total invoiced cost, base total offline refunded,base total online refunded, base total paid, base total qty ordered, base total refunded,discount amount, discount canceled, discount invoiced, discount refunded, grand total,shipping amount, shipping canceled, shipping invoiced, shipping refunded, shipping tax amount,shipping tax refunded, store to base rate, store to order rate, subtotal, subtotal canceled,subtotal invoiced, subtotal refunded, tax amount, tax canceled, tax invoiced, tax refunded,total canceled, total invoiced, total offline refunded, total online refunded, total paid,total qty ordered, total refunded, can ship partially, can ship partially item, customer is guest,customer note notify, billing address id, customer group id, edit increment, email sent,forced do shipment with invoice, gift message id, payment authorization expiration,paypal ipn customer notified, quote address id, quote id, shipping address id,adjustment negative, adjustment positive, base adjustment negative, base adjustment positive,base shipping discount amount, base subtotal incl tax, base total due,payment authorization amount, shipping discount amount, subtotal incl tax, total due, weight,customer dob, increment id, applied rule ids, base currency code, customer email,customer firstname, customer lastname, customer middlename, customer prefix, customer suffix,customer taxvat, discount description, ext customer id, ext order id, global currency code,hold before state, hold before status, order currency code, original increment id,relation child id, relation child real id, relation parent id, relation parent real id, remote ip,shipping method, store currency code, store name, x forwarded for, customer note, created at,updated at, total item count, customer gender, hidden tax amount, base hidden tax amount,shipping hidden tax amount, base shipping hidden tax amount, hidden tax invoiced,base hidden tax invoiced, hidden tax refunded, base hidden tax refunded, shipping incl tax,base shipping incl tax, stocks updated, fullstock date, estimated shipping date,payment validated, is valid, anounced date, anounced date max, external logistic run id,sent to logistic company, logistic status, billing address, shipping address, payment method,itemsOrder / invoice / creditmemo itemswww.boostmyshop.com – Global PDF English12 / 13
item id, order id, parent item id, quote item id, store id, created at, updated at, product id,product type, product options, weight, is virtual, sku, name, description, applied rule ids,additional data, free shipping, is qty decimal, no discount, qty backordered, qty canceled,qty invoiced, qty ordered, qty refunded, qty shipped, base cost, price, base price, original price,base original price, tax percent, tax amount, base tax amount, tax invoiced, base tax invoiced,discount percent, discount amount, base discount amount, discount invoiced,base discount invoiced, amount refunded, base amount refunded, row total, base row total,row invoiced, base row invoiced, row weight, gift message id, gift message available,base tax before discount, tax before discount, ext order item id, weee tax applied,weee tax applied amount, weee tax applied row amount, base weee tax applied amount,base weee tax applied row amount, weee tax disposition, weee tax row disposition,base weee tax disposition, base weee tax row disposition, locked do invoice, locked do ship,price incl tax, base price incl tax, row total incl tax, base row total incl tax,hidden tax amount, base hidden tax amount, hidden tax invoiced, base hidden tax invoiced,hidden tax refunded, base hidden tax refunded, is nominal, tax canceled, hidden tax canceled,tax refunded, comments, reserved qty, purchase order id, logistic statuswww.boostmyshop.com – Global PDF English13 / 13
Global PDF improve magento PDF design and add ne ones : here is a tour of the different features Improved Invoice PDF To view invice PDF, print an invoice using menu sales invoices [select an invoice] print button . invoice.cybersource_token, invoice.store_currency_code, invoice.transaction_id, invoice.order_currency_code, invoice.base .
