Installation Guide of the Change Management API Reference Implementation

Transcription

1 Installation Guide of the Change Management API Reference Implementation Cm Expert Group CM-API-RI_USERS_GUIDE.0.1.doc Copyright 2008 Vodafone. All Rights Reserved. Use is subject to license terms. CM-API-RI_USERS_GUIDE.0.1.doc 1

2 Executive Summary The Change Management API purpose is to ensure ensures that changes are done in a controlled manner. The Change Management specification operates changes following the IT Infrastructure Library (ITIL) "Change Management" recommendations and principles. This document describes how to install and use the Change Management Reference Implementation (RI). Note that it is using the Common API defined under OSS/J Initiative. CM-API-RI_USERS_GUIDE.0.1.doc 2

3 Table of Contents Executive Summary...2 Table of Contents...3 Preface... 4 Objectives... 4 Audience... 4 Related Information...4 Revision History: Introduction Examples demonstrating the 3 integration profiles Installation instructions Load the project Configure the application server Deploy the application Exercise the EJB profile Change Management EJB profile...15 Appendix A: Glossary and References Appendix A: Glossary and References References CM-API-RI_USERS_GUIDE.0.1.doc 3

4 Preface Objectives Installation and usage description of the Change Management Reference Implementation. Audience The target audiences are Developers who seek information about how the Change Management API RI Developers of other OSS/J API Reference Implementations Developers who want to make use of these API and extend its implementation Related Information Prerequisite NetBeans IDE 6.0, and glassfish v2 b58. You can download it at: Install both NetBeans and Glassfish (in this document, application server root folder will be referenced as <glassfish-v2b58_home>). March 2008 Revision History: Date Version Author State Comments 0.1 CM Expert Group Draft Create users guide from CM RI 0.1 CM-API-RI_USERS_GUIDE.0.1.doc 4

5 1 Introduction This document describes how to install, run and verify the Change Management API Reference implementation (RI). The RI is divided into two main parts: The extendable implementation of Change Management API Am EJB Client example In all the following: the given paths are relative to the <installation path>\ change_management_javaeesdk-0_1-src-ri the operating system is Windows XP the application server bin directory is in the execution path of the environment Note: screenshots are provided as example, version number (like 0_1 for example may be different) CM-API-RI_USERS_GUIDE.0.1.doc 5

6 2 Examples demonstrating the Java integration profiles The part of the RI is delivered as NetBeans projects starting with cm_ri prefix. There are 3 projects (or modules): cm_ri_ejb: contains the Change Management EJB Java profile composed of several EJBs, cm_ri_app: contains the deployable application (.ear) encapsulating the Change Management EJBs from the cm_ri_ejb project cm_client: contains a Change Management client demonstrating the RI use 2.1 Installation instructions All the installation steps are performed using NetBeans. Start NetBeans, the following window appears: CM-API-RI_USERS_GUIDE.0.1.doc 6

7 2.1.1 Load the project Open all the 3 cm_ri projects from the src directory: In the wizard window navigate until the src directory and selection the 3 projects: CM-API-RI_USERS_GUIDE.0.1.doc 7

8 Resolve any reference problems; NetBeans will give you instructions. Missing Change Management dependant libraries can be found under the lib directory of the Change Management RI package. The Application server required libraries for the cm_client to run can be found under <glassfishv2b58_home>/lib Configure the application server The first step is to add the GlassFish application server to NetBeans Runtime environment. Glassfish installation instruction needs to be completed before executing the following: Go to the Services section and add the server: CM-API-RI_USERS_GUIDE.0.1.doc 8

9 Complete the wizard as follow: CM-API-RI_USERS_GUIDE.0.1.doc 9

10 And then CM-API-RI_USERS_GUIDE.0.1.doc 10

11 Finally, in last wizard specify a user login and password for the installed server. Start the application server: Note: Be sure that your firewall is correctly configured to allow Java virtual machine, NetBeans, etc to access the network. CM-API-RI_USERS_GUIDE.0.1.doc 11

12 Once started a green arrow appears in front of the name: CM-API-RI_USERS_GUIDE.0.1.doc 12

13 Once the Glassfish server has been installed, you can select adequate server instance required by both ChangeManager and ChangeManagementSystem projects. Note: in the new 6.0 NetBeans version, registering server resources is done automatically. You can verify the configuration into the Services tab: Note: there is no need for a database for the Change Management RI to work Deploy the application From the Projects tab, right-click on the cm_ri_app project, named ChangeManagementSystem, and select the Undeploy and Deploy item: CM-API-RI_USERS_GUIDE.0.1.doc 13

14 Verify the correct deployment from the Services tab: CM-API-RI_USERS_GUIDE.0.1.doc 14

15 The three lines in the red box indicate that the Change Management jar including the three EJB has been correctly deployed (if not, try to refresh to actualize the representation). (If necessary, the traces of the Application server could be checked at the bottom of the NetBeans Output window) The application is now ready and could be used Exercise the EJB profile Change Management EJB profile Once the EAR, including the Change Management EJBs, deployed in the running application server, the Change Management profile can be tested through the Cm_Client project. Right-click the project title and select Run CM-API-RI_USERS_GUIDE.0.1.doc 15

16 You get the Change Management EJB client execution log traces on Netbeans Output window: CM-API-RI_USERS_GUIDE.0.1.doc 16

17 CM-API-RI_USERS_GUIDE.0.1.doc 17

18 Appendix A: Glossary and References References CM-API-RI_USERS_GUIDE.0.1.doc 18