Reseda E-Shop Manual

Transcription

1 University of Fribourg, Switzerland Department of Computer Science Software Engineering Group Reseda E-Shop Manual Version: 1.0

2 Contents 1 Manual Install Evaluation Overview Installation Configuration Manual Password Passwords Manual Features Overview Storefront Product Catalog Product Info Shopping Basket Account Consulting Order Company Info Contact News Support Storeback Administrator Manager Manual Manager Overview Account Create Account Account Management Consulting

3 4.3.1 Consulting Create Consulting Consulting Management Order Create Order Order Management Manual Administrator Overview Shop Configuration Shop Property Management Locale Management (Language, Country, Currency) Payment, Delivery and Consulting Management Web Resource Management Message Management (Web, PDF) Shop Management Slideshow Management Backup Restore Support Web Resource Management Info Topic Management Company Employee Management Company Management Web Resource Management Job Management Product Catalog HTML Resource Management Category Management Product Field Type Management Product Type Management Product Management Product Price Matrix Management News Web Resource Management News Entry Management Account User Management

4 6 Manual Install Production Overview Installation Java Database (MySQL) JBoss Configuration Database (MySQL) JBoss A Configuration 63 A.1 Configuration: JBoss A.1.1 Server: all, default, minimal A.1.2 Standard EJB A.1.3 Logging A.1.4 Security: JMX Console A.1.5 Security: Web Console A.1.6 Security: JMX-Invoker A.1.7 Security: HTTP-Invoker A.1.8 Security: JMS-Invoker A.1.9 Security: Class Download Service A.1.10 Services: ws4ee A.2 Configuration: Tomcat A.2.1 SSL A.2.2 Ports A.2.3 Various

5 Chapter 1 Manual Install Evaluation 4

6 University of Fribourg, Switzerland Department of Computer Science Software Engineering Group Reseda E-Shop Manual Installation: Evaluation Version Version: 1.0

7 1.1 Overview This manual outlines, how to install and configure the reseda e-shop (res) application for evaluation purpose (including test data). Table 6.1 lists the requirements for this application. Requirement Info Operating System Windows XP Java JDK Version 1.5 (JDK 5) or higher Ports 80 (http), 443 (https), 3336 (mysqld) Table 1.1: Requirements The first section indicates the basic installation and configuration of the required software components. The second part explains the setup specific for the J2EE online shop application. In order to evaluate the application, the accounts and passwords in [Reseda Engineering, 2006e] can be used. Note that no responsibility is taken for the provided software, use at your own risk Installation The evaluation version bundles the Java JDK, J2EE online shop application and the MySQL database server together with the JBoss application server. Everything is already configured. 1. Unzip the zip file to C:/ file: res/res-evaluation.zip 2. This will create a folder res: C:\res -- jboss : J2EE server -- database : Testdata -- java : Java JDK 3. To uninstall the evaluation version, simply delete the created res folder. 6

8 1.3 Configuration The provided evaluation version already is configured, hence no actual setup is required. 1. Start the JBoss server using the run script: JBOSS: bin/run.bat 2. The MySQL database automatically launches on startup of JBoss. 3. Open your browser and go to localhost: URL: 4. Shutdown the server with the shutdown or shutdown.pwd script: JBOSS: bin/shutdown -S -u jboss -p jboss123 JBOSS: bin/shutdown.pwd.bat 7

9 Chapter 2 Manual Password 8

10 University of Fribourg, Switzerland Department of Computer Science Software Engineering Group Reseda E-Shop Manual Passwords Version: 1.0

11 2.1 Passwords type username password user cma cma cma123 user manager manager manager123 user administrator administrator administrator123 user customer customer customer123 Table 2.1: Reseda E-Shop type username password JBoss JMX Console jboss jboss123 JBoss Web Console jboss jboss123 JBoss Shutdown jboss jboss123 Tomcat Keystore keystore keystore123 Table 2.2: JBoss type username password user root root root123 user res res res123 Table 2.3: MySQL 10

12 Chapter 3 Manual Features 11

13 University of Fribourg, Switzerland Department of Computer Science Software Engineering Group Reseda E-Shop Manual Online Shop Features Version: 1.0

