Sign Off and Date: Sign Off and Date: 17/11/2008. Approved by: Zuzana MAZANOVA Emilio CASTRILLEJO

Transcription

1 Public e-procurement: Common Technical Specifications elaboration using State of the Art and Learning Demonstrators Framework Contract ENTR/01/58-TOOLS DG ENTR Updated Dynamic Demonstrators Installation Manual Version /11/2008 Updated version in the context of Specific Contract No7 under Framework Agreement Written by: Emmanuil PITAROKILIS Haralampos SAVVIDIS George VALASSOPOULOS Harry VRAZOPOULOS Sign Off and Date: 17/11/2008 Approved by: Zuzana MAZANOVA Emilio CASTRILLEJO Sign Off and Date: EUROPEAN DYNAMICS Approved by: Nikitas TSOPELAS EUROPEAN DYNAMICS Sign Off and Date: 17/11/2008

2 Disclaimer The views expressed in this document are purely those of the writer and may not, in any circumstances, be interpreted as stating an official position of the. The does not guarantee the accuracy of the information included in this study, nor does it accept any responsibility for any use thereof. Reference herein to any specific products, specifications, process, or service by trade name, trademark, manufacturer, or otherwise, does not necessarily constitute or imply its endorsement, recommendation, or favouring by the. All care has been taken by the author to ensure that he has obtained, where necessary, permission to use any parts of manuscripts including illustrations, maps, and graphs, on which intellectual property rights already exist from the titular holder(s) of such rights or from his or their legal representative. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 2 of 29

3 Modification History Date Version Author Reason for modification 05/11/ Emmanuil PITAROKILIS George VALASSOPOULOS Nikitas TSOPELAS Initial Release 18/04/ Emmanuil PITAROKILIS George VALASSOPOULOS Nikitas TSOPELAS 17/11/ Emmanuil PITAROKILIS Haralambos SAVVIDIS George VALASSOPOULOS Harry VRAZOPOULOS Accommodated feedback from DG MARKT. Updated to describe installation process for all dynamic demonstrators Updated installation instructions in order to reflect the modifications performed in the context of Specific Contract No 7 under Framework Agreement 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 3 of 29

4 Table of Contents 1 INTRODUCTION BEFORE STARTING System Requirements Required Software Java 5 SDK MySQL-HSQL Relational Databases INSTALLATION PROCEDURE Introduction Running the installation wizard Step 1 - Select language Step 2 Welcome page Step 3 Legal notice Step 4 Installation packages Step 5 Installation location Step 6 Database Server connection Step 7 Database connection Step 8 Complete User Input confirmation Step 9 Configuration of Application and Database Server Step 10 Creation of shortcuts Step 10 Creation of shortcuts on unsupported Platforms Step 11 Installation finish and Automatic Installation Script STARTING AND STOPPING THE DEMONSTRATORS Starting the Demonstrators Starting the application server Using the Demonstrators Stopping the Demonstrators Stopping the application server UNINSTALLING THE DEMONSTRATORS Erasing the database schema (MySQL) Removing application components CONTACT DETAILS /11/2008 Updated Dynamic Demonstrators Installation Manual Page 4 of 29

5 1 INTRODUCTION The current document complements the installation package of the IDABC eprocurement Dynamic Demonstrators, and provides information on how to install the package, as well as, uninstall it. The document comprises the following chapters: Before Starting: information regarding the system requirements and necessary software, before starting the installation wizard Installation procedure: detailed explanation of the installation process through the installation wizard Starting and stopping the demonstrators: information on how to start, access and stop the IDABC eprocurement Dynamic Demonstrators Uninstalling the demonstrators: information on how the IDABC eprocurement Dynamic Demonstrators can be uninstalled from a system Contact details: information on the procedure for obtaining assistance if any problems occur when installing, operating and/or uninstalling the demonstrators. 2 BEFORE STARTING The current section outlines the prerequisites in order to initiate and successfully complete the installation of the IDABC eprocurement Dynamic Demonstrators. Before continuing with the installation, it is highly recommended to ensure that the following prerequisites are satisfied: You have reviewed the installation procedure described in this installation manual. No other application is running during the installation. You have administrator access rights in order to install the application. You have read/write access to the file system where the application is going to be installed. The system satisfies the minimum software and hardware requirements. WARNING: Failing to satisfy any of the above conditions may cause the installation and/or running of the IDABC Demonstrators to not function smoothly. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 5 of 29

