Home

webEdition Shop Module

image

Contents

1. Ee En Ed BB PO 9 New Order No 17 from 2005 11 24 ear 2005 12 December 0 fy 11 Novembar 4 iy 10 October 8 H 09 September 2 fg 0E August 0 fm 07 July 0 EB De tome Dame Dokument 2005 08 10 16 31 2005 08 10 16 55 fim 05 May 0 f 04 April 0 Karierter Pullover in Bla Dokument 2005 08 08 14 31 2005 09 16 12 40 fg 03 March 0 Fi fy 02 February 0 Dokument 2005 09 16 13 39 2005 09 16 14 16 fy 01 January 0 Article documents Article objecta Revenue overview List of all articles 14 Article Nome ID Type Creation Date Last Updated Ping 3D Dokument 2005 08 10 13 49 2005 08 10 14 09 Pinke Skisocken Dokument 2005 08 10 15 25 2005 09 16 12 41 Roter Baumwollpullover Dokument 2005 08 08 11 09 2005 09 16 12 40 Rotes T Shirt Dokument 2005 08 31 15 39 2005 09 16 12 42 Schach Dokument 2005 08 10 16 08 2005 08 10 16 26 Schwarze Herrensocen Dokument 2005 08 10 15 37 2005 09 16 12 41 Skatspiel Apfelblatt Dokument 2005 08 10 2005 08 11 10 11 Sumpfpfau Dokument 2005 08 10 2005 08 10 16 02 Tennissocken Schwarz We Dokument 2005 08 10 2005 09 16 12 41 WE Pullover blau Dokument 2005 08 08 2005 09 16 12 39 World of Office RPG Dokument 2005 08 10 2005 08 10 15 25 This view displays all articles documents and objects If you click
2. T webeEdition manage your content Shop Module is ey The Shop Module User Guide Standard 4 1 1 October 2006 2006 living e AG All rights reserved Printed in Germany living e AG does not extend any guarantee or warranty concerning the accuracy and correctness of any information contained in this manual This manual may not be reproduced by any means either electronically or mechanically photocopied recorded reproduced or transferred by information storage or information retrieval systems by the purchaser for purposes other than private use without the express written consent by living e AG The purchaser is authorized to make one backup copy of the software A copy of this software can be requested from living e AG at any time or it can be downloaded at www living e de Neither living e AG nor suppliers of living e AG shall be held liable for any damage this shall include without restriction any damage arising from lost profits operation breakdowns loss of business information or data or any other financial losses which arise from the use of this product or from the inability to use this product even in the event that living e AG has been informed of the possibility of such damage In any case of damage liability of living e AG shall be limited to the amount you have actually paid for the product Microsoft Windows and Explorer are trademarks of Microsoft Corporation Macintosh and Apple are trad
3. 35 Figure 27 VATs in the order overview 36 Figure 28 Change shipping cost in order 38 Figure 29 On line shop transactions 39 Figure 30 Payment Provider settings PayPal 40 Figure 31 Form for personal entries 40 Figure 32 PayPal Buy Now Button german example 42 Figure 33 Payment Provider settings Saferpay 44 Figure 34 Saferpay Button in Form german example 45 Figure 35 Output to browser 54 Shop Module 8 Contents Standard 4 1 1 October 2006 About this document Purpose of this document This document treats the webEdition Shop Module and how to use it You can use this manual to learn e what the Shop Module is e how to install the module e how to use this module to set up an online shop e how to create templates to manage shop pages Audience This document is intended for personnel in the following groups e Web administrators Note The Shop Module is recommended for advanced users of webEdition and for those with a knowledge of e commerce Web site architecture and design e Web editors The webEdition customer documentation suite The documentation team publishes new webEdition documents to support the release of all webEdition features modules and enhancements You can consult our documentation suite for detailed information about the modules you have purchased or about webEdition products that you may wish to purchase in the future All customer documentation is available in portable doc
4. lt we field name WE_PATH type text hyperlink true gt lt br gt lt we repeat gt lt we back gt back lt we back gt lt we next gt next lt we next gt lt we ifFound gt lt we listview gt lt we repeat gt lt we back gt back lt we back gt lt we next gt next lt we next gt lt we listview gt This makes it very easy to display multi hierarchical product groups 2 2 3 lt we category gt lt we category gt could display up to now only information about the category ies ofthe current document This was extended with the attributes field and id The attribute field Standard 4 1 1 October 2006 Configuration of the Shop Module 31 permits the access to the new fields of the category with the attribute id a certain category independent of document can be read out Example e lt we category field Title gt displays the title of the category of the current document or Listviewentry within Listviews e lt we category field Description gt displays the description of the category of the current document or Listview entry within Listviews e lt we category id 7 gt displays the name of the category with id 7 e lt we category id 7 field Description gt displays the description of the category with id 7 2 3 Freely determinable fields Now in the shop from webEdition version 3 5 free input fields are also realizable for shop articles Thereby it is possible withou
5. order data viewing 24 Order Data tab 24 orders viewing all customer s orders 25 viewing by month 23 viewing order data 24 P payment providers linking to 39 transaction model 39 PayPal 39 integration of 39 Precautionary messages about 10 Attention boxes 10 Caution boxes 10 product groups 29 Shop Module 56 Q Quickstart screen 14 initial settings for Shop Module 14 Settings button 14 R reference documentation 9 revenue 16 Saferpay 44 integration of 44 using on website 45 select boxes used for quantity of items 51 52 settings changing 15 Currency 15 initial with Quickstart screen 15 Number format 15 Shipping 37 shop menu items in Additem 18 Shop Module calculations 53 creating a detailed view of anitem 49 creating summaries of items 50 exiting 18 functions 13 in Modules menu 14 initial settings 14 installation 13 interaction with the Customer Management Module 13 main screen explorer menu 22 23 order processing screen 22 23 Quickstart screen 14 shopping cart 50 users 13 Year menu 18 Shopcategories 29 shopping cart creating 51 placing items in 50 summaries of items creating 50 T templates Shop 27 Typographical conventions 10 V Variants in documents 27 in objects 28 variants of shop articles 27 VAT 33 adding to a document 33 in shopping cart 35 special tags 36 W we category 30 we field type shopVat 34 we form tag special functions in Shop Module 52 we li
6. td align right gt EURO lt we calculate um waren gt lt we showShopItemNumber hopname shopers gt lt we field name Price gt lt we calculate gt lt td gt lt td gt lt End possible orders gt lt tr gt lt we repeatShopitem gt lt End article listing gt lt tr gt lt td colspan 4 gt lt td gt lt tr gt lt tr bgcolor silver gt lt td colspan 3 gt total lt td gt lt td align right gt EURO lt we sum name waren gt lt td gt lt tr gt lt table gt u The amount attribute is a further enhancement of the lt we a gt tag Here we are using it in the form lt we a id 148 shop on amount 5 gt five lt we a gt The ID listed is the next page is the same as the calling page in this example The shop attribute specifies that this is a Shop function The amount attribute provides a link that increases the item number we shopItemNumber by five Another way to allow shoppers to change the item quantity is by including select boxes as shown in the following example lt Begin possible orders gt Shop Module 52 Designing a template for the Shop Module lt td align center gt lt we showShopItemNumber shopname shopers gt lt we form id id_der_folgeseite type shopliste gt lt td width 30 class nav0 bgcolor white gt lt select name shop_anzahl size 1 class nav0 gt lt option value 1 gt 1 lt option
7. u 00 September 2 Quickstart A 08 August 0 fy 07 July 0 f Preferences A 06 June 0 fm 05 May 0 Payment Provider 04 April 0 4 A iy 03 March 0 Article Revenue A 02 February 0 A 01 January 0 H E E FE 1 3 1 1 Preferences The module opens with the Shop Quickstart dialog box Click the Preferences button to set your initial Shop preferences You can choose from the following options Standard 4 1 1 October 2006 Shop Module Introduction 15 Preferences Currency VAT 16 Yo i Since version 3 5 it is possible to use several vat rates p Se wh icle Ea ich are saved directly with the article german Numberformat Records per er Page 20 amp Class ID 1 3 Shop Object ID ID ID ID Customer fields Attention Customer Contact Address1 gt Module Contact Address2 Contact Company Contact Count vi Customer fields Attention Order Contact Address1 Contact Address2 Contact Company Contact Country Cancel Figure 3 Shop settings screen Currency Select the currency of choice VAT Set the tax rate as a percentage that you are obliged to collect Number format Choose the number format from the select box German English French or Swiss Records per page Set the number of records to be dispalyed per page Class ID This field
8. 1 we paypal With lt we paypal gt module built in PayPal variables from the shop can be accessed like business address shop email country password Country code ISO as well as on the setting whether a test account or live shop should be used In addition the settings used in a form and in PayPal for transmitting personal data are set The mandatory parameter shopname passes the name of the current shop pricename passes the name of the current prize field netprice determines whether the prices are Net or Gross TRUE or FALSE and usevat investigates whether a value added tax should be used or not TRUE or FALSE 3 6 2 we saferpay With lt we saferpay gt you can access the Saferpay variables eneterd in the shop module see Section 3 4 The settings used in a form and for transmitting personal data to saferpay are also set The mandatory parameter shopname passes the name of the current shop pricename passes the name of the current prize field netprice determines whether the prices are Net or Gross TRUE or FALSE and usevat investigates whether a value added tax should be used or not TRUE or FALSE onsuccess links on the ID of the web edition page in case of a successful order Standard 4 1 1 October 2006 Linking to a payment provider 47 onfailure links on the ID of the web edition page in case of a not successful order if an error should have appeared onabortion links on t
9. 4 Making a shopping cart on page 4 51 e Section 4 5 Special function of the lt we a gt tag in the Shop Module on page 4 52 e Section 4 6 Special functions of the lt we form gt tag in the Shop Module on page 4 52 e Section 4 7 Performing calculations on page 4 53 4 1 Creating a detailed view of an item The process of creating a template for an item summary is performed in a similar fashion to other webEdition functions see Creating Templates in the webEdition User Manual You can use any design for the detail page of an item The only exceptions are the following we tags which must be on a Shop Detail page as there are fields in the Shop Module that correspond to these fields e A lt we input gt or lt we textarea gt with the name shoptitle e A lt we input gt or lt we textarea gt with the name shopdescription e A lt we input gt with the price of the product The name of this entry field is up to you but it is very important because this field name must be provided later on as a price variable together with the lt we writeshopdata gt tag Note 1 Important The article category has to be named with a starting shop The category can also be named like shop_1 shop_new shop_online or the likes Else no articles can be installed in the shop Note 2 The price variable has no fixed name since you can also work with various prices The price written to the database is the one provided in the pricename variab
10. Provider on page 15 Shop Module 22 Shop Module Introduction e Articles Revenues Opens the corresponding window see Section 1 3 1 3 Article Revenue on page 16 e Order Has the following sub menu items Add Article Adds from before defined articles to the current order You may perform this action also with the Quickbutton aS Figure 12 Add article quickbutton Delete Order dletes the selected order You may perform this action also with the Quickbutton Figure 13 Delete order quickbutton Note To be able to add an article to an order or to delete a complete order you must at first have selected an existing order in the explorermenu 1 3 2 3 The Help menu The help menu has two options e Info Select this option to access information about the license holder and the version of webEdition you are using e Help Select this option to access the webEdition Help System 1 3 3 The Shop Module main screen The start screen see Figure 14 Shop Module main screen on page 23 is divided into two parts e explorer menu on the left side e order processing screens on the right side Standard 4 1 1 October 2006 Shop Module Introduction 23 Figure 14 Shop Module main screen Shop Edit Help es Em E0 GE 9 new Order No 17 from 2005 11 24 Year 2005 F a 12 December 0 E M 11 November 4 Ag 10 Octobe 8 EM 09 September 2 E M 08 August 0 m f 07 July 0 E 06 June
11. gt a certain value added tax set can be assigned to an article Besides a list with the sets entered in the shop module from which one can select the desired one is generated lt we shopVat type select gt for instance generates a dropdown menu for the edit mode of the document with the pre defined VATs Figure 24 VATs in the dropdown menu german example With lt we shop Vat id 1 gt one can display the value added tax set of the selected Id This is sensible to be able to expel different VATs in the shopping cart decollated 2 4 2 Value added tax sets for an object If objects are used as shop articles these can also use the value added tax sentences described on top From version 3 5 the field type shop Vat value added tax field has been added to classes The name shopvat is a constant and cannot be changed Objects of a class with this field can select the value added tax set then analogously to documents from within the shop module to built in sets Then the output of the VAT set on the web site occurs like for other elements lt we field type shopVat gt respectively lt we var type shopVat gt Shop Module 34 Configuration of the Shop Module Figure 25 Taxes with shopvat in a class Name shopvat Type VAT field Default 8 Erm igter Satz 16 Normaler Satz 8 Erm igter Satz da Everybody 2 4 3 Using VATs With lt we shopVat gt for docum
12. has none ustid ustid is empty and must come from one of the defined countries Example lt we ifShopPayVat gt Customer has to pay VAT gt calculate VAT lt we else gt Customer has not to pay VAT lt we ifShopPayVat gt e VAT rates The Edit VAT rate window opens seeFigure 10 Figure 10 Edit VAT rate Edit VAT rate Id Name VAT rate Standard 1 Normal rate 16 Ja 2 Reduced rate 8 Nein Edit VAT rate Name Normal rate VAT rate Standard Here you can define different VATs Select for a new tax rate a suitable name enter the suitable percent number and determine whether it should concern the standard rate of taxation Click then on Save Should no value added tax clause be assigned to an article the opposed standard clause is taken if available If still no values are entered here the earlier entered VAT is used for compatibility reasons Then the VATs entered here can be integrated by shop documents as well as by shop properties Besides during the complete purchasing process exclusively the id of the VAT is used Only if the order is closed and is stored in the database the VAT valid at the time of the order is saved Therefore an additional adaptation of the VAT does not alter finished orders e Shipping and handling The Shipping and handling window is opened Standard 4 1 1 October 2006 Shop Module Introduction 21 Figure 11 Shipping and Handling Shipp
13. herrlich erfrischend 17 85 Je nach G sort still Mineralwasser Exquisites Wasser Dieses Wasser 125 58 125 58 stellt bei w sort normal Luxus Wasser Price 227 43 Shipping and handling 0 00 plus VAT 16 33 53 8 1 43 Total price 262 39 If you want to change afterwards the VAT of an article merely click the order and enter the desired new value in the opening prompt In addition can be decided in the order view afterwards whether the value added tax should be computed Depending on whether the forwarding expenses were entries net or gross or whether the data saved in the goods basket were built in as net gross prices the prices are anew computed in the order then 2 4 5 VAT special we tags 2 4 5 1 we ifShopPayVat With lt we ifShopPayVat gt the surrounded contents are only displayed if the logged in customer must also pay value added taxes Whether a customer must pay taxes depends primarily on the country to which the product must be delivered In addition country rules can be defined in the Shop Module under edit gt countries 2 4 5 2 we ifShopVat With lt we ifShopVat gt can be controlled whether an article has a certain VAT This tag is used in shops with several VAT sets 2 4 5 3 we shopVat With lt we shopVat gt a value added tax set can be assigned to a shop article from the defined VATS If the attribute id is assigned merely the value added tax set with th
14. is defined the dafault value is returned Field of Country Contact_Country i i Select the field of the Customer Module containing the country of origin billing adress It is used f to decide whether the customer has to pay VAT or not States liable to VAT Deutschland i i Customer from these countries must pay VAT States not liable to VAT Schweiz ij Customer from these countries must not pay VAT States with special rules Frankreich sterreich ij Customer from these countries only have to pay VAT if also an additional rule matches Additional Rule ustid Empty Result true f Save u Cancel Default value Standard return value for lt we ifShopPay Vat gt in case none of the opposed rules applies Field of Country In this field the name of the field is stored in the customer management which contains the origin land invoice address Shop Module 20 Shop Module Introduction States liable to VAT Customers from these countries must pay VAT States not liable to VAT Customers from these countries must not pay VAT States with special rules Customer from these countries only have to pay VAT if also an additional rule matches Additional rule The field in the customer management called e g ustid corresponds to a condition e g blank then the value opposed here is returned e g A customer must pay VAT true if he
15. is only displayed if the Database Object Module is installed If objects are to be used as shop articles the IDs of all classes containig shop articles must be entered here comma separated This includes the listing of all shop articles as well as the features to extend orders In the field Class ID many classes can be entered arbitrarily e Customer fields Customer Module Select here the fields to be indicated from the Customer Management Module To select several fields please hold the the Shift key while selecting These preferences concern the announcement within the Shop Module e Customer fields Order Select here the fields which should be indicated the customer As a rule customer s fields of the Customer Management are used to hold on current dates of the customer as for example comments to the customer of the web pages operating authority payment behavior etc By contrast customer fields of the order are necessary around address dates etc to be able to prove at the time of the order so that also afterwards still valid order dates are available Save your preferences by clicking on the Save button Note Youcan change these preferences at a later date by selecting Shop gt Settings from the main drop down menu 1 3 1 2 Payment Provider Click in the Quickstart menu on the button Payment Provider the corresponding window is opened see Shop Module 16 Shop Module Introduction Figure 4 Pam
16. shopVat gt lt we calculate gt lt we ifShopVat gt lt we ifShopVat id 2 gt lt we calculate print false sum totalVat2 gt lt we showShopItemNumber type print shopname demoshop gt lt we field name price gt 100 lt we field type shopVat gt lt we calculate gt lt we ifShopVat gt lt we ifShopPayVat gt lt we repeatShopItem gt Standard 4 1 1 October 2006 Configuration of the Shop Module 35 In the above example different sums of the complete value added tax are computed according to Id of the used value added tax set Depending on which value added taxes exist the sums total Vat1 and or total Vat2 are thereby computed lt we ifVarSet name totalVatl type sum gt lt tr gt lt td class shoppingCartNumber gt zzgl MwSt lt we shopVat id 1 gt lt td gt lt td class shoppingCartNumber gt lt we sum name totalVat1 num_format german gt amp euro lt td gt lt tr gt lt we ifVarSet gt lt we ifVarSet name totalVat2 type sum gt lt tr gt lt td class shoppingCartNumber gt zzgl MwSt lt we shopVat id 2 gt lt td gt lt td class shoppingCartNumber gt lt we sum name totalVat2 num_format german gt amp euro lt td gt lt tr gt lt we ifVarSet gt Then these both sums must be added for the computed price and the shopping cart is finished lt tr gt lt th class shoppingCartNumber gt Gesamtpreis
17. shopers gt lt we field name Price gt lt we calculate gt lt td gt lt td gt lt tr gt lt we repeatShopitem gt Shop Module 54 Designing a template for the Shop Module A tr gt lt td colspan 4 gt lt td gt lt tr gt tr bgcolor silver gt lt td colspan 3 gt total lt td gt lt td align right gt Euro lt we sum name warenkorb num_format german gt lt td gt lt tr gt lt table gt A The code cited above produces the following output on a browser see Figure 35 Figure 35 Output to browser Standard 4 1 1 October 2006 55 Index A a tag special attributes for amount 52 delarticle 52 shop 52 special functions in Shop Module 52 add shop item tag 50 All Customer s Orders tab 25 all customers order s viewing 25 articleview 16 Audience 9 audience profile 9 C calculate PHP functions 53 calculations using we calculate tag 53 using we sum tag 53 class ID 15 create shop tag 50 Currency setting 15 Customer Management Module interaction with the Shop Module 13 Customer service 12 D detailed view creating for an item 49 E explorer menu 22 23 F Fields freely determinable 31 in orders 32 in shop articles 31 form tag 52 forwarding expenses 37 installation of Shop Module 13 Modules menu Shop Module in 14 Monthly overview explained 23 statistical summary 23 N Number format setting 15 O
18. 0 E a 05 May 0 _ lt EA 04 April 0 SE E M 03 March 0 ity 02 February 0 EI Ot January 0 Overview Jahr auswahlen 2005 Monet ausw hlen November vi Order quantity Unprocessed Paid Unpaid Sales total 4 4 0 00 182 39 182 39 contains VAT 16 Q44 8 6 96 Article ID Paid wE Pullover blau l 33 pending Rotes T Shirt sort m Lachen um jeden Preis TB Variant Taschenbuch Gruner Kugelfisch Variant Gr n Roter Baumwollpullover 4 1 2 pending pending pending pending Roter Beumwollpullover Si pending Roter Baumwollpullover 1 pending 1 3 3 1 The explorer menu The explorer menu acts as a directory of all Shop Module orders in a business year Each month is represented by a folder By clicking on the character to the left ofthe folder you can open the directory for that month to view a list of all orders The number in brackets adjacent to the month indicates the number of orders for that month 1 3 3 2 The order processing screens The order processing screen has two views Monthly overview and the order processing screen each of which are accessed by clicking on items in the explorer menu 1 3 3 2 1 Monthly overview If you click on a month folder itself a summary appears in the right side of your screen showing the number of processed and unprocessed Shop orders Below this area is a statistical evaluation that reports the total
19. 13 gt lt img src http images paypal com images x click but0l gif border 0 width 62 height 31 alt Make Payments with PayPal it s fast free and secure title Make Payments with PayPal it s fast free and secure gt lt we a gt In this example the id 113 refers to the document paypal php In this file merely the paypal tag will be interpreted called with the names for the shop as well as price and whether the price as Net and taxshould be used More information about this tag can be found in the description of the lt we paypal gt tag The source code of the file paypal php resp paypal tmpl lt we sessionStart gt lt we createShop shopname demoshop gt lt we addDelShopItem shopname demoshop gt lt DOCTYPE HTML PUBLIC w3C DTD HTML 4 01 Transitional EN gt lt html gt lt head gt lt we title gt lt we title gt lt we description gt lt we keywords gt lt we charset defined ISO 8859 1 gt ISO 8859 1 lt we charset gt lt we css id 10 gt lt head gt lt body gt lt div class content gt lt div class header gt lt we include id 46 gt lt div gt lt div class leftNavigation gt lt we include id 11 gt lt we include id 3 gt lt div gt lt div class mainContent gt lt div class fullWidth gt lt div class contentFirstDiv gt lt hl gt Pay Pal lt hl gt lt h2 gt powered by webEdition lt h2 gt lt div class divwithPadding gt
20. 4 Value added tax on page 33 e Section 2 5 Shipping on page 37 2 1 Variants From webEdition version 3 5 it is possible to use variants of articles 2 1 1 Variants of shop articles An improvement desired for a long time for the shop module is the possibility of variants for shop articles With the sales of similar articles it is very laborious to put on a completely new article every time although merely the color differs Now from webEdition 3 5 it is possible to create several variants for a shop article These own all properties of the original article and overwrite merely the varying elements Hence an article variation is dependent always from the original article and can be called only in its context At the moment only variants of shop articles can be created i e the template class must contain the fields specific for shops shopdescription shoptitle and price Only if these fields can be found it is possible to create variants Which articles and fields own variants is set directly in the class or template One creates variants on a concrete article directly within aforesaid object or document 2 1 2 Variants in article documents To create variants for articles based on documents fields for the variants have to be specified in the template Variants can be created only if the template contains the shopspecific fields shoptitle shopdescription and price If this is the case the template has the tab Variants In the Varia
21. 4 Designing a template for the Shop Module 49 Creating a detailed view of an item 49 Creating item summaries 50 Ordering items 50 Making a shopping cart 51 Special function of the lt we a gt tag in the Shop Module 52 Special functions of the lt we form gt tag in the Shop Module 52 Performing calculations 53 Index 55 Standard 4 1 1 October 2006 Contents 7 List of figures Figure 1 Modules drop down menu 14 Figure 2 The Shop Module start screen with Quickstart 14 Figure 3 Shop settings screen 15 Figure 4 Pament Provider 16 Figure 5 Article Revenue view Article documents 17 Figure 6 Artikel Umsatz Ansicht Umsatz bersicht 18 Figure 7 Shop drop down menu 18 Figure 8 Edit drop down menu 19 Figure 9 Value added tax regulations specific for countries 19 Figure 10 Edit VAT rate 20 Figure 11 Shipping and Handling 21 Figure 12 Add article quickbutton 22 Figure 13 Delete order quickbutton 22 Figure 14 Shop Module main screen 23 Figure 15 Monthly overview 23 Figure 16 Order Data view 24 Figure 17 Editing an order 24 Figure 18 Viewing all of acustomer s orders 25 Figure 19 Variant fields in the template 28 Figure 20 Variant fields for objects in classe 28 Figure 21 Kategorie Ansicht 29 Figure 22 Freely determinable field in article 32 Figure 23 Free fields in order 33 Figure 24 VATs in the dropdown menu german example 33 Figure 25 Taxes with shopvat in a class 34 Figure 26 Articles with VAT german example
22. Der Text sollte noch geschrieben werden lt div gt lt div gt lt div gt lt div class fullWidth gt lt div class border gt lt div class divwithPadding gt lt we paypal shopname demoshop pricename price netprices true usevat true gt lt div gt lt div gt lt div gt lt div gt lt div gt lt we ifVar name action match success type request gt lt we deleteShop shopname demoshop gt lt we ifVar gt lt body gt lt html gt Shop Module 44 Linking to a payment provider 3 4 Integrating Saferpay The settings dialogue for Saferpay can be accessed with Edit gt Payment Provider the Quckickstart button of the same name or the Payment provider button The Payment provider window is opened Figure 33 Payment Provider settings Saferpay Saferpay Language english en de fr it Account ID 123 234 234 Serial No Shop Owner test test de Notify Email allow collect No see saferpay Manual additional Form No for Deliveryaddress Confirmation No Confirmmail to Customer Providerset 69 77 79 comma separated exec path 2 8 usr local bin conf path path to saferpay Thank you for your order Description eg order e Language Saferpay accepts the language variations specified here With this setting you can influence the appearance of the Saferpay terminal e Account ID In this field must be deposited the supplied Acco
23. Schweiz sterreich Frankreich Anderes id s Contact_Country gt lt p gt lt p gt lt label for s Contact_Email gt Email lt label gt lt we sessionField name Contact_Email type textinput class inputs id s Contact_Email gt lt p gt lt p gt lt label for s Contact_Tell gt Phone lt label gt lt we sessionField name Contact_Tell type textinput class inputs id s Contact_Tell gt lt p gt lt p gt lt label for s Attention gt Attention by lt label gt lt we sessionField name Attention type textinput choice true options Bitte ausw hlen Zeitschrift Empfehlung eines Bekannten Empfehlung auf einer Website Sonstiges id s Attention gt lt p gt lt p gt lt label for s Exacting gt How exactly lt label gt lt we sessionField name Exacting type textinput class inputs id s Exacting gt Shop Module 42 Linking to a payment provider lt p gt lt p gt lt label gt amp nbsp lt label gt lt input type submit class inputButton name order value Weiter gt lt p gt lt p gt Mandatory fields lt p gt lt fieldset gt lt we form gt A correct entry leads to the fact that everything also personal data are validated and transmitted to PayPal PayPal needs exactly 2 entries for the correct payment winding up This are the PayPal business address email as wel
24. This should be placed within the data transmitting form Figure 34 Saferpay Button in Form german example Bitte kontrollieren Sie nochmals die unten angegebenen Daten Sind die Angaben korrekt k nnen Sie mit der Bestellung fortfahren Falls einige Daten nicht bereinstimmen korrigieren Sie diese bitte Daten korrigieren Geniessen Sie die Vorteile eines registrierten Benutzers und registrieren Sie sich noch heute Registrierung Ist alles korrekt Schliessen sie ihre Bestellung ab und w hlen Sie noch die Zahlmethode aus Bestellen EPA Mit saferpay BUY NOW The code lt we a class inputButton id 123 gt With saferpay lt we a gt In this example the id 123 refers to the document saferpay php In this file merely the saferpay tag will be interpreted after the implementing of the OpenSaferpayScript file called with the names for the shop as well as price and whether the price as Net and tax should be used In addition in the tag the IDs of the sequence pages in each case for onsuccess onfailure or onabortion can be defined Further information on the lt we saferpay gt tag can be found in the tag reference The code for saferpay php resp saferpay tmpl lt we sessionStart gt lt we createShop shopname demoshop gt lt we addDelShopItem shopname demoshop gt lt DOCTYPE HTML PUBLIC w3C DTD HTML 4 01 Transitional EN gt lt html gt lt head gt lt we title gt lt we title gt lt we desc
25. _Email gt Email lt label gt lt we sessionField name Contact_Email type textinput class inputs id s Contact_Email gt lt p gt lt p gt lt label for s Contact_Tell gt Telefon lt label gt lt we sessionField name Contact_Tell type textinput class inputs id s Contact_Tell gt lt p gt lt p gt lt label for s Attention gt Aufmerksam durch lt label gt lt we sessionField name Attention type textinput choice true options Bitte ausw hlen Zeitschrift Empfehlung eines Bekannten Empfehlung auf einer Website Sonstiges id s Attention gt lt p gt lt p gt lt label for s Exacting gt Wodurch genau lt label gt lt we sessionField name Exacting type textinput class inputs id s Exacting gt lt p gt lt p gt lt label gt amp nbsp lt label gt lt input type submit class inputButton name order value Weiter gt lt p gt lt p gt Pflichtfelder lt p gt lt fieldset gt lt we form gt Standard 4 1 1 October 2006 49 4 Designing a template for the Shop Module This chapter shows you how to use we tags to create templates for your on line shop This following functions are described in this chapter e Section 4 1 Creating a detailed view of an item on page 4 49 e Section 4 2 Creating item summaries on page 4 50 e Section 4 3 Ordering items on page 4 50 e Section 4
26. che unserer Gr ner Apfel inbehandelt nsere Baseballm tzen sind von 2 3 2 Freely determinable fields in orders The free fields in orders work analogously to free fields of articles However besides is used we shopField reference cart Also here many free fields can be added arbitrarily to an order The free order fields are indicated in the order view of the shop can be displayed during the order however also with lt we shopField type print gt These fields are used for the input as follows Comment lt we shopField reference cart name shop_comment shopname demoshop type textarea gt If you want to display this again to send it for example by mail or as a control for the user following syntax can be used Komment lt we shopField reference cart name shop_comment shopname demoshop type print gt only the field is returned Standard 4 1 1 October 2006 Configuration of the Shop Module 33 Also here is to be noted that the page from which the form is sent off absolutely must include we createShop Then the fields are listed with the accompanying order Figure 23 Free fields in order Further comments to this order shop_comment Ihre Meinung 9 ft shop_opinion sehr gut A AM fern gt These fields can be deleted or edited after click on the suitable icon 2 4 Value added tax 2 4 1 Value added tax set associate to a document With lt we shopVat
27. d Address entries also belong to UST ID it Those data which are available in this Street dialog about the select boxes These data are administered in the customer management and are selected must be taken into consideration with the creation of Country a shop form for the purpose of the Email registration with personal data Ifyou select e g for the transmission of the given name the option Forename in the selectbox this must be also taken into consideration in the How exactly source program of the form in the shop with the field according to given name Mandatory fields Surname Company ZIP code City Phone Attention For the form the following XHTML code was used lt we form id self pass_id customerData name userform gt lt we sessionField name ID type hidden gt lt we sessionField name UserGroup type hidden value webCustomer gt lt we sessionField name Username type hidden autofill true gt lt we sessionField name Password type hidden autofill true gt lt fieldset gt lt legend gt Billing address lt legend gt lt p gt lt label for s Salutation_Salutation gt Salutation lt label gt lt we sessionField name Salutation_Salutation type textinput class select choice on options Mr Mrs id s Salutation_Salutation gt lt p gt lt p gt lt label for s Forename gt Forename lt label
28. e given Id is returned 2 4 5 4 we field type shopVat Delivers within a we listview shopping cart we object the value added tax set of the current article of the entry 2 4 5 5 we var type shopVat Analogously to we field type shopVat the accompanying value added tax set is returned here on a detailed page for an object Standard 4 1 1 October 2006 Configuration of the Shop Module 37 2 4 5 6 we writeShopData netprices true false usevat true With lt we writeShopData gt can be indicated whether the passed prices are Net or Gross And whether the different value added taxes should be taken into consideration or not Default value of both entries is true i e by Default prices are accepted Net and the value added tax with is taken into consideration 2 4 5 7 we ifVarSet type sum Controls whether the variable of the type sum originates by lt we calculate sum gt is set 2 4 5 8 we ifNotVarSet type sum Analogously to we ifVarSet type sum 2 5 Shipping 2 5 1 Shipping on the webseite The defined postage and forwarding expenses can also be accessed by we tags according to order value and origin land of the logged in customer the suitable set is determined and returned However besides only the entered costs are returned then these can be used as desired on the page These expenses are defined as shown in Section 1 3 2 2 The value added tax consists of the VAT of the price and the forwarding expe
29. e a gt lt td gt lt tr gt lt tr gt lt td gt lt img src root layout_images pixels gif width 500 height 6 border 0 gt lt td gt lt tr gt lt we repeat gt lt table gt lt we listview gt All items lt we listview rows 6 doctype shop gt Ordering items In order to allow an on line shopper to put an item into the shopping cart the following function must be available in the detailed item view or the summary lt we a id id_of_the_following_page shop on gt Order lt we a gt The shop attribute was added to the lt we a gt tag This function transfers the item information into the shopping cart This is only possible if the following we tags are on the page specified in the id attribute of the lt we a gt tag lt we createShop shopname shopname gt lt we addShopitem shopname shopname gt Only when this function is called up will the item be added to the order or put into the shopping cart It is essential that you ensure that every order request with the lt we a gt tag and the shop on attribute is followed by a page with lt we createShop gt and lt we addShopItem gt tags The next page can be any page even the calling page itself Ideally it is the shopping cart which immediately displays the ordered item If it is not the shopping cart the ordered item is saved and displayed the next time the shopping cart is called Standard 4 1 1 October 2006 Designing a t
30. emarks of Apple Computer Inc UNIX is a trademark of UNIX System Laboratories All other trademarks are the property of their respective owners Contents About this document 9 1 Shop Module Introduction 13 What is the webEdition Shop Module 13 Intended users 13 Interaction with the Customer Management Module 13 Installation 13 General information and navigation 14 Shop Module Quickstart 14 The Shop Module main screen 18 The Shop Module main screen 22 2 Configuration of the Shop Module 27 Variants 27 Variants of shop articles 27 Variants in article documents 27 Variants in article objects 28 Product groups by categories 29 Advanced category functions 29 lt we listview type category gt 29 lt we category gt 30 Freely determinable fields 31 Freely determinable fields in shop articles 31 Freely determinable fields in orders 32 Value added tax 33 Value added tax set associate toa document 33 Value added tax sets for an object 33 Using VATs 34 VATs in the shopping cart 35 VAT special we tags 36 Shipping 37 Shipping on the webseite 37 Forwarding expenses with orders 38 3 Linking to a payment provider 39 Payment provider transaction model 39 Integrating PayPal 39 Using PayPal on the Website 42 Integrating Saferpay 44 Using Saferpay on your website 45 New or extended tags in version 3 5 46 we paypal 46 we saferpay 46 Shop Module 6 Contents we sessionField addition autofill true 47
31. emplate for the Shop Module 51 4 4 Making a shopping cart In order to make a shopping cart for your Web site you must use a webEdition list with the following we tag lt we repeatShopltem shopname shopname gt lt we repeatShopltem gt Below is an extended example lt we createShop shopname shopers gt lt we addDelShopItem shopname shopers gt lt Begin header gt lt table width 100 border 0 gt lt tr bgcolor silver gt lt lt lt td gt Item lt td gt td width 50 gt Number lt td gt td gt Price lt td gt lt td gt Total price lt td gt lt tr gt lt End header gt lt Begin article listing gt lt we repeatShopltem shopname shopers gt LBE lt td class normal bgcolor white gt lt table border 0 gt lt tr gt lt td gt lt we field name Bild type img hyperlink on border 0 height 30 width 30 align top gt lt td gt lt td gt lt b gt lt we field name Title alt we_path hyperlink on gt lt b gt lt br gt lt we field name Description alt we_text max 200 gt lt td gt lt tr gt lt table gt lt Begin possible orders gt lt td align center gt lt we showShopltemNumber shopname shopers gt lt br gt lt we a id 148 shop on amount 1 gt 1 lt we a gt lt we a id 148 shop on amount 1 gt 1 lt we a gt lt td gt lt td gt lt td gt lt S
32. enses and all accompanying information are determined and saved with the order Then within the Shop Module the due forwarding expenses are indicated and added for the whole price In addition these postage costs can be edited afterwards in addition one simply clicks the postage costs and then can edit the postage relevant data for this order Figure 28 Change shipping cost in order Order and customer data if All customer s orders Contact_Company Edit data of customer within this order Open this customer in customer management module Edit shipping costs Shipping cost 25 00 Is net 27 00 VAT rate 17 85 125 58 16 00 le g Price 227 43 Shipping and handling FER plus VAT 16 33 53 tan eS Note Tag from Version 3 5 lt we shipping gt With we shipping tag the forwarding expenses entered in the Shop Module can be accessed With the help of the order value and the origin land of the logged in customer the suitable forwarding expenses are determined and passes the name we sum which contains the goods value of the order The result from we shipping can be processed in the returned Besides the imperative parameter sum Template and be added e g with we calculate tag to the shopping cart Standard 4 1 1 October 2006 39 3 Linking to a payment provider The following chapter discussed some guidl
33. ent Provider Payment Provider Available fields for transmitting to a payment provider Forename Surname Street Zip City PayPal Country Code Business Account Saferpay Language Account ID Shop Owner allow collect additional Form Confirmation Providerset exec path conf path Description Forename Surname Contact_Address1 Contact_Zip i Contact_Address2 Deutschland test test de 150 PayPal E Mail Sandbox Test amp nbspTest or Live Account english en de fr it 123 234 234 test test de Serial No Notify Email No see saferpay Manual No for Deliveryaddress No Confirmmail to Customer 69 77 79 comma separated z B usr local bin path to saferpay Thanks for your order For more information about Payment Providers please refer to 3 Linking to a payment provider on page 39 1 3 1 3 Article Revenue Click the Article Revenue button to open the view of that name In this view the tabs Article dokuments Article objects and Revenue overview are located see Figure 5 Note Notice please that the Article objects tab only exists if you have installed the DB Object Module article properties exist and the correct Class ID is defined in the preferences cf also Section 1 3 1 1 Preferences Standard 4 1 1 October 2006 Shop Module Introduction 17 Figure 5 Article Revenue view Article documents op a Help
34. entc and lt we field type shopVat gt or lt we var type shopVat gt for objectes or Listviews also shopping cart the VATs are displayed on the website To allow a flawless work with value added tax sentences these are called on the complete web site by their Id This offers numerous possibilities to work with the different sets and enables you to change the sets at a later time without influencing the functionality of the underlying templates The tag lt we ifShopVat id gt controls whether the current document or the current entry has the value added tax set with the specified Id in a Listview Thus different value added tax sentences can be decollated and expeled easily A shopping cart could look as follows lt we repeatShopltem shopname demoshop gt lt tr gt lt td gt lt we field name shoptitle hyperlink true gt lt td gt lt td class shoppingCartNumber gt lt we showShopItemNumber shopname demoshop gt lt td gt lt td class shoppingCartNumber textBold gt lt we calculate sum totalPrice num_format german gt lt we showShopItemNumber type print shopname demoshop gt lt we field name price gt lt we calculate gt amp euro lt td gt lt tr gt lt we ifShopPayVat gt lt we ifShopVat id 1 gt lt we calculate print false sum totalVat1 gt lt we showShopItemNumber type print shopname demoshop gt lt we field name price gt 100 lt we field type
35. er 2006 13 1 Shop Module Introduction This introduction is intended to help you familiarize yourself with the webEdition Shop Module This chapter treats what the module does and how to install it You can also find information here about the basic layout and command features for the Shop Module These topics are treated in the following sections e Section 1 1 What is the webEdition Shop Module on page 13 e Section 1 2 Installation on page 13 e Section 1 3 General information and navigation on page 14 1 1 What is the webEdition Shop Module The webEdition Shop Module is a toolkit that can assist you to set up a Web based shopping site With the Shop Module you can e create any number of items or item groups e design item summaries listviews and detailed item views e place shopping carts anywhere on your pages organize your order management e perform transaction calculations sales taxes discounts etc e use an open interface to a payment provider e integrate your shop data with the webEdition Customer Management Module 1 1 1 Intended users The Shop Module is a toolkit intended for advanced users of webEdition and those with a knowledge of e commerce Web site architecture and design Knowledge of the webEdition template development processes and webEdition tags we tags are required in order to develop an online shop 1 1 2 Interaction with the Customer Management Module The Shop Module needs the
36. gt lt we sessionField name Forename type textinput class inputs id s Forename gt lt p gt Standard 4 1 1 October 2006 Linking to a payment provider 41 lt p gt lt label for s Surname gt Surname lt label gt lt we sessionField name Surname type textinput class inputs id s Surname gt lt p gt lt p gt lt label for s Contact_Company gt Company lt label gt lt we sessionField name Contact_Company type textinput class inputs id s Contact_Company gt lt p gt lt p gt lt label for s ustid gt UST ID lt label gt lt we sessionField name ustid type textinput class inputs id s ustid gt lt p gt lt p gt lt label for s Contact_Address1 gt Street lt label gt lt we sessionField name Contact_Address1 type textinput class inputs id s Contact_Address1 gt lt p gt lt p gt lt label for s Contact_Zip gt Zip Code lt label gt lt we sessionField name Contact_Zip type textinput class zip id s Contact_Zip gt lt p gt lt p gt lt label for s Contact_Address2 gt City lt label gt lt we sessionField name Contact_Address2 type textinput class inputs id s Contact_Address2 gt lt p gt lt p gt lt label for s Contact_Country gt Country lt label gt lt we sessionField name Contact_Country type select class select x values Deutschland
37. gt lt option value 2 gt 2 lt option gt lt option value 3 gt 3 lt option gt lt option value 4 gt 4 lt option gt lt option value 5 gt 5 lt option gt lt option value 6 gt 6 lt option gt lt option value 7 gt 7 lt option gt lt option value 8 gt 8 lt option gt lt option value 9 gt 9 lt option gt lt option value 10 gt 10 lt option gt lt select gt lt td gt lt we form gt lt End possible orders gt 4 5 Special function of the lt we a gt tag in the Shop Module Within an item list in the Shop the lt we a gt tag takes on three new attributes e shop shows the tag that it is in a Shop e amount Number of items that are put into the shopping cart by clicking on the link created by the we a tag e delarticle takes the corresponding item out of the shopping cart again The following code puts the corresponding item into the shopping cart lt we a id id_der_folgeseite shop on amount 1 gt Into the shopping cart lt we a gt The following code takes the item out of the shopping cart again lt we a id id_der_folgeseite delarticle on gt Out of the shopping cart lt we a gt The following code creates a link to delete the complete shopping cart lt we a id id_der_folgeseite delshop on gt Delete shopping cart lt we a gt 4 6 Special functions of the lt we form gt tag in the Shop Module The we form tag has one additional attribute in the Shop M
38. he ID of the web edition page in case of an abnormal termination of the order 3 6 3 we sessionField addition autofill true This tag was extended with the attribute autofill This attribute will come hany especially while implementing a form If a lt we sessionField gt is provides with the addition autofill true a Script is called in the background which autofills a variable with a value When using this addition e g within an input field to the entry of an username and or password webEdition automatically generates a value and needs and e g the user no longer has to log in to be able to order in the shop The XHTML code for such a form could look like this lt we form id self pass_id customerData name userform gt lt we sessionField name ID type hidden gt lt we sessionField name UserGroup type hidden value webCustomer gt lt we sessionField name Username type hidden autofill true gt lt we sessionField name Password type hidden autofill true gt lt fieldset gt lt legend gt Rechnungsadresse lt legend gt lt p gt lt label for s Salutation_Salutation gt Anrede lt label gt lt we sessionField name Salutation_Salutation type textinput class select choice on options Herr Frau id s Salutation_Salutation gt lt p gt lt p gt lt label for s Forename gt Vorname lt label gt lt we sessionField name Forename type textinput class inpu
39. ines that you can use for linking your Web site to a payment provider Note Every payment provider has its own interface and requirements for the transfer of payment data For this reason webEdition does not provide an interface for payment providers 3 1 Payment provider transaction model Figure 29 shows a typical transaction arrangement Figure 29 On line shop transactions Your Payment Credit Web Shop Provider Card Provider 2 3 i i 4 Customer By way of example we have described two possible ways to link your shop to a payment provider e transfer the total price e transmit every item individually 3 2 Integrating PayPal The settings dialogue for PayPal can be accessed with Edit gt Payment Provider the Quckickstart button of the same name or the Payment provider button The Payment provider window is opened Shop Module 40 Linking to a payment provider Figure 30 Payment Provider settings PayPal Payment Provider Available fields for transmitting to a payment provider Forename Forename v Surname Surname Street Contact_Address1 Zip Contact_Zip City Contact_Address2 PayPal Country Code Deutschland 150 Business test test de PayPal E Mail Account Sandbox Test Y Test or Live Account Figure 31 Form for personal entries Salutation Forename To be able to form comfortably a payment winding up with PayPal some personal data are require
40. ing and handling Field of Country Contact_Country BR VAT Normaler Satz 16 v Prices are net true v Existing rates a New Entry _ Ausland ag aa Name Inland Lander Deutschland Kosten Bestellwert Versandkosten tz 0 10 m 20 5 T 100 0 cn aa Standard false v Save Close Field of country In this field you select the field of the customer management in which the origin land of the customer is stored VAT The value added tax clause which should apply to postal charges and packaging This can be selected from the defined sets Prices are net If the prices are net or gross This is important especially in the shop backend all these specifications are stored with the order process and are taken into consideration within the order view In the Template itself these values can be freely used Existing rates List of all defined rates Name Internal used name Is used for Existing rates Countries List of countries to which this rule should apply Cost The dependence on order value and forwarding expenses can be entered in this list graded In this example a purchasing to 20 euros of 10 euros of forwarding expenses between 20 and 100 euros of order value 5 euros and more than 100 euros costs nothing more Standard If no other rule of the forwarding expenses applies the standard rule is used always e Payment Provider Opens the Pament Provider window See Section 1 3 1 2 Payment
41. ion system administrator for further details Caution boxes Caution messages indicate that there are possible risks to your software or database if you perform a specified task without taking the suggested appropriate precautions For example CAUTION Database warning If you complete this procedure your database will be overwritten How commands system responses and we tags are represented The commands system responses and webEdition tags called we tags used in this document conform to the following conventions Standard 4 1 1 October 2006 About this document 11 Web interface commands Commands performed through a Web browser are shown in italic typeface For example Click on the Save button Menu based commands performed in a Web browser are shown in italic typeface Drop down or nested menu commands are separated by an input prompt gt For example Select Customers gt New from the main menu of the Customer Management Module webEdition tags and template code The webEdition templates use a specialized set of programming tags based on the PHP programming language These webEdition tags or we tags are displayed in courier typeface and in angled brackets Opening tags appear thus lt we tag gt Closing tags appear thus lt we tag gt The programming code used in webEdition templates is also represented in this document by courier typeface lt we sessionStart gt lt we ifRegi
42. kirsche 15 00 13 10 2005 7 pending 13 Dame 44 00 13 10 2005 82 pending 14 wE Pullover blau 32 00 22 11 2005 33 pending 1 3 2 The Shop Module main screen The Shop Module main screen has three drop down menus Shop Edit and Help 1 3 2 1 The Shop menu The Shop menu contains the following items see Figure 7 Shop drop down menu on page 18 e Business year Select the year you want to be diplayed e Close Use this command to exit the module Figure 7 Shop drop down menu Help ausness year 2005 5 2004 Close 2003 2002 1 3 2 2 The Edit menu In the Edit menu the following items can be slected see Figure 8 Edit drop down menu on page 19 Standard 4 1 1 October 2006 Shop Module Introduction 19 Figure 8 Edit drop down menu Edit Help Preferences Countries VAT rates Shipping and handling Payment Provider Articles Revenues Add Article Delete order e Preferences Opens the preferences window see Section 1 3 1 1 Preferences e Countries A window is opened in which you can determine the regulations specific for countries with regard to the value added tax clause Figure 9 Value added tax regulations specific for countries Ruleset Customers of which states have to pay VAT Default value true 9 i i Default value determines the result of we ifShopPayVat if none of the following rules is matching If no rule
43. l as the ISO country code for the correct winding up of the payment with regard to accordingly correct currency and tax By means of a selectbox the suitable ISO Country code is selected and the business address is given what is actually the PayPal email address Optional you may choose in another Selectbox between the PayPal shop live shop and the PayPal sand box PayPal integrated developing environment for testing Further information about the sand box can be found in the PayPal documentation 3 3 Using PayPal on the Website For the data transmission to PayPal the PayPal tag can be used ifthe neccessary data has been enetered in the backend First of all there should be e g a PayPal Buy Now button which links on a special PayPal page This should be placed within the data transmitting form Figure 32 PayPal Buy Now Button german example Bitte kontrollieren Sie nochmals die unten angegebenen Daten Sind die Angaben korrekt k nnen Sie mit der Bestellung fortfahren Falls einige Daten nicht bereinstimmen korrigieren Sie diese bitte Daten korrigieren Geniessen Sie die Vorteile eines registrierten Benutzers und registrieren Sie sich noch heute Registrierung Ist alles korrekt Schliessen sie ihre Bestellung ab und w hlen Sie noch die Zahlmethode aus Bestellen Bay al Mit saferpay BUY NOW the corresponding XHTML source code Standard 4 1 1 October 2006 Linking to a payment provider 43 lt we a id 1
44. le in the lt we writeShopData gt tag Note Please also note that all detailed views of items must be assigned as a uniform document type and or a uniform category since item summaries are generated with Shop Module 50 Designing a template for the Shop Module 4 2 4 3 webEdition s listview function Ideally you will have a uniform document type e g shop_article or the like for all detailed views in your Shop and will distinguish between the item groups according to various categories shop_article_dvd shop_article_ cd etc so that they generate both a general summary of all items only via document types and summaries of all item groups document types and categories Creating item summaries The summaries of items or item groups are generated as normal listviews In the following code example assume that you have named a document type shop and that there are two item groups shop_dvd and shop_cd shop dvd sample item group summary lt we listview rows 6 doctype shop categories shop_dvd gt lt table border 0 cellpadding 0 cellspacing 0 width 500 gt lt we repeat gt lt tr gt lt td class normal gt lt b gt lt we field name shoptitle alt we_path hyperlink on gt lt b gt lt br gt lt we field name shopdescription alt we_text max 200 gt lt br gt Price lt we field name prize gt Euro lt we a id id_des_shopping_cartes shop on gt In den Shopping_cart lt w
45. lt th gt lt td class shoppingCartNumber textBold gt lt we calculate num_format german gt lt we sum name totalVat1 gt lt we sum name totalVat2 gt lt we sum name totalPrice gt lt we calculate gt amp euro lt td gt lt IEr gt Then the page generated looks as follows Figure 26 Articles with VAT german example Artikel Anzahl x Preis Pinker Pullover 1 x 10 00 16 MwSt World of Office RPG gt T x 129 00 16 MwSt Preis 139 00 Versandkosten 10 00 zzgl MwSt 16 23 84 Gesamtpreis 172 84 2 4 4 VATs in the shopping cart When an order is concluded and all article data are saved in the database also the used VATs are saved Thus it is prevented that additional changes of the VAT alter already existing and concluded orders In the backend of the shop module the order can still be edited concerning the value added tax afterwards An order with variants and user defined fields can look as follows Shop Module 36 Configuration of the Shop Module Figure 27 VATs in the order overview Sales tax Quantity Title Description Total 1 Gr ner Pullover mit Pullover der Spitzenqualit t mit 32 00 16 00 Logo eingestickte z Das altbekannte Skat Spiel in 25 00 16 00 Skatspiel Klassik verschiedenen A 1 Das altbekannte Skat Spiel in 27 00 16 00 verschiedenen A Variant Blau Skatspiel Blau Tolles Wasser
46. nses This was computed in the template with lt we calculate gt The different forwarding expenses can be acessed by means of the lt we shipping gt tag Following example shows the application of lt we shipping gt lt tr gt lt th gt Preis lt th gt lt td gt lt we sum name totalPrice num_format german gt lt td gt lt tr gt lt tr gt lt th gt Versandkosten lt th gt lt td gt lt we shipping sum totalPrice num_format german gt lt td gt lt we calculate print false sum totalVat1 gt lt we shipping sum totalPrice gt 100 lt we shopVat id 1 gt lt we calculate gt lt tr gt lt tr gt lt th gt zzgl MwSt lt th gt lt td gt lt we sum name totalVatl1 num_format german gt lt td gt lt tr gt lt tr gt lt th gt Gesamtpreis lt th gt lt td gt lt we calculate num_format german gt lt we shipping sum totalPrice num_format german gt lt we sum name totalVat1 gt lt we sum name totalPrice gt lt we calculate gt lt td gt lt tr gt In this example the forwarding expenses are displayed and added to the total expenses In addition the value added tax ofthe forwarding expenses is calculated added up with the other value added tax shares and likewise opened on the whole price Shop Module 38 Configuration of the Shop Module 2 5 2 Forwarding expenses with orders With the order process the valid forwarding exp
47. nts view of a template a list of all suitable fields of the template is displayed which can be marced with a checkbox as active Shop Module 28 Configuration of the Shop Module Figure 19 Variant fields in the template webEdition template shop games boardgames boardgames tmpl Properties I Edit I Information if Preview Variants Variants i Following fields can have the different variants Please select the fields that have the different gt variants Fields articleimage price shopdescription shoptitle Note Variants can only be created for dynamic documents If variant fields are defined in a template all documents which are based on this template have the new tab Variants Here the different variants can be created and maintained The editing of the variants is analogue to the editiong of blocks In addition to the fields defined in the template a field required for the internal use Name is created by which the variant can be called by request we_variant lt NAME gt 2 1 3 Variants in article objects If objects with variants should be used the corresponding filed must be declared at first in the class Analogously to variants with documents a class permits only variants if the fields shoptitle shopdescription and price exist Whether and which fields should be used for variants then can be determined directly at the field administration Also here only picture fields or text fields can be
48. odule type shopliste This attribute lets you use entry fields or select boxes to provide the number of items for ordering In the lt we form gt tag id self can be omitted as omitting information in the id attribute always signifies a link to itself When it is linked to another page id id_of next page must always be included For example lt Begin possible orders gt lt td align center gt lt we showShopItemNumber shopname shopers gt lt we form id id_der_folgeseite type shopliste gt lt input type Text name shop_anzahl gt lt input type submit value abschicken gt lt we form gt lt td align right gt EURO lt we calculate sum waren gt lt we showShopltemNumber shopname shopers gt lt we field name Price gt lt we calculate gt lt td gt lt td gt lt End possible orders gt Standard 4 1 1 October 2006 Designing a template for the Shop Module 53 4 7 Performing calculations webEdition allows you to perform extensive calculations with the lt we calculate gt and lt we sum gt we tags lt we calculate gt offers you all functions that PHP generally offers Addition Subtraction Multiplication Division Nested calculations sqrt Square root lt we sum name your_sum gt adds all individual totals that are defined in the lt we calculate sum your_sum gt tag The following is an example for lt we calculate gt lt we calc
49. on an article the suitable article is opened in the webEdition main window and can be edited immediately The listing itself is tabular with the most important info to the suitable articles including the info whether the respective article has variants The list is sortable by click on the suitable heading The representation corresponds in color usual webEdition rules a not published article document or property is displayed for instance red Click on the card index rider Revenue overview to let indicate the orders of a certain calendar year Also here the listings can be sorted by click on a heading Also here there is a color convention paid up or worked on orders are displayed green Shop Module 18 Shop Module Introduction Figure 6 Artikel Umsatz Ansicht Umsatz bersicht Article documents Article objects I Revenue overview Revenue in the year 2005 Jahr ausw hlen 2005 Monat ausw hlen u i Select Year Order quantity Unprocessed Paid Unpaid Sales total 2005 14 14 0 00 1 877 54 1 877 54 contains VAT 16 189 81 7 13 51 9 11 30 8 6 95 Order amp Article Name Price Date of Order Article ID Paid 11 Pinke Skisocken 7 00 13 10 2005 65 pending webEdition Wasser F 12 Sorsi 17 85 13 10 2005 14 pending 12 Lachen um jeden Preis 15 75 13 10 2005 108 pending 12 Pinke Skisocken 7 00 13 10 2005 65 pending 13 Schach 44 00 13 10 2005 78 pending 13 Toll
50. ories and categoryids be set precedence has always categoryids Within the category Listview the single fields of the category can be displayed as usual with we field The following Keys name of the fields exist e ID or WE_ID ID of the category e Category Name of the category e ParentID ID of the parent category Title or WE_TITLE Title of the category e Description or WE_DESCRIPTION Descriptiontext of the category e Path oder WE_PATH pathe of the category Here too the attribute hyperlink true may be used Then if necessary a hyperlink is placed on the same document with the request variables we_parentid or parentidname Now within the lt we repeat gt tag with the tag lt we ifHasChildren gt can be requested if the actual category folder contains categories From version 3 5 it is possible to create interlocking listviews Here an example for hierarchical listing of categories lt we listview rows 2 type category name outer gt lt we repeat gt lt b gt lt we field name Category hyperlink true gt lt b gt lt br gt lt we field name Title gt lt br gt lt we field name Description gt lt we setVar to global nameto cat from listview namefrom Category gt lt we ifHasChildren gt lt i gt The category has children lt i gt lt br gt lt we ifHasChildren gt lt we listview type document categories cat name inner rows 2 gt lt we ifFound gt lt we repeat gt
51. ping cart e reference Determines wether the free field belongs to an article or shopping cart e shopname Name of the shop being used e type Set the entry field to be created e value preset value e values comma separated list for type choice and select e checked Set the checkbox activated or not Shop Module 32 Configuration of the Shop Module e mode Only for type choice Several values can be selected these are attached comma separated e xml Create input field xhtml valid Depending on reference from we shopField the names of the generated input fields vary With reference article an input field is generated which is added to an article this has the name we_sacf lt name gt These free fields are saved in every article of the shopping cart and can be displayed with we field or we shopfield type print within we listview for the shopping cart lt table gt lt we repeatShopltem shopname demoshop gt lt tr gt lt td gt lt we field name shoptitle hyperlink true gt lt td gt lt td gt lt we field name sort gt lt td gt lt tr gt lt we repeatShopItem gt lt table gt In the order view in the shop module these free fields are visible under the description of the article Figure 22 Freely determinable field in article Edit data of customer within this order Open this customer in customer management module Quantity Title Description Geniessen Sie die fris
52. ription gt lt we keywords gt lt we charset defined ISO 8859 1 gt ISO 8859 1 lt we charset gt lt we css id 10 gt lt head gt lt body gt lt div class content gt lt div class header gt lt we include id 46 gt Shop Module 46 Linking to a payment provider lt div gt lt div class leftNavigation gt lt we include id 11 gt lt we include id 3 gt lt div gt lt div class mainContent gt lt div class fullWidth gt lt div class contentFirstDiv gt lt hl gt saferpay lt h1 gt lt h2 gt powered by webEdition lt h2 gt lt div class divWithPadding gt Der Text sollte noch geschrieben werden lt div gt lt div gt lt div gt lt div class fullWidth gt lt div class border gt lt div class divWithPadding gt lt script src http www saferpay com OpenSaferpayScript js gt lt script gt lt we saferpay shopname demoshop pricename price netprices true usevat true onsuccess 125 onfailure 126 onabortion 127 gt lt div gt lt div gt lt div gt lt div gt lt div gt lt we ifVar name action match success type request gt lt we deleteShop shopname demoshop gt lt we ifVar gt lt body gt lt html gt 3 6 New or extended tags in version 3 5 For Version 3 5 of webEdition new tags have been added as well as existing tags extended to better support the imporived shop functions 3 6
53. sales and the number paid unpaid invoices for that month see Figure 15 Figure 15 Monthly overview Overview Revenue in the year 2005 Jahr auswahlen Monat auswahlen November m Select Year Month Order quantity Unprocessed Paid Unpaid Sales total 2005 11 4 4 0 00 182 39 182 39 contains VAT 16 9 44 8 6 96 Shop Module 24 Shop Module Introduction 1 3 3 2 2 The Order Data view Ifyou click ona specific Shop item listed in one of the monthly directories webEdition will display the processing data for that order on the right side of the screen see Figure 16 Figure 16 Order Data view Order and customer data All customer s orders Order and customer data Order no 8 Order date Processed on Paid on 12 02 05 First name Last name Contact_Address1 Contact_Address2 Contact_Country Michael Tester Teststrasse 5 Teststadt Schweiz Contact_Company Edit data of customer within this order Open this customer in customer management module Description Price Total Quantity Pullover der Spitzenqualitat mit eingestickte Variant Orange 1 Oranger Pullover mit 32 00 32 00 AM Logo _ Das ParagraphenAddOn erweitert WoO World of Variant Paragraphen AddOn ParagraphenAddOn 88 00 88 00 Price 120 00 Shipping and handling Calculate VAT Total price 130 00 F
54. steredUser gt Hello lt we sessionField Last name user name type print gt lt br gt Logged in lt we ifRegisteredUser gt Attribute variables Attributes and variables appear in courier italic typeface For example lt we hidden name attributel gt How to check the document version and issue The information on the title page of this document indicates the version and issue for this publication The version and issue also appear in the footer on every even numbered page The first two digits in the document numbering scheme indicate the version The version number increases each time the document is updated to support a new software release For example the first release of a document is 01 01 In the next software release cycle the first release of the same document is 02 01 The second two digits in the document numbering scheme indicate the issue The issue number increases each time the document is revised and re released in the same software release cycle For example the second release of a document in the same software release cycle is 01 02 Shop Module 12 About this document Customer service For further information about webEdition please consult our Web page or contact our customer service department e Web Page http www webedition biz e E mail Technical support technik living e de Sales sales living e de Information Help info living e de Standard 4 1 1 Octob
55. stview type category 29 we paypal 46 we saferpay 46 we shopVat 34 we tags attribute values 11 we a 52 we addShopitem 50 we calculate 53 we category 30 we createShop 50 we field type shopVat 34 we form 52 we input 49 we listview type category 29 we paypal 46 we saferpay 46 we shopVat 34 we sum 53 we textarea 49 we var type shopVat 34 we writeShopData tag 49 we var type shopVat 34 webEdition documentation suite 9 on line documentation 9 we tags 11 webEdition documentation Customer documentation suite 9 on the World Wide Web 9 Standard 4 1 1 October 2006 57 version and issue 11 Y Year menu changing year 18 Shop Module 58 Standard 4 1 1 October 2006 Shop Module User Guide Standard 4 1 1 October 2006 Printed in Germany 2006 webEdition Software GmbH All rights reserved living e AG Karlsburgstr 2 76227 Karlsruhe Germany Internet http www living e de E mail info living e de c living e AG livi aw cg chro
56. t variants to let adjust special values of an article only by the customer e g sizes or colors of articles The shop operator can determine for these free fields then either values gt make available Select menu or a free input field in which the customer can enter a desired text himself Beside free fields in shop articles the free fields can be also added to an order which are then displayed in the webEdition shop module Thus for instance comments can be saved directly with the order 2 3 1 Freely determinable fields in shop articles With the tag lt we shopField gt input fields can be generated on a shop article page If an article is put in the shopping cart these fields are saved there This is possible for document articles as well as for object articles In addition these free fields are saved in separate fields of the document in the shopping cart to be able to recognize them later again Besides lt we shopField gt generates arbitrary input fields with a certain name If the article together with own fields transmits then with a form to the shopping cart these fields are added to the article It is possible to define arbitrarily many free fields and to save them with the article The destination page of this form must contain the tag lt we createShop gt so that the fields can be created lt we shopField gt has the following parameters e name Name of the field with this name the field is saved in the article shop
57. tle einfach erfrischend Description v Font name w Font size je LA Tu aE b E E tf A Gesundes Wasser f r gesunde Menschen Category Wasser These fields can now be put out with a lt we listview type category gt Thus farther operational areas offer Now beside category names titles heading Id and Parentld can be displayed too With this these informations can also be used with a listview of documents or objects 2 2 2 lt we listview type category gt The tag lt we listview type category gt has been added from version 3 5 With it it is possible to display all entries of a category folder Example lt we listview type category parentid 5 gt Listview for all categories which are in the category folder with id 5 Beyond this it is possible to set the parentId with _REQU EST we_parentid You can determine the name of these request variables for the attribute parentidname by yourself If none is Shop Module 30 Configuration of the Shop Module specified neither as an attribute nor as request a Listview about the Root directory of the categories is created With the attribute categoryids one or several categories can be displayed lt we listview type category categoryids 7 9 gt The attribute categoryids may also be used in a standard istview Then it serves as a substitute for the attribute categories Should categ
58. ts id s Forename gt lt p gt lt p gt lt label for s Surname gt Nachname lt label gt lt we sessionField name Surname type textinput class inputs id s Surname gt lt p gt lt p gt lt label for s Contact_Company gt Firma lt label gt lt we sessionField name Contact_Company type textinput class inputs id s Contact_Company gt lt p gt lt p gt lt label for s ustid gt UST ID lt label gt lt we sessionField name ustid type textinput class inputs id s ustid gt lt p gt lt p gt lt label for s Contact_Address1 gt Strasse lt label gt lt we sessionField name Contact_Address1 type textinput class inputs id s Contact_Address1 gt lt p gt lt p gt lt label for s Contact_Zip gt PLZ lt label gt lt we sessionField name Contact_Zip type textinput class zip id s Contact_Zip gt lt p gt lt p gt lt label for s Contact_Address2 gt Ort lt label gt lt we sessionField name Contact_Address2 type textinput class inputs id s Contact_Address2 gt lt p gt lt p gt lt label for s Contact_Country gt Land lt label gt Shop Module 48 Linking to a payment provider lt we sessionField name Contact_Country type select class select values Deutschland Schweiz sterreich Frankreich Anderes id s Contact_Country gt lt p gt lt p gt lt label for s Contact
59. ulate name endpreis num_format german print on gt lt we session field name artikel_summe gt 1 lt we field name rabattstufel gt 1 lt we field name mwst gt 100 lt we calculate gt The following is a full example showing the use of lt we calculate gt and lt we sum gt lt we createShop shopname shopers gt lt we addDelShopItem shopname shopers gt lt table width 100 border 0 gt lt tr bgcolor silver gt lt td gt Item lt td gt lt td width 50 gt Number lt td gt lt td gt Price lt td gt lt td gt Total price lt td gt lt tr gt lt we repeatShopltem shopname shopers gt lt tr gt lt td class normal bgcolor white gt lt table border 0 gt lt tr gt lt td gt lt we field name Bild type img hyperlink on border 0 height 30 width 30 align top gt lt td gt lt td gt lt b gt lt we field name Artikelname alt we_path hyperlink on gt lt b gt lt br gt lt we field name Description alt we_text max 200 gt lt td gt lt tr gt lt table gt lt td align center gt lt we showShopltemNumber shopname shopers gt lt br gt lt we a id 148 shop on Number 1 gt 1 lt we a gt lt we a id 148 shop on Number 1 gt 1 lt we a gt lt td gt lt td gt lt we field name Price gt lt td gt lt td align right gt EURO lt we calculate sum warenkorb num_format german gt lt we showShopitemNumber shopname
60. ument format PDF on the webEdition documentation Web page On line reference documentation The webEdition customer documentation suite comprises the following books all of which you can obtain at URL http www living e de Standard webEdition documentation The following books support the webEdition Standard suite e The webEdition User Guide e The webEdition Installation Guide e The webEdition Tag Reference Shop Module 10 About this document Documentation for webEdition modules The following books support the webEdition modules e The Customer Management and Customer Management PRO Module User Guide e The Database Object Module User Guide e The Editor PlugIn User Guide e The Newsletter Module User Guide The Scheduler and Scheduler PRO Module User Guide e The Shop Module User Guide e The Task Messaging Module User Guide e The User Management and User Management PRO Module User Guide The Workflow Module User Guide What precautionary messages mean webEdition documents include attention and caution messages which are designed to draw your attention to important instructions Attention boxes An attention box identifies information that is necessary for the proper performance of a specified task For example ATTENTION You must have the appropriate permissions in your user profile to complete this procedure Permissions are assigned to you by your webEdition system administrator Contact your webEdit
61. unt ID by saferpay e Shop Owner The email address deposited in this field is used by Saferpay as a Notify email Message is dispatched to this email in case of an order e allow collect Here can be selected whether Saferpay should permit the collecting of several orders before the realization of the order process with the total sum Standard is a no e additional Form Here can be selected whether Saferpay should generate an additional form to the registration of an address of delivery during the realization of the order process in the terminal Standard is a no e Providerset A comma separated list consisting of Provider IDs to limit the Card types to be used To find out the suitable Provider ID please rightclick in the Saferpay select terminal VT on the suitable Card logo and select Properties Precise information can be gathered from the saferpay documentation e exec path Path to executable command line of saferpay e conf path Path to the configuration files of saferpay e g the directory saferpay in the root directory of the web server e Description A description of the offer which should appear in the Saferpay terminal VT Standard 4 1 1 October 2006 Linking to a payment provider 45 Further informations about Saferpay and its configuration can be found in the Saferpay documentation 3 5 Using Saferpay on your website First of all create a Saferpay button which links on a special Saferpay page
62. urther comments to this order shop_comment Ihre Meinung shop_opinion sehr gut amp The Order Data view has two areas Order and user details and Items ordered You can modify the order data by clicking on the Edit buttons webEdition will open a dialogue box in which you can edit the corresponding values as seen in Figure 17 Figure 17 Editing an order CED sr Standard 4 1 1 October 2006 Shop Module Introduction 25 1 3 3 3 Viewing all of a customer s orders You can view all orders placed by an individual customer by selecting the A Customer 5 Orders tab which is adjacent to the Order Data tab see Figure 18 Thereafter if you click on the underlined item number or date for an order webEdition will open the corresponding Order Data screen for that order Figure 18 Viewing all of a customer s orders Order and customer data All customer s orders All customer s orders webEdition Software GmbH order ordered on processed on payed on 4 order 12 02 05 2 order 12 02 05 1 order 11 02 05 Shop Module 26 Shop Module Introduction Standard 4 1 1 October 2006 27 2 Configuration of the Shop Module In this chapter you find out how you configure the shop module The following items are discussed e Section 2 1 Variants on page 27 e Section 2 2 Product groups by categories on page 29 e Section 2 3 Freely determinable fields on page 31 e Section 2
63. used for variants Figure 20 Variant fields for objects in classe Name shoptitle Type Text input v Length 255 Default Title Description Required field Variant field uses Everybody Add Object variations are analogously edited to document variations Only the preview button is absent here because it depends on the operating range which template should be used for the view Object variations function only if in the template the we tag lt we useShopVariant gt exists Also here the real object is initialized and then when Standard 4 1 1 October 2006 Configuration of the Shop Module 29 required we_variant lt NAME gt overwritten by the data of the variant Likewise lt we useShopVariant gt must be integrated before the first field is displayed 2 2 Product groups by categories Online shops require gradation of the offered articles in product groups In webEdition this can be realized with categories For this pupose the categories were extended with some functions 2 2 1 Advanced category functions Categories can be provided from webEdition 3 5 with a title and description text Select for this the menu item Options gt categories in the webEdition main window see If a category is selected title and description can be edited Figure 21 Kategorie Ansicht Look in Getranke Category Properties Pi Limonade Category Wasser ID 27 Ti
64. webEdition Customer Management PRO Module to be installed You cannot use the Shop Module without the Customer Management Module 1 2 Installation The installation procedure for all modules is described in The webEdition Installation Update and Backup Procedures A pdf version of this guide is available at the following URL http www living e de Shop Module 14 Shop Module Introduction 1 3 General information and navigation After installation you will find a new menu item in the main menu called Modules which contains all the modules in your installation of webEdition see Figure 1 Figure 1 Modules drop down menu Banner Statistics Module Customer Management Database Object Module Newsletter Module Scheduler Shop Task Messaging Module User Management Workflow Module Editor Plug in Module Installation 1 3 1 Shop Module Quickstart Click on Modules gt Shop to open the module summary window containing the Shop Module The Ouickstart screen for the Shop Module opens see Figure 2 Figure 2 The Shop Module start screen with Quickstart eina Hosts Workflow Module Banner Statistics Module Customer Management Export Module Newsletter Module Shop Module Task Messaging Module User Manageme Shop Edit Help Es En z be s New Order No 17 from 2005 11 24 Year 2005 Q 12 December 0 u 11 November 4 a 10 October 8 Shop Module

Download Pdf Manuals

image

Related Search

Related Contents

Unified Meeting® 5 is a web based tool that puts  OMP60 – palpeur optique machine  User`s Guide - XP-420/XP-424 - Epson America, Inc.  CT-4500A CT-4500J  Eurofase 23038-035 Installation Guide  Westinghouse 52-Inch Specification Sheet  Considering Uncertainty in Project Selection Decision Using Crystal  取扱説明書ダウンロード  Fujitsu LIFEBOOK S4545 User's Manual    

Copyright © All rights reserved.
Failed to retrieve file