14 3.1 Overview This manual describes the features supported by the reseda e-shop. Figure 3.1 shows the available storefront functionalities, which include the product catalog, product info, shopping basket, account, consulting, order, company info, news, contact as well as the support use case. It is recommended to install the evaluation version of the reseda e-shop application (cf. [Reseda Engineering, 2006c]) to try out the features described in this paper 1. Figure 3.1: Storefront Features The focus of this paper is on the storefront functionalities, which are accessible by regular visitor s of the website. All these features can be configured and maintained online without any technological knowledge in the storeback area by users in the Administrator or Manager role. Further information concerning the storeback can be found in the administrator (cf. [Reseda Engineering, 2006a]), manager (cf. [Reseda Engineering, 2006d]), installation (cf. [Reseda Engineering, 2006b] and [Reseda Engineering, 2006c]) manual or in the technical report (cf. [Raess, 2006]) of the project. 1 This installation only consists of unzipping a file and then running the application. 13

15 3.2 Storefront In this section, the storefront features of the reseda e-shop are described. In general, all these functionalities are accessible by a regular visitor of the website. After the login of a user to his account, he further obtains the Customer role and hence also has access to the secured account, consulting and order area Product Catalog The product catalog structures the available products into categories. An unlimited number of such categories can be defined and grouped into parentand sub-categories. Apart from the basic information like title, description and image of a category, additional information in the form of custom html pages as well as image galleries are available. A user can browse this catalog and obtain general information as well as an overview over a category s products. feature hierarchical structure category info html resources image gallery description Category hierarchy as parent- and sub-categories. Basic information like title, description, image. Additional html pages for further information. Additional images in an image gallery. Table 3.1: Product Catalog Product Info The product info is concerned with providing information to a specific product. This includes basic information like name, description and image as well as links to further information and related products (cross-selling). Each product can either be non-customizable or customizable, meaning that in the later case a customer can choose between the offered options. First, the customer obtains an overview over the available options for a product. In the customization, he then can chose from these options and the price is calculated. feature product info html resources image gallery description Basic information like title, description, image. Additional html pages for further information. Additional images in an image gallery. 14

16 product relations options customization pdf files Links to related products (cross-selling). Available options for a product. Price calculated depending on the chosen options. Download of pdf files. Table 3.2: Product Info Shopping Basket A customer can add products he is interested in to the shopping basket. The basket lists all these items together with the quantity, chosen options and price. The shopping basket s content then can either be downloaded as a pdf file, the customer can request a consulting or order the items. feature product items update basket pdf file description Products with their information, price, quantity and options. Delete or add products, set the quantity and comment. Download a pdf file with all information. Table 3.3: Shopping Basket Account Customers can create new accounts or login to their existing ones. The account stores all the customer s data as well as his consultings and orders. All transmissions are secured by ssl encryption. feature description customer data Personal data, address and contact information. consultings Data and status of all consultings. orders Data and status of all orders. s Registration , sending lost password per . ssl All transmissions are encrypted. Table 3.4: Account 15

17 3.2.5 Consulting A customer can request a consulting for products he is interested in. This can either be per , phone call or a consulting meeting. The current status is communicated per as well as listed in the account. feature description company selection Selection of a company to process the consulting. consulting options Selection of a consulting option ( , phone, meeting). pdf file Download of a pdf file with all information. ssl All transmissions are encrypted. s Company and customer receive confirmation s. Table 3.5: Consulting Order Customers have the possibility to make online orders. The current status of an order is visible in the account and also communicated per to the customer. feature description company selection Selection of a company to process the order. payment options Selection of a payment option (Facture, cash). delivery options Selection of a delivery option favoured delivery date. pdf file Download of a pdf file with all information. ssl All transmissions are encrypted. s Company and customer receive confirmation s. Table 3.6: Order Company Info General information concerning the company and their employees as well as slideshows for the products, factory and showroom allow the customer to gain an overall impression of the enterprise. For each company, detailled information like opening hours and directions are provided. In addition, also 16

18 job offers can be published online. feature general information company info slideshows jobs pdf file description General information concerning the company and their employees. Detailed information for each company (e,g, business hours, directions). Slideshows for products, factory and showroom. Job offers. Download of a pdf file with all information. Table 3.7: Company Info Contact Apart from contact information in the form of address, phone, fax and , the customer further can use an or address form to contact the company. feature contact info form address form s description Address, phone, fax, . form to contact a company. Address form to contact a company. Confirmation s to company and customer. Table 3.8: Company Info News News entries allow the company to communicate information to their customers. Apart from the online news, also a newsletter and rss feed are available. feature news entries front page newsletter rss feed description Online news entries. Important news entries on the website s frontpage. Newsletter subscription available. All news as rss feed (formats: atom 0.3, rss 1.0, rss 2.0). Table 3.9: News 17