6 2.1 System Requirements The IDABC eprocurement Dynamic Demonstrators can be installed in an IT environment, satisfying the following hardware specifications. Minimum Intel Requirements CPU: Intel compatible 2GHz RAM: at least 512MB Available disk space: at least 1GB Recommended Intel Requirements CPU: Intel compatible 3GHz RAM: at least 1GB Available disk space: at least 1GB Minimum Sparc Requirements CPU: UltraSparc RAM: at least 512MB Available disk space: at least 1GB Recommended Sparc Requirements CPU: UltraSparc RAM: at least 1GB Available disk space: at least 1GB INFO: On the Sun platform the IDABC eprocurement Dynamic Demonstrators are successfully tested on a Sun Fire v240 server. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 6 of 29

7 2.2 Required Software The IDABC eprocurement Dynamic Demonstrators are written in the Java programming language. It utilises a MySQL RDBMS (Relational Database Management System) or a Hypersonic (HSQL) database and the JBoss application server to operate efficiently and reliably. The system was developed and tested in the following operating systems: Microsoft Windows 2000 Professional Redhat Linux 9 Sun Solaris 9 To install and use the demonstrators, the following software packages are required: Java 5 SDK The IDABC eprocurement Dynamic Demonstrators and the installation program are written in the Java programming language. They require an installed Java 5 SDK version 1.5.0_07-b03 in order to be executed. Java 1.5 should be installed on the system, in order to initiate the IDABC eprocurement Dynamic Demonstrators installation procedure. The Java 5 SDK is available as a free download from the Java website. For more information regarding the installation of a Java 5 SDK, please visit the Java website at After the Java SDK installation, the JAVA_HOME environment variable must be set properly. If you are on the windows platform, simply right-click on the My Computer Desktop icon, then click on Properties (see image on the left). On the popup window, select the last tab Advanced then click on the Environment Variables button (see image on the right). 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 7 of 29

8 On the next screen, under System Variables the JAVA_HOME variable must be set. If it exists, select and click Edit otherwise click New. On the small popup make sure you give the right path for you Java 5 SDK installation directory: To test your JDK installation you can open a command prompt (Start Programs Accessories Command prompt) and issue the following commands: 1. echo %JAVA_HOME% E:\jdk1.5.0_07 2. java version java version "1.5.0_07" Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_07-b03) Java HotSpot(TM) Client VM (build 1.5.0_07-b03, mixed mode, sharing) WARNING: In case the output of the above commands is different, then there is a possibility, that more than one JDKs are installed in the system. If any of them corresponds to an older version of the VM then problems may be encountered during installation and/or running of the IDABC eprocurement Dynamic Demonstrators. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 8 of 29

