tt api ri installation guide.1.2.2
DESCRIPTION
Installation GuideTRANSCRIPT
OSS through JavaTM Initiative
JSR 91 - OSS/J Trouble Ticket APIFinal - 1.2.2
Reference Implementation Installation Guide
OSS through Java™ Initiative
JSR 91 Expert Group
TT-API-Ri_Installation_guide.1.2.2.doc
Copyright 2004 - 2008 The Members of the OSS through Java(TM) Initiative, FROX communication, Ascom, Wipro, TeleManagement Forum. All rights reserved. Use is subject to license terms..
Final - 1.2.2 JSR 91 - OSS/J Trouble Ticket API page 1 / 12
OSS through JavaTM Initiative
Executive Summary
The OSS/J Trouble Ticket API offers interfaces and classes to manage Trouble Tickets. This document describes how to install and use the Reference Implementation (RI).
Acknowledgements
This version (1.2.2) of the reference implementation is in the core components based on the work of Pierre Gauthier (Metasolv) who lead the implementation of version 1.0.
The feature/bugfix release version 1.2.2 of the RI was led by Roman Schlegel (FROX communication) and realized by
- Christian Klaus (Ascom)
- Anjana Damara (Wipro)
- Michael Nidel (FROX communication)
Final - 1.2.2 JSR 91 - OSS/J Trouble Ticket API page 2 / 12
OSS through JavaTM Initiative
Table of Contents
Executive Summary........................................................................................................... 2
Acknowledgements............................................................................................................ 2
Table of Contents............................................................................................................... 3
Preface.................................................................................................................................41.1 Objectives.................................................................................................................. 41.2 Audience.................................................................................................................... 41.3 Related Information...................................................................................................41.4 Revision History........................................................................................................ 4
Introduction........................................................................................................................5
Preparation......................................................................................................................... 61.5 Download distribution...............................................................................................61.6 Environment...............................................................................................................61.7 Application Server..................................................................................................... 61.8 Java Database........................................................................................................... 7
Installing the Reference Implementation.........................................................................81.9 Setting up the database schema.................................................................................81.10 Deploying the reference implementation.................................................................8
Testing the Reference Implementation............................................................................ 9
Uninstall the Reference Implementation....................................................................... 101.11 Undeploying the reference implementation...........................................................101.12 Dropping the Trouble Ticket database schema.....................................................10
Build the Reference Implementation from source........................................................ 111.13 System Requirements............................................................................................. 111.14 Install the Application Server................................................................................ 111.15 Install Maven......................................................................................................... 111.16 Configure Maven................................................................................................... 111.17 Build the RI EAR file............................................................................................ 12
Final - 1.2.2 JSR 91 - OSS/J Trouble Ticket API page 3 / 12
OSS through JavaTM Initiative
Preface
1.1 Objectives
Installation and usage description of the OSS/J Trouble Ticket Reference Implementation
1.2 Audience
The target audiences are
• Developers who seek information about how the Trouble Ticket API can be implemented
• Developers of other OSS/J API Reference Implementations
• Developers who want to make use of these API and extend its implementation
1.3 Related Information
Please refer to the Trouble Ticket TCK documentation for instructions about how to test the Reference implementation.
1.4 Revision History
Date Version Author State Comments12.07.2007 0.1 Roman
SchlegelDraft
07.08.2007 1.0 Roman Schlegel
First Release
14.12.2007 1.1 Roman Schlegel
Release Updated for RI v1.2.1
20.02.2008 1.2 Roman Schlegel
Release Updated for RI v1.2.2
Final - 1.2.2 JSR 91 - OSS/J Trouble Ticket API page 4 / 12
OSS through JavaTM Initiative
Introduction
This document describes how to install, run and verify the OSS Trouble Ticket API Reference implementation (RI).
Final - 1.2.2 JSR 91 - OSS/J Trouble Ticket API page 5 / 12
OSS through JavaTM Initiative
Preparation
1.5 Download distribution
If you do not yet have the “Trouble Ticket Reference Implementation”, you need to download it from https://jsr091-public.dev.java.net. Here is the directory structure included in it:
oss_trouble_ticket_j2eesdk-1_2_2-src-ri |--- oss_tt_ri_ear-1.2.2.ear |--- lib |--- docs +-+- src |--- oss_tt_ri_ear |--- oss_tt_ri_ejb |--- oss_tt_ri_ws +--- oss_tt_ri_ws_test
This document is also included in TTRI distribution under docs directory.
1.6 Environment
Please make sure the Variable JAVA_HOME points to your JDK 1.5 Installation.
Also, the common.properties file holds some specific settings which you might need to be updated for specific environments.
1.7 Application Server
The Reference Implementation is tested on Glassfish V2 Final Build which can be downloaded from https://glassfish.dev.java.net.
After installing the Application server, make sure the environment variable AS_HOME points to the installation directory of the application server. It can then be started with the following steps:
1. Make sure the bin directory of your application server is in the PATH variable
2. Starting the default domain:asadmin start-domain domain1
Final - 1.2.2 JSR 91 - OSS/J Trouble Ticket API page 6 / 12
OSS through JavaTM Initiative
1.8 Java Database
Since the Java Database is bundled with the Glassfish server there is nothing additional which needs to be installed. The Database can be started with the following steps:
1. Make sure the bin directory of your application server is in the PATH variable
2. Calling the asadmin-pause.bat script:asadmin start-database
Final - 1.2.2 JSR 91 - OSS/J Trouble Ticket API page 7 / 12
OSS through JavaTM Initiative
Installing the Reference Implementation
This chapter describes how to install the reference implementation.
1.9 Setting up the database schema
To load the database schema, complete the following steps (for Unix installations use *.sh scripts instead of *.bat):
1. Unzip the RI package
2. Make sure the environment variable DERBY_INSTALL from the file oss_tt_ri_ejb\src\main\sql\derby\derby.bat points to the javadb directory from Glassfish
3. Run the create scriptoss_tt_ri_ejb\src\main\sql\derby\create.bat
1.10Deploying the reference implementation
To deploy the reference implementation package, complete the following steps:
1. Make sure the bin directory of your application server is in the PATH variable
2. Change directory tooss_tt_ri_ear
3. Issue the following commandasant deploy
Note: deploying the ear file manually will not create the required resources. Please follow the steps mentioned above to make sure the resources are being created.
Final - 1.2.2 JSR 91 - OSS/J Trouble Ticket API page 8 / 12
OSS through JavaTM Initiative
Testing the Reference Implementation
Please refer to the Trouble Ticket TCK documentation for instructions about how to test the Reference Implementation.
Final - 1.2.2 JSR 91 - OSS/J Trouble Ticket API page 9 / 12
OSS through JavaTM Initiative
Uninstall the Reference Implementation
This chapter describes how to uninstall the reference implementation.
1.11Undeploying the reference implementation
To undeploy the reference implementation package, complete the following steps:
1. Make sure the bin directory of your application server is in the PATH variable
4. Change directory tooss_tt_ri_ear
2. Issue the following commandasant undeploy
Note: undeploying the ear file manually will not remove the JMS and JDBC resources. Please follow the steps mentioned above to make sure the resources are being removed.
1.12Dropping the Trouble Ticket database schema
To load the database schema, complete the following steps (for Unix installations use *.sh scripts instead of *.bat):
1. Make sure the environment variable DERBY_INSTALL from the file oss_tt_ri_ejb\src\main\sql\derby\derby.bat points to the javadb directory from Glassfish
2. Run the create scriptoss_tt_ri_ejb\src\main\sql\derby\drop.bat
Final - 1.2.2 JSR 91 - OSS/J Trouble Ticket API page 10 / 12
OSS through JavaTM Initiative
Build the Reference Implementation from source
In case you want to recompile the Reference Implementation, follow the instructions in this chapter.
1.13System Requirements
The instructions assume you will be deploying and executing the Reference Implementation application on a Windows platform. The instructions given in this document are also applicable, to a great extent, to a UNIX/Linux platform.
The application uses the following third party software:
• Glassfish V2 Final Build
• Maven 2.0.7
• Plugins required by Maven
1.14Install the Application Server
Glassfish V2 Final Build can be downloaded from https://glassfish.dev.java.net
After installing the Application server, make sure the environment variable AS_HOME points to the installation directory of the application server
1.15Install Maven
Maven is available from http://maven.apache.org/download.html
After installing Maven2, make sure the bin directory is in your system environment variable PATH.
1.16Configure Maven
When building implementation, Maven needs to download libraries from a remote repository. So your computer must have internet access. The Maven local repository locates in an .m2 directory under your user home. Under .m2, a file called settings.xml contains the Maven remote repository configuration.
Final - 1.2.2 JSR 91 - OSS/J Trouble Ticket API page 11 / 12
OSS through JavaTM Initiative
The Homepage of JSR91 provides a FAQ section with details how to setup maven and it’s settings.xml file at https://jsr091-public.dev.java.net. You also need to update the variable AS_INSTALL in settings.xml with the right value.
1.17 Build the RI EAR file
To build the reference implementation, change directory to src and execute command:
mvn install
If the build fails, the FAQ section of https://jsr091-public.dev.java.net or http://maven.apache.org/general.html might help.
Final - 1.2.2 JSR 91 - OSS/J Trouble Ticket API page 12 / 12