Download Reference Implementation Installation Guide

OSS through JavaTM Initiative
X.790 Extension to the JSR 91 - OSS/J Trouble Ticket
API (1.2)
Final - 1.0.0
Reference Implementation Installation Guide
OSS through Java™ Initiative
JSR 91 Expert Group
TT-X790-EXT-API-Ri_Installation_guide.1.0.0.doc
Copyright 2002 - 2007 The Members of the OSS through Java(TM) Initiative. All rights
reserved. Use is subject to license terms.
Final - 1.2.1 JSR 91 - OSS/J Trouble Ticket API
page 1 / 9
OSS through JavaTM Initiative
Executive Summary
The OSS/J Trouble Ticket API offers interfaces and classes to manage
Trouble Tickets. The X.790 extension enhances the API with additional
attributes. This document describes how to install and use the Reference
Implementation (RI).
Final - 1.2.1 JSR 91 - OSS/J Trouble Ticket API
page 2 / 9
OSS through JavaTM Initiative
Table of Contents
Executive Summary
2
Table of Contents
3
1
4
Preface
1.1
Objectives
4
1.2
Audience
4
1.3
Related Information
4
1.4
Revision History
4
2
Introduction
5
3
Preparation
6
4
3.1
Environment
6
3.2
Application Server
6
3.3
Java Database
6
Installing the Reference Implementation
7
4.1
Setting up the database schema
7
4.2
Deploying the reference implementation
7
5
Testing the Reference Implementation
8
6
Uninstall the Reference Implementation
9
6.1
Undeploying the reference implementation
9
6.2
Dropping the Trouble Ticket database schema
9
Final - 1.2.1 JSR 91 - OSS/J Trouble Ticket API
page 3 / 9
OSS through JavaTM Initiative
1 Preface
1.1 Objectives
Installation and usage description of the OSS/J Trouble Ticket X.790
Extension Reference Implementation
1.2 Audience
The target audiences are

Developers who seek information about how the X.790 extension
for 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 X.790 extension TCK documentation for
instructions about how to test the Reference implementation.
1.4 Revision History
Date
30.06.2008
Version
0.1
Final - 1.2.1 JSR 91 - OSS/J Trouble Ticket API
Author
Christian
Klaus
State
Comments
Draft
page 4 / 9
OSS through JavaTM Initiative
2 Introduction
This document describes how to install, run and verify the OSS Trouble
Ticket X.790 Extension API Reference implementation (RI) on a Windows
computer.
Final - 1.2.1 JSR 91 - OSS/J Trouble Ticket API
page 5 / 9
OSS through JavaTM Initiative
3 Preparation
3.1 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.
3.2 Application Server
The Reference Implementation is tested on a Sun application server (Sun
Java System Application Server Platform Edition 9.0 (build b48)). It is
included in the Java Application Verification Kit (AVK) for the Enterprise
which can be downloaded from http://java.sun.com/j2ee/avk/.
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
3.3 Java Database
Since the Java Database is bundled with the application 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.1 JSR 91 - OSS/J Trouble Ticket API
page 6 / 9
OSS through JavaTM Initiative
4 Installing the Reference Implementation
This chapter describes how to install the reference implementation.
4.1 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_trouble_ticket_x790_ext-1-0-srcri\src\sql\derby\derby.bat points to the javadb
directory from the application server
3. Run the create script
oss_trouble_ticket_x790_ext-1-0-srcri\src\sql\derby\create.bat
4.2 Deploying 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 to
oss_trouble_ticket_x790_ext-1-0-src-ri\src
3. Issue the following command
asant 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.1 JSR 91 - OSS/J Trouble Ticket API
page 7 / 9
OSS through JavaTM Initiative
5 Testing the Reference Implementation
Please refer to the Trouble Ticket X.790 Extension TCK documentation for
instructions about how to test the Reference Implementation.
Final - 1.2.1 JSR 91 - OSS/J Trouble Ticket API
page 8 / 9
OSS through JavaTM Initiative
6 Uninstall the Reference Implementation
This chapter describes how to uninstall the reference implementation.
6.1 Undeploying 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
2. Change directory to
oss_trouble_ticket_x790_ext-1-0-src-ri\src
3. Issue the following command
asant 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.
6.2 Dropping 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_trouble_ticket_x790_ext-1-0-srcri\src\sql\derby\derby.bat points to the javadb
directory from Glassfish
2. Run the create script
oss_trouble_ticket_x790_ext-1-0-srcri\src\sql\derby\drop.bat
Final - 1.2.1 JSR 91 - OSS/J Trouble Ticket API
page 9 / 9