19 Support In the support area, the customer can find various kinds of information. This includes the general terms, legal notice, faqs and links to other websites. feature general terms legal notice faq links description The general terms of the enterprise. The legal notice of the enterprise. Information in the frequently asked questions. Links to other websites. Table 3.10: Support 18

20 3.3 Storeback The storeback area serves the users in Adminstrator or Manager role to set-up, maintain and manage all features of the online shop. While the Administrator is concerned with the general maintenance of the e-shop, the Manager handles the daily business tasks Administrator A user in the role Administrator has access to all configuration tools for the online shop. All features of the e-shop can easily be edited online without any technological knowledge, as described in the manual [Reseda Engineering, 2006a]. feature shop configuration account catalog product company support news backup description Configuration of all global properties. User management. Management of the product catalog. Product management. Management of company information. Management of the support topics. Management of the news entries, newsletter. Restore the application s resources. Table 3.11: Administrator Manager The Manager s tasks involve the management of the customer s account as well as the processing of online consultings and orders. Further, a Manager can send product information to customers or create consultings and orders for a customer. All these tasks are described in the manual as described in the manual [Reseda Engineering, 2006d]. feature account consulting order description Management of the customer accounts. Management of consulting requests. Management of orders. Table 3.12: Manager 19

21 Chapter 4 Manual Manager 20

22 University of Fribourg, Switzerland Department of Computer Science Software Engineering Group Reseda E-Shop Manual Manager Version: 1.0

23 4.1 Overview This manual describes the manager tasks required to handle the account, consulting and order management of the reseda e-shop (cf. Figure 4.1). In order to access these storeback functionalities, the Manager role is required. Figure 4.1: Manager Tasks For the account, a manager has the possibility to create a new validated customer account or to update an existing one. The consulting then allows to send s with product information to customers, create a new consulting or process an existing online consulting. Likewise, in the order section, a new order for a customer can be created and existing online orders can be treated. 22

24 4.2 Account The account section serves to manage the customers accounts. An account can be created directly by a customer but also by a manager. In both cases, the customer automatically receives an with his login information (cf. Figure 4.2). Figure 4.2: Account If an account is created by a customer, the account first is in state notvalidated, meaning that the information (e.g. address) has not yet been controlled. A manager should set a customer account to state validated only after he checked the corresponding information. This is usually done when a customer either makes an order or requests a consulting. Further, a manager can directly create a new account for a customer, which is immediately in state validated. While it is always possible to update an existing account, an account can only be deleted by an Administrator Create Account A manager can create a new validated account (cf. Figure 4.3 ), and the customer receives his login information (username, password) per . The customer s data (e.g. address) should be checked prior. 1. Select the Create Account page: manager - account - create account 2. Enter the necessary customer data and create the account. 3. The customer receives an with the login data. 23

25 Figure 4.3: Create Account Account Management The account management (cf. Figure 4.4) allows to edit already existing accounts and download the customer s data as a pdf file. Note that it is not possible for a manager to change a customer s username and password, nor is it possible to delete an account. Figure 4.4: Account Management 1. Select the Account Management page: manager - account - account management 2. Find the account either by: lastname, username, find all 3. The matching accounts are listed. 4. Download the pdf or click on edit to update the account. 24

26 4.3 Consulting The consulting section (see Figure 4.5) offers the necessary tools to process a consulting request. In general, a consulting consists of several products a customer is interested in, and he would like to receive more information for these items. A consulting is first in state new, it changes to state checked when the prices are fixed. Figure 4.5: Consulting If a customer creates a consulting, the customer and the selected company first receive a confirmation that the request was created and the consulting is in state new. A manager then checks the consulting and sets the fixed prices, which are then sent per together with an optional comment. In the case of a manager creating a consulting, the fixed prices are sent directly to the customer. Afterwards, the actual consulting has to take place. Depending on the customer s selected option, this can either be a consulting meeting, phone call or . In addition to such a consulting request, a manager can also send product information per to an interested customer Consulting The consulting (cf. Figure 4.6) allows a manager to send product information as a pdf file to an interested customer. This action can take a while depending on the size of the pdf. 25

27 Figure 4.6: Consulting 1. Add the products to the shopping basket. 2. Select the Consulting page: manager - consulting - consulting 3. Enter the customer s address and an optional comment. 4. Subscribe the customer to the newsletter (if he wants to). 5. Send the Create Consulting A manager has the possibility to create a consulting for a customer (cf. Figure 4.7 ). The customer receives an with the corresponding data and can see it in his account. 1. Add the products to the shopping basket. 2. Select the Create Consulting page: manager - consulting - create consulting 3. Find the customer by either: lastname, username, find all 4. Select the correct customer and consulting option. 5. Check the consulting and set the fixed prices. 26

