Jump to: navigation, search

Difference between revisions of "COSMOS SDK Installation"

(New page: This page provides instructions on how to install and run the COSMOS demo for i12. == Objective of the Demo == The COSMOS Demo illustrates the main features of COSMOS. == Installation...)
 
(Configuring the COSMOS SDK)
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This page provides instructions on how to install and run the COSMOS demo for i12.   
+
This page provides instructions on how to install and run the COSMOS SDK.   
  
== Objective of the Demo ==
+
== Objective of the SDK ==
 
+
The COSMOS SDK provides the Eclipse-based tooling to develop and test a Management Data Repository (MDR).
The COSMOS Demo illustrates the main features of COSMOS.
+
  
 
== Installation ==  
 
== Installation ==  
  
=== Download COSMOS Demo and Prerequisites ===
+
=== Download COSMOS Build and Prerequisites ===
This section provides instructions for installing and running the demo program that is provided in the COSMOS i12 build.   
+
This section provides instructions for installing and running the SDK provided by COSMOS.   
# Install [http://archive.apache.org/dist/tomcat/tomcat-5/v5.5.26/bin/ Tomcat 5.5.26]. The directory where the Tomcat server is installed will be referred to as the <tomcat_install_dir> in this document.
+
# Install your favorite web server supporting Java Server Pages (JSP) and servlet technology.  
# Download Axis2 war file for Tomcat from this page: http://ws.apache.org/axis2/download/1_3/download.cgi.  Download the zip file for "WAR (Web Archive) Distribution". 
+
# From the [http://www.eclipse.org/cosmos/downloads/ COSMOS download page], click on the link of the stable build of your choice.  Download the zip file under the "COSMOS SDK" section.   
# Download the [http://download.eclipse.org/birt/downloads/drops/R-R1-2_3_0-200806191030/birt-runtime-2_3_0.zip BIRT] project. 
+
# Download the prerequisites for the SDK as specified in the Requirements section of the download page, including the Eclipse-hosted package for Dojo.
# Download [http://download.dojotoolkit.org/release-1.1.0/dojo-release-1.1.0.zip DOJO].  
+
# Unzip Eclipse SDK to a directory along with WTP, EMF, XSD, GEF and the COSMOS SDK.
# From the [http://www.eclipse.org/cosmos/downloads/ COSMOS download page], click on the link of the latest candidate build for i12.  Download the zip file under the "COSMOS Demo" section.   
+
# Unzip the Dojo zip file to a separate directory.
# Unzip the demo zip file to a directory.  You will see a directory called "cosmos-demo". This directory will be referred to as <cosmos-demo> in this document.
+
# Download IBM Java SDK 5.0 or the Sun Java JDK 1.5* to use with the COSMOS toolkit. IBM Java 5.0 can be found at http://www.ibm.com/developerworks/java/jdk/ . Known issues with the Sun JRE:
# If you are using the Aperi MDR, you will need to install and setup Aperi as follows:
+
## You will need to do the following to configure Eclipse to avoid crashing the workspace with the internal web browser:
## Download the Aperi Storage Resource Manager version 0.4.1 from [http://www.eclipse.org/aperi/ Aperi downloads]
+
### Select "General > Web Browser" from the preferences dialog box
## Follow the instructions at [http://www.eclipse.org/aperi/documentation/r4/install.php Aperi install instructions]. You MUST choose Derby as your database.
+
### Select the "Use external Web browser" radio button
## After successfully installing Aperi, you may wish to run some Aperi probes to populate your database with storage information (refer to the "Aperi post-installation instructions" section of the install instructions).
+
### Check the "Firefox" entry as the external web browser
## Alternatively you can use the sample Aperi database located at <cosmos-demo>\database\Aperi. To install the sample Aperi database, replace your <aperi-installation-folder>\db folder with the contents of the <cosmos-demo>\database\Aperi folder.
+
## When using the SML-IF Validator with the Sun JRE, you need to ensure the Xerces libraries appear in the boot classpath *before* the JVM's core libraries; otherwise, an internal validation error appears. This can be resolved one of two ways:
## Note that the Aperi MDR is preconfigured to access the default Aperi derby database (at localhost and port 1527). If you have chosen another location, you will need to modify the <tomcat>\webapps\axis2\WEB-INF\services\AperiMdr\META-INF\services.xml file to change the DERBY_HOST and DERBY_PORT parameters.
+
### Add the entry -Xbootclasspath/p:<Path of org.apache.xerces_2.9.0.v200805270400.jar in your machine> into eclipse.ini in the Eclipse folder.
## Before using the Aperi MDR, start the Aperi derby database. For example: type "start derby" from the <Aperi install>\db directory.
+
### Launch Eclipse from command line with: <code>eclipse -vmargs -Xbootclasspath/p:<Path of xerces.jar></code>
 
+
=== Installing COSMOS Web applications and Web Services ===
+
COSMOS comes with a program that helps install and configure the web applications and web services required for the demonstration. The install program is located at <cosmos-demo>\bin. Run configDemo.bat or configDemo.sh to start the install program on Windows and Linux respectively. The install program assumes your <cosmos-demo> directory and the tomcat installation are on the same host.
+
 
+
The configDemo program accepts 5 parameters.  They are:
+
# tomcatDir: Apache Tomcat install directory <tomcat_install_dir>
+
# cosmosDir: COSMOS Demo install directory <cosmos-demo>
+
# birt: path to BIRT Runtime zip file (download from step 4 above)
+
# dojo: path to dojo zip file (download from step 5 above)
+
# axis2war: (optional) Path to the axis2.war file (downloaded from step 3 above)
+
 