9 2.2.2 MySQL-HSQL Relational Databases The IDABC eprocurement Dynamic Demonstrators uses as transactional persistence any of the below databases: MySQL Server RDBMS (Relational Database Management System) version 5.0. To install the demonstrators, the MySQL database server must be properly installed into the system and properly support UTF-8 enabled databases. The MySQL database server is available as a free download from the MySQL website. Information about installing and configuring the MySQL database server is available at the MySQL.com website at HSQL 1.8. The HSQL database ships as an embedded database with the IDABC eprocurement Dynamic Demonstrators installation package so no additional actions are required for installation or manual configuration. The user can select which one of the above databases will be used during the software's installation. 3 INSTALLATION PROCEDURE This section follows a step-by-step walkthrough, detailing the installation procedure of the IDABC eprocurement Dynamic Demonstrators. 3.1 Introduction In order to successfully complete the IDABC eprocurement Dynamic Demonstrators installation procedure, the target IT environment must satisfy the minimum hardware requirements, as well as, already have installed and configured the prerequisite software described above. Section 2 provides information regarding the minimum hardware requirements and prerequisite software. This walkthrough below describes the installation of the IDABC eprocurement Dynamic Demonstrators in a Microsoft Windows environment. These installation instructions also apply, with minor system specific changes, to all other supported operating systems. 3.2 Running the installation wizard Note: To run the installation wizard, the Java 5 SDK must be installed in the target system. Locate the directory where the installation package is stored in the target system and double click on it, to start the installation wizard. The name of the package is: eprocurement-install.jar. Users can double click on the filename of the installation wizard in order to start it. It is possible that java executables (files with jar extension) are not associated with Java 5 SDK. In such case the installation wizard will not start. To overcome this issue, users can start the installation wizard manually, using command line. The java executable must be defined in the system path, which in most cases should be in place by default when installing the Java 5 SDK. Using command line, users must locate the directory where the demonstrators installation package is stored and run the following command: java jar eprocurement-install.jar 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 9 of 29

10 3.2.1 Step 1 - Select language The installation wizard prompts for a language selection. Choose your language and click OK Step 2 Welcome page A welcome screen is displayed. Click Next to continue. INFO: You can abort the installation procedure at any time by using the Quit button. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 10 of 29

11 3.2.3 Step 3 Legal notice The legal notice of the IDABC eprocurement Dynamic Demonstrators appears. Users are required to carefully read the legal notice before continuing. By selecting the "I accept" radio button the Next buttonis enabled and allow users to proceed with the installation as presented in this page. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 11 of 29

12 3.2.4 Step 4 Installation packages The package selection screen displays all available packages included in the wizard: the application server (JBoss), the IDABC eprocurement Dynamic Demonstrators, the uninstall launcher script and the available documentation (optional). The user can select/deselect any optional packages and then click Next to proceed with the installation procedure. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 12 of 29

13 3.2.5 Step 5 Installation location Users are prompted to specify the directory where the IDABC eprocurement server and Dynamic Demonstrators will be installed in the system. The default directory is C:\IDABCeProcurement, which can be changed by users. Once the directory is specified, users may proceed with the installation by clicking the Next button. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 13 of 29

14 3.2.6 Step 6 Database Server connection As mentioned in section 2, the installation of the IDABC eprocurement Dynamic Demonstrators can be configured to use either an available MySQL database server or the embedded HSQL database server. In case the HSQL database is selected, then no further input is required. By clicking Next the wizard will proceed to Step 8 Complete User Input confirmation. In case the MySQL database is selected, then the user needs to take into account the following considerations. Before proceeding with the installation of the IDABC eprocurement Dynamic Demonstrators, users need to confirm that the MySQL database server is installed, configured and currently running. On Windows systems, users can verify whether the MySQL database server is running by observing the WinMySqlAdmin icon in the System Tray; a green light indicates the server is running. The user may confirm that the MySQL is installed, configured and running, by clicking the Next button. In order to correctly install the IDABC eprocurement Dynamic Demonstrators, the installation wizard needs to obtain access to the MySQL database server. Users are prompted to input the username and the password of a MySQL Administrative Account, along with the connection details. The installation wizard fills these fields with the default MySQL installation values. If the default MySQL configuration is not altered, the password field must be ignored and remain empty. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 14 of 29

15 WARNING: If any of the fields are filled in incorrectly, the installation will not complete successfully. At a later screen, the wizard will attempt to connect to the MySQL database server to create the database schema for the IDABC eprocurement Dynamic Demonstrators. If this connection fails, the wizard will inform the user of the error and the installation will be terminated unsuccessfully. If the user chooses to continue anyway, the installation will not be completed successfully and the IDABC eprocurement Dynamic Demonstrators, although installed, will not be able to run. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 15 of 29