28 Figure 4.7: Create Consulting 6. The consulting is sent to the customer together with an optional comment Consulting Management The consulting management (cf. Figure 4.8) serves to process existing consulting requests. When editing a consulting in state new, the manager needs to set the fixed prices, which are then sent together with an optional comment to the customer. Afterwards, the actual consulting has to take place. In addition, it is possible to download the consulting as a pdf file. Usually, consultings are not deleted (unless it is a fake), as this information can be used for analytical purposes. 1. Select the Consulting Management page: manager - consulting - consulting management 2. Find the consulting either by: id, lastname, status, find all 3. Click on edit to process the consulting or download the pdf. 27

29 Figure 4.8: Consulting Management 4. Check the customer s data (e.g. address), validate the account if required. 5. Set the fixed prices and an optional comment. 6. The customer receives an with the entered data. 7. Prepare the actual consulting (meeting, phone call, ). 28

30 4.4 Order The order section provides the required tools to process an order. An order consists of several products a customer wants to buy. Such an order is initially in state new, it changes to state inprocess when the prices have been fixed. After the products have been produced, the status of the order is set to finished. Figure 4.9: Order When a customer creates a new order, he and the chosen company receive a confirmation . A manager then checks the order and sets the fixed prices, which are sent to the customer per . It is also possible for a manager to directly create an order, where the fixed prices are sent immediately to the customer. The customer is then notified with an when the order is ready for delivery Create Order The create order (cf. Figure 4.10) allows a manager to create a new order for a customer. The customer receives the entered data per and can see it in his account. 1. Add the products to the shopping basket. 2. Select the Create Order page: manager - order - create order 29

31 Figure 4.10: Create Order 3. Find the customer either by: lastname, username, find all 4. Select the customer and order options. 5. Check the order and set the fixed prices. 6. The customer receives the information together with an optional comment Order Management The order management (cf. Figure 4.11) serves to process existing orders. When editing a new order, the manager sets the fixed prices. When the order is ready for delivery, the customer is informed by . Usually, an order is not deleted (unless it is fake), which allows to analyze all orders of a company. 30

32 Figure 4.11: Order Management 1. Select the Order Management page: manager - order - order management 2. Find the order either by: id, lastname, status, find all 3. Select the order to edit or download the pdf. 4. Check the customer s data (e.g. address), validate the account if required. 5. New order: check the order, set the prices. 6. Inprocess order: set the fixed price, set the delivery date. 7. The customer receives the corresponding information per . 31

33 Chapter 5 Manual Administrator 32

34 University of Fribourg, Switzerland Department of Computer Science Software Engineering Group Reseda E-Shop Manual Administrator Version: 1.0

35 5.1 Overview This manual describes the administration tasks required for the set-up and maintenance of the reseda e-shop (cf. Figure 5.1 ). In order to access these storeback functionalities, the Administrator role is required. Figure 5.1: Administrative Tasks For the set-up of the online shop, the shop must first be configured by entering the necessary initial parameters (e.g. mailserver, mail address used). Then, the support information (e.g. general terms, legal notice, faq) as well as the information concerning the companies and their employees should be provided. Having this information entered once, the global product catalog (e.g. categories, product types) needs to be defined, which allows to fill in the individual products. The administrative tasks for maintaining the running online shop then mainly consist in adjusting the product catalog and products as well as entering news entries or sending newsletters. 34

36 5.2 Shop Configuration The shop configuration serves to define the general parameters and settings of the online shop. This includes the main properties of the online shop, the available locales (language, country, currency), the supported payment and consulting options, the translations for the web and pdf messages, the standard s sent by the online shop application and the slideshows Shop Property Management The shop property management allows to set the basic parameters of the online shop. These properties consists of the immutable key and the configurable corresponding value. Table 5.1 lists the properties for , pdf, rss and other parameters together with a short description. key value res.app.mail.smtp.server smtp.domain.com The domain name of the smtp server used to send the online shop s. res.app.mail.sender.address mail@dot.com The address used to send the online shop s. res.app.mail.sender.password pwd The password for the (if authentication is required). res.app.mail.smtp.server.authenticate true false True to authenticate befor sending mails, false otherwise. res.app.mail.send true false True to send the shop s, false otherwise. res.app.newsletter.nohtml Some text. Alternative text for clients not supporting html newsletter s. res.app.order.delivery.cost.estimated Estimated delivery costs in the default currency (e.g. 50). res.app.server.url Base url of the online shop. res.app.pdf.prefix.product company Prefix for the product pdf file name. res.app.pdf.prefix.basket company basket Prefix for the basket pdf file name. res.app.pdf.prefix.order company order Prefix for the order pdf file name. res.app.pdf.prefix.consulting company consulting 35