+
You will see something like the following in a successful execution of the config program. 
+
<pre>
+
Unzipping c:\Program Files\apache-tomcat-5.5.26\webapps_backup4\axis2.war to c:\
+
Program Files\apache-tomcat-5.5.26\webapps\axis2...
+
Installed axis2 on Apache Tomcat server.
+
Installed web application: COSMOSReportViewer
+
Installed web application: COSMOSUI
+
Unzipping c:\dev\birt-runtime-2.3.zip to c:\Program Files\apache-tomcat-5.5.26
+
\webapps/COSMOSReportViewer...
+
Unzipped BIRT to COSMOSReportViewer
+
Copied BIRT web viewer example to COSMOSReportViewer
+
Unzipping c:\dev\dojo-release-1.1.0.zip to c:\Program Files\apache-tomcat-5.5.26
+
\webapps/COSMOSUI...
+
Unzipped dojo to COSMOSUI.
+
Installed web service: AperiMdr
+
Installed web service: Broker
+
Installed web service: ExampleMdr
+
Installed web service: LoggingDataManager
+
Installed web service: ServiceFinder
+
Installed web service: SMLMDR
+
Installed web service: StatDataManager
+
Installed web service: TestFederatingCMDB
+
Copied axis jar files to COSMOSUI.
+
Copied axis jar files to COSMOSReportViewer.
+
Copied axis jar files to cosmos client.
+
Updated axis2.xml.
+
Updated services.xml for SML MDR.
+
Updated services.xml for statistical MDR.
+
Installed broker database to c:\Program Files\apache-tomcat-5.5.26\webapps\axis2
+
\WEB-INF\database/brokerdb.xml
+
</pre>
+
  
 +
=== Configuring the COSMOS SDK ===
 +
Before creating a MDR, you must set some configuration options in the preferences page. 
 +
# Start up Eclipse.
 +
# Open the preference page by selecting Windows>Preferences.  In the preferences dialog, select "Web Services > Axis2 Preferences".
 +
# Enter the Axis 2 directory in the "Axis2 runtime location" text box.
 +
# Next, select "Server > Runtime Environments" in the preference dialog box.  Here you will specify the web server runtime.
 +
# Click the "Add..." button.  Select a runtime environment and click "Next".
 +
# Enter the location of the web server directory in the "<Web server name> installation directory:" text box.
 +
# Next select "System Management > Web UI Viewer" in the preference dialog box.  Specify the host and port on which you want to run the web UI viewer for testing MDRs; the defaults should suffice for most users.
  
 +
Once you have configured the SDK, you can create a MDR by following the "Constructing a Data Manager" section in the COSMOS Developer's Guide.
 
   
 
   
 
[[Category: COSMOS]]
 
[[Category: COSMOS]]

Latest revision as of 15:41, 10 October 2008

This page provides instructions on how to install and run the COSMOS SDK.

Objective of the SDK

The COSMOS SDK provides the Eclipse-based tooling to develop and test a Management Data Repository (MDR).

Installation

Download COSMOS Build and Prerequisites

This section provides instructions for installing and running the SDK provided by COSMOS.

  1. Install your favorite web server supporting Java Server Pages (JSP) and servlet technology.
  2. From the COSMOS download page, click on the link of the stable build of your choice. Download the zip file under the "COSMOS SDK" section.
  3. Download the prerequisites for the SDK as specified in the Requirements section of the download page, including the Eclipse-hosted package for Dojo.
  4. Unzip Eclipse SDK to a directory along with WTP, EMF, XSD, GEF and the COSMOS SDK.
  5. Unzip the Dojo zip file to a separate directory.
  6. Download IBM Java SDK 5.0 or the Sun Java JDK 1.5* to use with the COSMOS toolkit. IBM Java 5.0 can be found at http://www.ibm.com/developerworks/java/jdk/ . Known issues with the Sun JRE:
    1. You will need to do the following to configure Eclipse to avoid crashing the workspace with the internal web browser:
      1. Select "General > Web Browser" from the preferences dialog box
      2. Select the "Use external Web browser" radio button
      3. Check the "Firefox" entry as the external web browser
    2. When using the SML-IF Validator with the Sun JRE, you need to ensure the Xerces libraries appear in the boot classpath *before* the JVM's core libraries; otherwise, an internal validation error appears. This can be resolved one of two ways:
      1. Add the entry -Xbootclasspath/p:<Path of org.apache.xerces_2.9.0.v200805270400.jar in your machine> into eclipse.ini in the Eclipse folder.
      2. Launch Eclipse from command line with: eclipse -vmargs -Xbootclasspath/p:<Path of xerces.jar>

Configuring the COSMOS SDK

Before creating a MDR, you must set some configuration options in the preferences page.

  1. Start up Eclipse.
  2. Open the preference page by selecting Windows>Preferences. In the preferences dialog, select "Web Services > Axis2 Preferences".
  3. Enter the Axis 2 directory in the "Axis2 runtime location" text box.
  4. Next, select "Server > Runtime Environments" in the preference dialog box. Here you will specify the web server runtime.
  5. Click the "Add..." button. Select a runtime environment and click "Next".
  6. Enter the location of the web server directory in the "<Web server name> installation directory:" text box.
  7. Next select "System Management > Web UI Viewer" in the preference dialog box. Specify the host and port on which you want to run the web UI viewer for testing MDRs; the defaults should suffice for most users.

Once you have configured the SDK, you can create a MDR by following the "Constructing a Data Manager" section in the COSMOS Developer's Guide.