16 3.2.7 Step 7 Database connection This step prompts users to enter the database name and account details to be used by the IDABC eprocurement Dynamic Demonstrators. Those may exist by a previous installation; however, the installer will (re)create the user and database if the user checks User does not exist, create it and Database does not exist, create it checkboxes respectively. WARNING: If the IDABC eprocurement Dynamic Demonstrators database or the necessary user do not exist, and the user un-checks the relevant User does not exist, create it or Database does not exist, create it options, the installation procedure will not complete successfully and will terminate with an error if the user chooses not to continue. If the user chooses to continue anyway, the installation will not be completed successfully and the IDABC eprocurement Dynamic Demonstrators, although installed, will not be able to run. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 16 of 29

17 Step 8 Complete User Input confirmation Following the completion of all previous steps, the wizard will inform users that all user input is complete. The actual installation can begin by clicking Next. Nothing has been written to the system yet, so users have a final opportunity to access the previous pages to verify the information provided. During this phase of the installation process, the wizard copies the required files onto the system. Users can review the progress of the installation. Once all necessary files are copied, the Next button will be enabled, allowing users to proceed with the installation of the IDABC eprocurement Dynamic Demonstrators. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 17 of 29

18 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 18 of 29

19 3.2.8 Step 9 Configuration of Application and Database Server Immediately after copying all necessary files, the wizard will automatically configure the JBoss Application Server and, according to user input, create the application database and account in MySQL or HSQL Database Server. Once this process is finished, the Next button will be enabled, allowing users to proceed with the installation. INFO: To verify that the configuration of the JBoss Application Server and the necessary database actions are completed successfully, users can scroll to the bottom of the text output and ensure that the BUILD SUCCESSFUL message appears. In case the BUILD SUCCESSFUL message is not present, then there was an error during the configuration. NOTE:The output of the above script might be different depending on the database server selection. However in both cases the " BUILD SUCCESSFUL" message needs to be present to confirm a successful installation. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 19 of 29

20 3.2.9 Step 10 Creation of shortcuts Once the configuration is completed successfully, users may specify what shortcuts to create for the IDABC eprocurement Dynamic Demonstrators. Users may specify an appropriate program group; otherwise the default group will be used. Furthermore, users can select whether the shortcuts will be created for all users of the system, or only for the current user. This can be set by the all users option. Please note that only an administrator can create shortcuts for all users of a system. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 20 of 29

21 Step 10 Creation of shortcuts on unsupported Platforms Shortcuts are only supported in Windows Platforms and Linux platforms. If the target operating system does not support the creation of shortcuts i.e. Macintosh OS then this screen will be skipped. In that case users can find below the related scripts as long with their locations tha tneed to be used to operate the demonstrators. Wherever it is mentioned, <INSTALL>, represents the folder the user has selected to install the application. <INSTALL>/idabceproc/jboss/bin/run.sh: starts the JBoss Application Server <INSTALL>/idabceproc/jboss/bin/shutdown.sh: stops the JBoss Application Server NOTE: when invoked by the command line, the argument S needs to be specified i.e../shutdown -S <INSTALL>/idabceproc/index.html can be used to point a browser to the IDABC eprocurement Dynamic Demonstrators home page. <INSTALL>/Uninstaller/runUninstall.sh: Invokes the wizard for uninstallation 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 21 of 29

22 Step 11 Installation finish and Automatic Installation Script Following the creation of shortcuts, the installation of the IDABC eprocurement Dynamic Demonstrators is completed successfully. It is expected that users may need to install the application to multiple machines with identical configuration. To automate this process, the installer offers the option of an automated installation script based on the user input created during this installation procedure. This can be useful if users intend to install the IDABC eprocurement Dynamic Demonstrators in multiple systems using the same configuration. In order to generate this automated installation script, one may click on Generate an automated installation script. To install the IDABC eprocurement Dynamic Demonstrators using an automated installation script, a user must user the following command: java eprocurement-install.jar automated-install.xml In the above command it is assumed that the java executable is in the system path and that the IDABC eprocurement installation package (eprocurement-install.jar) and that the automated installation script stored with the name automated-install.xml under the C:\IDABC_Installer directory. To complete the installation, users simply click Done. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 22 of 29