37 Prefix for the consulting pdf file name. res.app.pdf.prefix.company company Prefix for the company pdf file name. res.app.pdf.prefix.account company account Prefix for the account pdf file name. res.app.pdf.prefix.infotopic company info Prefix for the info topic pdf file name. res.app.pdf.prefix.consulting company product Prefix for the consulting pdf file name. res.app.rss.title company Title attribute for the news rss feed. res.app.rss.link Base url for the rss news feed. res.app.rss.description A description. Description attribute for the news rss feed. res.app.rss.author Author Blabla Author attribute for the news rss feed. res.app.news.nbofentries 10 Number of entries to display in the news. res.app.news.frontpage.nbofentries 5 Number of news entries to display on the frontpage. Table 5.1: Shop Properties Locale Management (Language, Country, Currency) The locale management serves to define the supported languages, countries and currencies of the online shop. While the language defines the available translations of the website s texts and pdfs, the country indicates to which countries a company delivers its products and the currency determines in what currencies a customer can view the product prices. The corresponding locales can be added or removed and a default must be set. For the currency, also a price factor to calculate the product prices needs to be set. Note that when adding an additional language, all corresponding texts (e.g. products, categories, etc.) need to be translated manually. action add description Add the selected locale. 36

38 default remove Set the selected locale as default. Remove the selcted locale. Table 5.2: Locale Management Payment, Delivery and Consulting Management The payment, delivery and consulting management is used to define the supported payment, delivery and consulting options of the online shop as well as the corresponding translations. While it is always possible to add an additional option, the removal is only possible if it is not already used by a customer s consulting or order. action description supported Edit, delete the supported options. new Add a new option. Table 5.3: Payment, Delivery and Consulting Management Web Resource Management The resource management allows to upload any kind of file (image, pdf, etc.) to the server, which can afterwards be embedded in the websites using standard html markup. Note that links should only refer to a blank target, as no url rewriting is applied and hence it could destroy a user s session context if he does not use cookies Message Management (Web, PDF) The management of the web and pdf messages allows to edit all static texts of the website and the generated pdf files. An immutable key identifies the message together with a key for the corresponding language (e.g. de, en), while its value is the text displayed to the user for the given language. attribute html tags key translation description The available html tags. Unique key identifying the message. Translation of the corresponding text. 37

39 Table 5.4: Message Management Shop Management The translations for the subject and content of all s sent by the online shop can be defined in the shop management. It is a good practice to use a common prefix (e.g. [resedahome]), which allows customers to easily identify s sent by a company. attribute description translation: subject Translation of the subject. translation: message Translation of the message. Table 5.5: Shop Management type registration lostpassword orderconfirmation orderinprocess orderfinished consultingconfirmation consultingchecked consulting newslettersubscribe newsletterunsubscribe description Sent to customer after he has created a new account. Sent to customer if he requests his login information. Sent to customer and company to confirm a new order. Sent to customer and company to inform that the order is now processed. Sent to customer and company to indicate that the order is finished. Sent to customer and company to confirm a new consulting. Sent to customer and company to indicate that the consulting is controlled. sent to customer after a consulting by a manager. Sent to customer to verify his newsletter subscription. Sent to customer to verify the unsubscription from the newsletter. 38

40 newsletter Subject is used as the prefix for a newsletter s subject, and the message as an appendix to every newsletter. Table 5.6: Shop Types Slideshow Management In the slideshow management (products, factory and showroom), their properties can be set and the corresponding images uploaded, changed or deleted. attribute property: width property: height property: pause image: sl description Common width of the images. Common height of the images. Pause in ms inbetween images. Image for the slideshow. Table 5.7: Slideshow Management Backup Restore All information (including images, etc.) of the reseda e-shop is stored in the database, and hence only a backup of the database is required to save all the application s data. Note that the online shop application itself does not offer any backup functionalities, as this can be easily set up with other tools like the MySQL Administrator. It is recommended to configure an automatic backup routine. Having these backups, the content and resources of the online shop can be restored anytime. 1. Restore the database content (e.g. using the MySQL Administrator) from a backup. 2. Push the restore button to recreate the application s resources and reset the cache. 39

41 5.3 Support Information like the general terms, legal-notice or frequently asked questions (faq) and links to other websites are defined in the support section. Note that it is not possible to delete the general terms and legal notice Web Resource Management See Info Topic Management The info topic management allows to edit the general terms and legal notice. Further, an unlimited number of faq s and links can be defined. Each info topic consists of an info topic title and one ore more info items. The support resources can be integrated by using standard html markup. attribute description html tags The available html tags. support resources The previously uploaded resources. property: info topic The identifier for the info topic. property: order by The relative order of the info topic. translation: info topic Translation of the info topic title. info items The items of the topic (e.g. the individual links or faq questions). Table 5.8: Info Topic Management 40

42 5.4 Company Here, information concerning the companies and their employees is provided Employee Management For each employee, information like name, description and address needs to be entered. See Table 5.9 for the required attributes. attribute property: employee name property: display property: order by translation: name translation: description image: em description Identifier for the employee. The employees address as displayed on the web site (e.g use: employee AT company.com). The relative order of the employee. Translation of the employee name. Translation of the employee description. Image of the employee. Table 5.9: Employee Management Company Management Here, the necessary information concerning the individual companies is provided, as listed in Table attribute property: company name property: display property: company type property: online order property: online consulting property: order by translation: name description Identifier for the company. The address as displayed on the web site (e.g use: info AT company.com). The type of the company. Yes if it processes online orders, no otherwise. Yes if it processes online consultings, no otherwise. The relative order of the company. Translation of the company name. 41

43 translation: description Translation of the company description. translation: business hours Translation of the company business hours. translation: directions Translation of the company directions. employees The employees associated to the company. address The address of the company. phone Phone and fax number. The addresses for contact, consulting and order. image: co Image for the company. image: cm Image for the map. image: cp Image for the pdf map (resolution 300dpi). Table 5.10: Company Management Web Resource Management See Job Management To add job offers to the website, the information listed in Table 5.11 must be provided. attribute description html tags The available html tags. property: title Identifier for the job. property: order by The relative order of the job. translation: title Translation of the job title. translation: description Translation of the job description. Table 5.11: Job Management 42

44 5.5 Product Catalog In order to define the available products of the online shop, the product catalog needs to be set-up first. This includes defining the categories, the product field types and product types. Afterwards, the products and their information can be entered. Figure 5.2 outlines the involved items and their relation. Figure 5.2: Product Catalog The categories are used to set up the hierarchical structure of the catalog. Each category (e.g. tables) is a subcategory of the root category or another already defined category (e.g. furniture). The product field types (e.g. woodspecies) and product types (e.g. table) then serve as a generic definition for the products. A product field type has one (non-customizable) or more (customizable) default values associated. A product type has an arbitrary number of such product field types associated. Each product is initialized with the information defined in a product type and its product field types and default values. But the created concrete product, product fields and values are independent of the type and hence it is possible to adjust them for each product individually. Further, it is also possible to add or remove product fields or values for each product. Basically, these types only avoid entering input common for some products (e.g. woodspecies, length of tables). Each product then belongs to one or more categories, and a product can have a relation to other products (e.g. 43

45 matching chairs for a table). In addition, a product or category can also have a html resource associated, which provides additional information (e.g. information concerning woodspecies) HTML Resource Management The html resource managements allows to upload custom html files used for additional category or product information (e.g. information concerning the wood types of furniture). Standard html files (e.g. created in Dreamweaver) are first packed together in a zip file, and then uploaded to the server together with the path to the root document and a description. The required attributes are described in Table attribute description property: resource name Identifier for the html resource. translation: link description Translation for the link description. resource: base url Path to the root document (e.g. wood/wood.htm). resource: upload Zip file containing the html pages. Table 5.12: HTML Resource Management Category Management In the category management, the hierarchical structure of the product catalog as well as the individual categories are defined. Each category is a sub category of exactly one parent category. For a category, it is possible to create an image gallery by uploading the corresponding images. Further attributes are listed in Table attribute property: category name property: parent category property: order by translation: name translation: description resources html translation: description description Identifier for the category. The parent category. The relative order of the category. Translation for the category name. Translation for the category description. Additional information for a category. Translation for the category description. 44