23 4 STARTING AND STOPPING THE DEMONSTRATORS This chapter provides the required information for starting and stopping the IDABC eprocurement Dynamic Demonstrators. 4.1 Starting the Demonstrators The IDABC eprocurement Dynamic Demonstrators run inside the JBoss J2EE Application Server which must be started prior to viewing the demonstrators. When starting the JBoss application server, JBoss will automatically detect the already deployed IDABC eprocurement Dynamic Demonstrators and run them. WARNING: The IDABC eprocurement Dynamic Demonstrators use the MySQL or HSQL database server as their transactional persistent store. In case a MySQL database was selected and configured during the installation, then the database must also be running in order to successfully start the IDABC eprocurement Dynamic Demonstrators Starting the application server Starting the application server is a fully automated process. During installation, the installation wizard has created all the shortcuts required for initiating this process. In the example used in the current manual, a program group named "IDABC eprocurement-hsql" was used. As demonstrated in the following image, users may start the JBoss application server by following the path to Start > Programs > IDABC eprocurement and click on Start IDABC Application Server. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 23 of 29

24 Once the process for starting the JBoss application server is started, a command prompt window titled Start IDABC Application Server appears. This window is used by the JBoss application server in order to output information about its running environment and operation. Depending on the environment of the system, this window may start minimised. If it does not, users may minimise it, but do not close it. Closing this window will close the JBoss application server, and consequently the IDABC eprocurement Dynamic Demonstrators. WARNING: Closing the output window of the JBoss application server will close the application server and hence will also terminate the IDABC eprocurement Dynamic Demonstrators. The above procedure is all a user needs to know in order to start the IDABC eprocurement Dynamic Demonstrators. INFO: Starting the IDABC eprocurement Dynamic Demonstrators is a procedure consuming significant system resources. As a consequence, users must wait for a while before the demonstrators completely starts up and become usable. The time required for a complete start up depends on the system used. In a system with a CPU Intel Pentium 4 3.5GHz and 512MB of RAM the systems takes about 52 seconds to start up. The user can determine if the IDABC eprocurement Dynamic Demonstrators have been started by verifying that the server output window messages have stopped Using the Demonstrators To use the IDABC eprocurement Dynamic Demonstrators users can again use a shortcut created by the installation wizard. Following the path Start > Programs > IDABC eprocurement and clicking on IDABC eprocurement Demo, the default Internet browser will open, and load the IDABC eprocurement Dynamic Demonstrators home page. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 24 of 29

25 The above screen is the IDABC eprocurement Dynamic Demonstrators homepage. In case the demonstrators' homepage is not automatically loaded after a while, one of the following may be occurring: The JBoss application server is not started The start up process of the JBoss application server has created an error The JBoss application server is not fully started up yet The MySQL database server is not started (in case MySQL database is used) The start up process of the MySQL database server has created an error (in case MySQL database is used) 4.2 Stopping the Demonstrators Stopping the IDABC eprocurement Dynamic Demonstrators involves stopping the JBoss application server. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 25 of 29

26 4.2.1 Stopping the application server Similarly to the starting the JBoss application server, the process for stopping the JBoss application server is fully automated. Users may utilise the appropriate shortcut created at the users system during installation. To stop the application server, users can use the shortcut Start > Programs > IDABC eprocurement and click on Stop IDABC Application Server. Another command prompt window will appear titled Stop IDABC Application Server. This window will output information while shutting down the IDABC eprocurement Dynamic Demonstrators. Once the process for stopping the JBoss application server is complete, both windows titled Start IDABC Application Server and Stop IDABC Application Server will present the text Press any key to continue. Users may then close the windows, as the IDABC eprocurement Dynamic Demonstrators are now stopped. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 26 of 29