46 image: ca image: ci Required category image. Images for an image gallery. Table 5.13: Category Management Product Field Type Management A product field type is a generic description of a product field with one or more default values, which is used to initialize the corresponding product field and values of a concrete product. If required, these values can afterwards be adjusted for each individual product. If a product field type is customizable, an unlimited number of default product field values can be added, whereas for a non-customizable field type, there is exactly one default value. The required parameters can be found in Table attribute property: productfieldtype name property: order by property: customizable description Identifier for the product field type. The relative order of the field type. Yes for a customizable field, no otherwise. Translation for the product field type name. Default values for the field type consisting of a value property and its translation. Table 5.14: Product Field Type Management translation: productfieldtype name product field type values Product Type Management A product type is a generic definition of a certain kind of product (e.g. tables). Each product type defines the corresponding standard product field types, the html resources and a pdf comment. The product type then serves to initialize the attributes of a product, but all values can be adjusted for an individual product. attribute property: producttype name description Identifier for the product type. 45

47 property: customizable Yes for a customizable type, no otherwise. translation: pdf commente Translation for the pdf comment. product field types Standard field types for the kind of product. resources html Additional information for a product. Table 5.15: Product Type Management 46

48 5.6 Product Management The product management is used to enter the required information for the products offered in the online shop. Each product is an instance of a product type, which initializes the product and its product field and values with the default values. But all these values can be adjusted individually for a product. One can distinguish between customizable and non-customizable products, as seen in Figure 5.3 (remind that this distinction actually already is defined in the product type). Figure 5.3: Product Management A non-customizable product has a fixed price and does not allow the customer to choose the values of the product fields. Hence, each product field has exactly one value. In contrast, a customizable product has in addition to these non-customizable product fields (used for the overview) other product fields with several values associated (used for the customization). As an example, a product table could have a non-customizable product field lengths with the value 100cm - 200cm and the corresponding customizable product field length with the values 100cm, 110cm,..., 200cm. The price of such a customizable product depends on the values chosen by the customer. These prices are defined in the so called price matrix. To enter the values for this matrix, xml as well as an excel upload is provided. Note that in the 47

49 storefront, the product field values of a customizable product can only be chosen after the required product price matrix was defined Product The product management allows to enter the basic attributes of a product, as listed in Table Apart from the required attributes, each product belongs to one or more categories and can have additional html resources or relations associated. attribute description property: product name Identifier for the product. property: customizable Yes for a customizable product, no otherwise. property: price Price for a non-customizable product. property: available Yes if available in the online shop, no if no further offered. property: order by The relative order of a product in the category. translation: name Translation for the product name. translation: description Translation for the product description. translation: comment Translation for the optional product comment. translation: pdf comment Translation for the product pdf comment. categories The categories a product belongs to. product fields The product fields of the product. product relations Relation to another product (with relation name and description translation). image: ps Small product image. image: pl Large product image. image: pp PDF product image (resolution: 300dpi). image: pa Additional product image. Table 5.16: Product Management 48

50 5.6.2 Price Matrix Management For a customizable product, the price matrix defines the corresponding price as a function of the selected product field value. First, the structure of the matrix is initialized by setting the x-columns and y-rows. The order of this definition defines the structure of the price matrix. The values of the price matrix cells are entered in the second step. The defined matrix can first be downloaded either as a xml or excel file. After having entered the values, the xml or excel file is uploaded and the price matrix is filled with these values. attribute description available product fields The customizable fields which can be used in the matrix. matrix column x fields The defined columns of the matrix (note the order). matrix row y fields The defined rows of the matrix (note the order). Table 5.17: Define Product Price Matrix attribute description xml: schema XML schema (structure) of the price matrix. xml: xml The xml file for upload. xml: upload Uploads the file. xml: download Downloads the file. excel: excel The excel file for upload. excel: round upload Yes to round prices to the next integer. excel: upload without value Yes if the excel file contains the product names field value names, no otherwise. xml: upload Uploads the file. xml: download Downloads the file. Table 5.18: Edit Product Price Matrix 49

51 5.7 News In the news management, the news entries as well as the newsletter is managed. All news entries are displayed on the online shop s news page and also automatically added to the news rss feeds. In addition, a news entry marked as front page appears also on the front page of the website. Concerning the newsletter, each defined news entry can be sent as a html mail to the subscribed customers Web Resource Management See News Entry Management The news entry management allows to edit and create news topics. required attributes can be seen in Table The attribute description html tags The available html tags. support resources The previously uploaded resources. property: title The identifier for the news entry. property: link Link to the news entry (or just to the base url). property: front page Yes if the news entry should appear on the websites front page. translation: title Translation of the news entry title. This is used as the subject for a newsletter. translation: content Translation of the news entry title. This is used as the message for a newsletter. Table 5.19: News Entry Management 50