27 5 UNINSTALLING THE DEMONSTRATORS This section provides information about uninstalling the IDABC eprocurement Dynamic Demonstrators for the system. Uninstalling IDABC eprocurement Dynamic Demonstrators from the system is a two-step process when MySQL database has been selected during installation: First the user needs to remove the database schema stored in the MySQL database server, and then remove the demonstrators components installed in the system. In the case of HSQL removing the demonstrators components would be sufficient. WARNING: To uninstall the IDABC eprocurement Dynamic Demonstrators, the demonstrators must not be running. Users may follow the directions of section 4.2 for stopping the IDABC eprocurement Dynamic Demonstrators. 5.1 Erasing the database schema (MySQL) To erase the database schema of the IDABC eprocurement Dynamic Demonstrators, users can use a script named uninstall_database.bat located in the Uninstaller directory of the IDABC eprocurement Dynamic Demonstrators installation. Users may simply run the script (by double clicking it, or by invoking it from the command line) and the database schema will be erased from the MySQL database server. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 27 of 29

28 INFO: The aforementioned script can be executed only if the MySQL database server is running. WARNING: Erasing the database schema from the MySQL database server will erase all data stored in the IDABC eprocurement Dynamic Demonstrators database. This is an irreversible process. WARNING: The aforementioned script does not remove the IDABC eprocurement Dynamic Demonstrators database user account. The user account in the MySQL database server must be deleted manually by users Removing application components The installation wizard, during the installation process, automatically creates an uninstall script. This script is stored under the Uninstall directory of the IDABC eprocurement Dynamic Demonstrators installation. To uninstall the IDABC eprocurement Dynamic Demonstrators, users can use the "Uninstall IDABC eprocurement" shortcut or alternatively they can locate the uninstaller script in the Uninstall directory of the demonstrators installation directory. Users may initiate the uninstall process by double clicking on the unistaller.jar uninstall script, or by navigating to the uninstaller directory with the command prompt and entering the following command: java jar uninstaller.jar Once the uninstall procedure starts, users must click Uninstall to proceed with uninstalling the IDABC eprocurement Dynamic Demonstrators or Quit to cancel the uninstall operation. When this script completes its execution successfully all relevant files and shortcuts will be removed. In case og MySQL database selection the database schema used by the IDABC eprocurement Dynamic Demonstrators will not be erased. Users will have to erase the database schema manually, using the database uninstall script, as detailed in the previous section. WARNING: If a Windows program (such as Microsoft Explorer or other) uses a file in the installation directory of the IDABC eprocurement Dynamic Demonstrators, the files will be locked and not deleted by the uninstaller. If this occurs, user may delete the complete installation directory manually at a later stage, when the Windows program does not utilise that undeleted file. 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 28 of 29

29 6 CONTACT DETAILS The IDABC eprocurement Dynamic Demonstrators package has been created so that it can guide users to install, operate and uninstall the demonstrators. Nevertheless, depending on system configuration, it is possible that problems occur when using the installation wizard, starting/stopping the demonstrators, or uninstalling the demonstrators from a system. Users from public administrations that have difficulties in any of the aforementioned areas can seek assistance at: In order to assist the support line to better understand the issue and provide prompt resolution, users are kindly requested to provide the following information in their to the support line: Detailed description of the problem Hardware configuration (including CPU and RAM details) Operating System configuration (including OS/version, Service Packs installed and values of the environment variables PATH and "JAVA_HOME") MySQL database server installation (including version, hosting system/directory) in case MySQL installation was performed Java 5 SDK installation (installation directory and the output of command java -version ) A screenshot of the error. In case there are problems during the configuration of the JBoss application server or the database schema creation, users are requested to provide the text outcome of that window instead (see page 13). To get more information on the IDABC activities on Public eprocurement, interested parties may also visit: END OF DOCUMENT 17/11/2008 Updated Dynamic Demonstrators Installation Manual Page 29 of 29