52 5.8 Account The account management allows to manage the user accounts of the online shop. But this requires that the corresponding accounts already have been created User Management In the user management, an administrator can delete an existing user or change its permission by assigning or removing the corresponding roles. Currently, three different roles with corresponding privileges are available, as described in Table role Customer Manager Administrator privileges Default, access to the account. Access to the storeback account, order and consulting management of the assigned company. Access to the online shop administration. Table 5.20: User Roles A user can have more than one role assigned, for example Manager and Customer. In addition, for the Manager role also an already defined company needs to be selected. The corresponding user is then only granted access to the orders and consultings of the assigned company. 51

53 Chapter 6 Manual Install Production 52

54 University of Fribourg, Switzerland Department of Computer Science Software Engineering Group Reseda E-Shop Manual Installation: Production Environment Version: 1.0

55 6.1 Overview This manual outlines how to install and configure the reseda e-shop application with the required software components in a production environment. Table 6.1 lists the requirements for this application. Requirement Operating System Info Windows XP, Linux (tested on Gentoo, CentOS 3.4) Version 1.5 (JDK 5) or higher Version 4.1 or higher Version or higher Java JDK MySQL Database JBoss Application Server Ports 80 (http), 443 (https), 3306 (mysql) Table 6.1: Requirements The first part then explains the basic installation and configuration of the required software components. But the outlined parameters in this manual only provide for a basic configuration, which should be adjusted according to your needs. The corresponding information and manuals can be found on the vendor s websites (cf. [Java, 2006], [MySQL, 2006], [JBoss, 2006]). Users who do not want to be bothered with the basic configuration can simply use the preconfigured software components. Note that no responsibility is taken either for the indicated installation nor the preconfigured software - use at your own risk... The second part then explains the setup specific for the J2EE online shop application in a production environment. In addition to the configuration and setup of the database and JBoss / Tomcat, usually also other linux applications need to be installed. This includes e.g. installing a minimal firewall (iptables), domain name server (dns) and server. 6.2 Installation This section outlines the installation of Java, the MySQL database and JBoss Java In order to run the J2EE application server, Sun s JDK 1.5 (JDK 5) is required. You can check if you already have installed the required version by 54

56 the command line java version. If you receive an error, have an insufficient version or do not have the JDK installed, proceed as follows: 1. Download Java: URL: 2. Install according to Sun s instructions. 3. Set the JAVA HOME environment variable to point to your JDK installation Database (MySQL) The reseda e-shop application stores all its data in a relational database. Currently, only sql scripts for the MySQL database are provided. The application has been developed and tested using MySQL 4.1 Community Edition. For a production environment, you may want to install the MySQL Administrator and MySQL Query Browser for the database management. MySQL Database Server In order to install MySQL, you can simply use the vendor s installer for your operating system. Note that on Linux, it is recommended to run the mysql server as a separate user (e.g. mysql) for security reasons. 1. Download the MySQL db server: URL: 2. Standard installation according to the manual. 3. Adjust the Parameters: max allowed packet=16m MySQL Administrator 1. Download the MySQL Administrator: URL: 2. Use the provided installer. 55

57 MySQL Query Browser 1. Download the MySQL Query Browser: URL: 2. Use the provided installer JBoss Concerning JBoss, this application server is higly configurable to the user s specific needs. The adjustment of the parameters and options require a good understanding of J2EE and should hence by done by an expertised administrator. Users how do not want to do this configuration on their own can use the corresponding preconfigured JBoss versions. Note that for an installation under Linux in a production environment, it is recommended to create a new user account specific for JBoss (e.g. a user named jboss). Further, the JBoss server should not be run as root (as this is a potential security risk), but the drawback is that normal users are not allowed to open ports below 1024 (e.g. port 80 for http). A solution is to either use mod jk, mod proxy or port forwarding 1. In the first two cases, a standard web server like Apache (starts as root to open the port, switches context to a normal user afterwards) forwards all requests to JBoss, while the approach in the third case consists in configuring the firewall to forward all packets from port 80 / 443 to the JBoss defaults 8080 / Note that this install manual does not explain the configuration of JBoss for neither of the three solutions. Instead, JBoss is set up to run on port 80 and hence requires root privileges to start. JBoss - Preconfigured Version The provided preconfigured version of JBoss contains the configuration outlined in the appendix A.1 and A Unzip the preconfigured files to a folder without any spaces in its path: file: software/jboss/jboss preconfigured.zip 2. Adjust the configuration to your needs. 1 Described in the JBoss Wiki: JBossOnPort80. 56