Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "OSEE/Users Guide/Getting Started"

(Non-Eclipse System Requirements)
(Launch Application Server)
(114 intermediate revisions by 8 users not shown)
Line 7: Line 7:
 
==Requirements==
 
==Requirements==
  
===Non-Eclipse System Requirements===
+
* System with at least 4GB of RAM
See [[OSEE/Users_Guide/Developers_Guide#Non-Eclipse_System_Requirements|Non-Eclipse System Requirements]]
+
* Java Runtime Environment (JRE) 1.8
 +
* [https://www.eclipse.org/downloads/packages/release/Neon/2 Eclipse Neon 2]
 +
* Relational Databases: OSEE comes bundled with H2. For additional database support, see [[OSEE/Users_Guide/Getting_Started#Supported_Databases|Supported Databases]].
  
===Eclipse Dependencies===
+
==Eclipse Installation ==
  
* An Eclipse 3.5 base with the following features installed (you can see which features are already installed from '''Help > About Eclipse Platform > Installation Details'''):
+
To install OSEE: Start by downloading the OSEE Application Server and the  OSEE Client Update Archive from the [http://www.eclipse.org/osee/downloads/ downloads] page.
* org.eclipse.gef and org.eclipse.draw2d
+
* org.eclipse.datatools.connectivit.oda.feature
+
* org.eclipse.datatools.enablement.oda.feature
+
* org.eclipse.birt.chart.runtime
+
  
The easiest solution is the Ganymede Eclipse install of the Eclipse IDE for Java and Report Developers since it provides the above Eclipse dependencies.
+
===Quick Server Installation===
 +
If you are interested in a quick start, and are not setting up a custom database installation, setting up the OSEE server with the bundled HSQLDB database is simple.
 +
* Create a directory to place your server in, and unzip the downloaded server zip file (e.g. org.eclipse.osee.x.server.runtime.zip) into that directory.
 +
You should end up with the following files and directories:
 +
:configuration
 +
:demo
 +
:eclipse
 +
:etc
 +
:plugins
 +
:runDemo.bat
 +
:runDemo.sh
 +
:runHsql.sh
 +
:runPostgreSqlLocal.sh
 +
* Edit the desired startup script file (e.g. "runDemo.bat") to provide the server the link to the binary data.
 +
For example, if you were using Windows, and you installed to C:/UserData/OseeDemo, you would change the line in the batch file to:
 +
:-Dosee.application.server.data="C:/UserData/OseeDemo/demo/binary_data"
 +
* change to the etc directory, and edit the osee.hsql.json file.
 +
Set the jdbc.server.db.data.path to the location of the hsql db.
 +
Following the example above, for instance, you would change the line in the json file to:
 +
:"jdbc.server.db.data.path": "file:c:/UserData/OseeDemo/demo/hsql/osee.hsql.db",
 +
That completes the simple server setup.
 +
Run the server by setting up a command window, then running the script file to start the server.
 +
For example, if you were running with Windows, you would start a windows command shell, then run the "runDemo.bat" batch script. See  [[#Launch_Application_Server| Launch Application Server]] for details on running the server.
  
'''Note: To use OSEE with a database other than Derby, you will need the JDBC Drivers included in the OSEE add-ons distributed from the external location. Such a scheme of distribution is caused by licensing requirements.'''
+
=== Client Installation ===
 +
The OSEE client can be installed from within Eclipse like any other Eclipse plugin.
 +
# Start Eclipse and select the menu item '''Help > Install New Software...''' <!--[[Image:Find_and_install.png]]-->
 +
# Select the ''Available Software'' tab group and click the ''Add...'' button. <br/> [[Image:Add_site.png|500px]] [[Image:New_update_site.png]]<br/>
 +
# In the ''Add Repository'' dialog, choose the Archive button, then navigate the file browser to the Client Update file downloaded in step one, "org.eclipse.osee.client.all.p2.zip". '''Please note that the use of the software you are about to access may be subject to third party terms and conditions and you are responsible for abiding by such terms and conditions.'''
 +
# Click on the ''OK'' button to store update site information, "Eclipse OSEE Client All - (Incubation)".
 +
# Select the OSEE update site entry and all features listed under its category. Click the ''Next'' button. [[Image:AvailableSoftware.png]]
 +
# If you receive a security popup Window regarding unsigned content, click OK.
 +
# The update manager calculates dependencies and offers you a list of features to install. Select the needed ones and click the ''Next'' button.
 +
# Accept terms of license agreement and click the ''Finish'' button in order to start the installation of selected features.[[Image:AcceptTerms.png]]
 +
# To apply installation changes click on the ''No'' button and shutdown Eclipse. It is important that you don't restart Eclipse until you have completed the database initialization steps below.
 +
[[Image:Restart_dialog.png]]
 +
If you are using the default demo database and did the server quick start above, you just need to make one change to the eclipse eclipse.ini file - add the line
 +
:-Dosee.application.server=http://localhost:8089 to the end of the file.
 +
Your installation is complete.
 +
*If you chose the quick server installation above, you can check to make sure the server is running in the command window, then start the OSEE client.
 +
*If you are using a custom database, then configure the database and initialize it before running the client.
  
==Eclipse Installation==
+
== Additional Configuration Options ==  
 
+
# The following instructions apply if you are setting up a custom database, or if you are configuring OSEE for use by multiple users.
OSEE can be installed from within Eclipse like any other Eclipse plugin.
+
# Custom Data Base: Follow the instructions at [[#Supported Databases|Supported Databases]] to complete this step.
 
+
# Initialize the database with default OSEE data.  See [[#Database Initialization| Database Initialization]]
To install OSEE:
+
# Setup config.ini and launch eclipse to start using OSEE  [[#Launch_.26_Configuration| Launch and Configuration]]
 
+
# Start Eclipse and select the menu item '''Help > Install New Software...''' <!--[[Image:Find_and_install.png]]-->
+
# Select the ''Available Software'' tab group and click the ''Add Site...'' button. [[Image:Add_site.png]]
+
# On the ''Add Site'' dialog enter the URL to the ''Add-On'' update site. The proper URL can be found on [http://www.eclipse.org/osee/downloads.php downloads]. If the update site is marked as an archived site, you will need to download the archived update site to your local file system, and add the path to the ''Add-Site'' dialog by using the ''Archive'' button. If the update site is not marked as an archived update site then copy the URL listed in the downloads page directly into the ''Add-Site'' dialog.'''Please note that the use of the software you are about to access may be subject to third party terms and conditions and you are responsible for abiding by such terms and conditions.'''
+
# Click on the ''OK'' button to store update site information.[[Image:New_update_site.png]]
+
# Select the OSEE update site entry and all features listed under its category. Click the ''Install'' button. [[Image:Install_updates.png]]
+
# The update manager calculates dependencies and offers you a list of features to install. Select the needed ones and click the ''Next'' button.[[Image:Install.png]]
+
# Accept terms of license agreement and click the ''Finish'' button in order to start the download of selected features.[[Image:Install_license.png]]
+
# To apply installation changes click on the ''No'' button and shutdown Eclipse. It is important that you don't restart Eclipse until you have completed the database initialization steps below.[[Image:Restart_dialog.png]]
+
# Before you can use OSEE you will need to install a relational database. Follow the instructions at [[#Supported Databases]] to complete this step.
+
# Initialize the database with default OSEE data [[#Database Initialization]]
+
# Setup config.ini and launch eclipse to start using OSEE  [[#Configuration and Launch]]
+
 
# You can find different OSEE perspectives, such as Define and ATS, and views in correspondent dialogs, activated by menu items ''Window > Open Perspective > Other...'' and ''Window > Show View > Other...''.
 
# You can find different OSEE perspectives, such as Define and ATS, and views in correspondent dialogs, activated by menu items ''Window > Open Perspective > Other...'' and ''Window > Show View > Other...''.
  
Line 45: Line 69:
 
<td valign="top">[[Image:Show_view.png]]</td></tr>
 
<td valign="top">[[Image:Show_view.png]]</td></tr>
 
</table>
 
</table>
 +
 +
==Server Installation ==
 +
 +
#Download the server zip file from [http://www.eclipse.org/osee/downloads/ downloads].
 +
#Unzip the file
 +
#Set up the database (as described below)
  
 
==Supported Databases==
 
==Supported Databases==
  
Data created and managed by OSEE is persisted into a data store divided into two sections. A relational database to store type, configuration, and simple content and a remote file system to store binary content.
+
Data created and managed by OSEE is persisted into a data store divided into two sections. A relational database to store type, configuration, and small content (< 4000 bytes) and a remote file system to store larger binary content.
+
Before you can use OSEE, you will need to select and install a relational database suited for your needs and identify a file system path for binary content storage. If you are new to OSEE and would like to try it out without installing your own relational database, you can follow the link below for instructions on using OSEE's pre-configured server.
+
 
 
OSEE provides support for the databases listed below.
+
Before you can use OSEE, you will need to select and install a relational database suited for your needs and identify a file system path for binary content storage. OSEE provides support for the databases listed below. For launch and configuration instructions visit [[#Launch_.26_Configuration| Launch and Configuration]].
 
+
Alternatively, users may choose to use the pre-configured OSEE Demo server before configuring their own. For launch and configuration instructions visit [[Configuration and Launch]].
+
+
===Derby Installation===
+
 
+
COMING SOON
+
  
 
===PostgreSQL Installation===
 
===PostgreSQL Installation===
Line 70: Line 92:
 
# Download PostgreSQL from http://www.postgresql.org/download
 
# Download PostgreSQL from http://www.postgresql.org/download
 
# Follow PostgreSQL installation instructions
 
# Follow PostgreSQL installation instructions
# By default, the PostgreSQL database server is configured to allow only local connections. If remote connections are to be allowed, edit postgresql.conf and pg_hba.conf to set the necessary permissions. (To setup an unsecured database instance set listen_address to * in the postgresql.conf file and add the following line to the pg_hba.conf file: host  all  all  0.0.0.0/0  trust)
+
# By default, the PostgreSQL database server is configured to allow only local connections. If remote connections are to be allowed, edit postgresql.conf and pg_hba.conf to set the necessary  
 +
 
 +
permissions. (To setup an unsecured database instance set listen_address to * in the postgresql.conf file and add the following line to the pg_hba.conf file: host  all  all  0.0.0.0/0  trust). These two files are located in the \PostgreSQL\<version>\data directory.
 
# Configure PostgreSQL for OSEE
 
# Configure PostgreSQL for OSEE
## Launch pgAdmin (in windows Start->All Programs->PostgreSQL*->pgAdmin III)
+
## Launch pgAdmin (in windows Start->All Programs->PostgreSQL*->pgAdmin *)
 
## Double click on PostgreSQL Database Server (listed under Servers on the left hand side)
 
## Double click on PostgreSQL Database Server (listed under Servers on the left hand side)
 
### If you are prompted for a password type the password selected during installation (user should be postgres by default)
 
### If you are prompted for a password type the password selected during installation (user should be postgres by default)
 
## Create an "osee" user
 
## Create an "osee" user
### Right-click on Login Roles (at the bottom of the tree on the left hand side) and select "New Login Role..."
+
### Right-click on Login/Group Roles (in the tree on the left hand side) and select "Create -> Login/Group Role..."
 
### Enter the following in the dialog:
 
### Enter the following in the dialog:
#### Role Name: osee
+
#### General Tab
#### "Can login" should be checked
+
##### Name: osee
#### Password: osee
+
#### Definition Tab
#### Password (again): osee
+
##### Password: osee
#### Role Privileges--select all of the following:
+
#### Privileges Tab
##### Inherits rights from parent roles
+
##### Can login? Yes
##### Superuser
+
##### Superuser:  Yes
##### Can create database objects
+
##### Create roles?  Yes
##### Can modify catalog directly
+
##### Create databases:  Yes
### Click 'OK'
+
##### Update catalog?  Yes
 +
### Click 'Save'
 
### You should now have an "osee" user under Login Roles
 
### You should now have an "osee" user under Login Roles
 
## Expand the "Databases" item in the tree
 
## Expand the "Databases" item in the tree
### Create the "OSEE" database by right-clicking on "Databases" and selecting "New Database..."
+
### Create the "OSEE" database by right-clicking on "Databases" and selecting "Create -> Database..."
 
### Enter the following in the dialog:
 
### Enter the following in the dialog:
#### Name: OSEE
+
#### General Tab
#### Owner: osee
+
##### Database: OSEE
#### Encoding: UTF-8
+
##### Owner: osee
### Click 'OK'
+
#### Definition Tab
 +
##### Encoding: UTF-8
 +
### Click 'Save'
 
### You should now have an "OSEE" Database under Databases
 
### You should now have an "OSEE" Database under Databases
 
## Click on "OSEE" and then expand it, then expand "Schemas"
 
## Click on "OSEE" and then expand it, then expand "Schemas"
 
### Create the "osee" schema:
 
### Create the "osee" schema:
#### Right click on "Schemas" and select "New Schema..."
+
#### Right click on "Schemas" and select "Create -> Schema..."
 
#### Enter the following in the dialog:
 
#### Enter the following in the dialog:
##### Name: osee
+
##### General Tab
##### Owner: osee
+
###### Name: osee
#### Click 'OK'
+
###### Owner: osee
 +
#### Click 'Save'
 
#### You should now have an "osee" schema under schemas
 
#### You should now have an "osee" schema under schemas
### The relational database is now configured. Proceed to OSEE Database Initialization
+
## The relational database is now configured. Proceed to OSEE Database Initialization
  
===Oracle Installation===
+
==Launch Application Server==
  
COMING SOON
+
'''Prerequisites'''
  
===MySQL Installation===
+
* Database has been installed
  
COMING SOON
+
'''Instructions'''
  
==Launch Application Server==
+
* Execute the launch script for your database and OS (if running from microdoc: http://osee.microdoc.com/node/2) - typical launch script names are ''runPostgresqlLocal.sh'' for a local Postgres on Unix and ''runH2.sh'' for H2 on Unix. It is straightforward to convert the downloaded scripts to Windows batch files.
 +
** If running PostgreSQL, be sure to add the driver bundle ([http://www.eclipse.org/osee/downloads/ downloads]) to the server installation.  Unzip the files into the server installation and add org.postgresql.driver@start to the bundles in config.ini.  In addition, add the org.postgresql.driver_<version>.jar file to the plugins directory in the Eclipse installation.
 +
* Wait until server finishes the startup procedure - '''do not close the console'''
 +
* To check that the server has connected successfully to the database, enter the command osgi> osee server_status
 +
* You should see results similar to:
 +
[[File:ServerStatus.jpg]]
  
Prerequisites
+
== Database Initialization  ==
  
Visit the 'User's Guide' if you need more information about any of the pre-requisites below.
+
'''Prerequisites'''
  
    * Database has been installed
+
Visit the 'User's Guide' if you need more information about any of the pre-requisites below.
  
Instructions
+
*Database has been installed
 +
*Database server is running
 +
*A file system path has been selected for binary data storage. The system default the user's home directory.
 +
*An application server is running. See 'Application Server Launch' for more info.
  
  1. Execute the launch script for your OS (if running from microdoc: http://osee.microdoc.com/node/2)
+
<br>'''''Warning: This process will delete all data from OSEE Data Store. Make sure you are certain before running this process.'''''
  2. Wait until server finishes the startup procedure - Do Not Close The Console
+
  
==Database Initialization==
+
<br>
  
Prerequisites
+
'''Instructions'''
  
Visit the 'User's Guide' if you need more information about any of the pre-requisites below.
+
<br>
  
    * Database has been installed
+
*Ensure database connection information matches database installation. OSEE is pre-configured to work with a PostgreSQL server running on port 5432. If you need a specialized database connection see the 'Configuring Database Connection' section.
    * Database server is running
+
*If using PostgreSQL, make sure the driver bundle has been installed on the client eclipse (available at [http://www.eclipse.org/osee/downloads/ downloads]).
    * A file system path has been selected for binary data storage. The system default the user's home directory.
+
**The zip file can be dragged and dropped on the install new software window.
    * An application server is running. See 'Application Server Launch' for more info.
+
**Uncheck the "Group items by category" for it to show up.
 +
*In a console from the client installation, launch the database initialization application by entering the following:
 +
<br>
  
'''Warning: This process will delete all data from OSEE Data Store. Make sure you are certain before running this process.'''
+
{| style="background:rgb(230,230,230);color:black; border:1px solid gray; font-family: fixedsys;text-align: left" cellpadding=20px cellspacing=0 width=80%
 +
|
 +
<nowiki>
 +
eclipsec -nosplash -application org.eclipse.osee.framework.database.init.configClient -vmargs -XX:MaxPermSize=256m -Xmx512m -Dosee.application.server=http://localhost:8089 -Dosee.default.log=INFO -Dosee.authentication.protocol=trustAll
 +
</nowiki>
 +
|}
 +
<br>
 +
*When prompted select "Y"
 +
*Wait for initialization to complete
  
Instructions
+
== Messaging Service ==
  
 +
OSEE utilizes the [http://en.wikipedia.org/wiki/Java_Message_Service Java Message Service (JMS) API] for loosely coupled, reliable, and asynchronous communication with OSEE clients.  You will need an implementation of this API such as [http://activemq.apache.org ActiveMQ] in order for clients to receive updates to cached artifacts that were modified by another client (remote events). Download the latest version from [http://activemq.apache.org/download.html here].
  
* Ensure database connection information matches database installation. OSEE is pre-configured to work with a PostgreSQL server running on port 5432. If you need a specialized database connection see the 'Configuring Database Connection' section.
+
==== Install ====
* In a console, launch the database initialization application by entering the following:
+
General installation [http://activemq.apache.org/getting-started.html#GettingStarted-InstallationProcedureforUnix instructions].
  
-- eclipse -nosplash -application org.eclipse.osee.framework.database.configClient -console
+
If you are downloading a release of ActiveMQ from the terminal and need to use an http proxy, this command will set up your proxy:
  -vmargs -XX:MaxPermSize=256m -Xmx512m -Dosee.application.server=http://localhost:8089
+
<pre>
* When prompted select "Y"
+
$ export http_proxy=http://proxy.host.com:1234
* Select 'ATS Configuration'
+
</pre>
* Wait for initialization to complete
+
 
 +
==== Start ====
 +
 
 +
General instructions on how to start ActiveMQ are [http://activemq.apache.org/getting-started.html#GettingStarted-StartingActiveMQ here].
 +
 
 +
To direct the OSEE client to use this service, in your launcher ini file, include the following Java system property:
 +
<pre>
 +
-Dosee.default.broker.uri=tcp://<localhost_or_your_server>:61616
 +
</pre>
  
 
==Launch & Configuration==
 
==Launch & Configuration==
  
Before you can launch OSEE, you will need the address of an arbitration server or an application server to access the OSEE data store. If you have questions regarding client/server interactions, visit 'Client/Server Overview'.
+
Before you can launch OSEE, you will need the address of an arbitration server or an application server to access the OSEE data store. If you have questions regarding client/server interactions, visit 'Client/Server Overview'.  If everything is on the same machine, the following examples will work.
Prerequisites
+
<br>
 +
<br>
 +
 
 +
'''Prerequisites'''
  
Visit the 'User's Guide' if you need more information about any of the prerequisites below.
+
* Database has been installed
 +
* Database server is running
 +
* A file system path has been selected for binary data storage. The system default the user's home directory.
  
    * Database has been installed
+
<br>
    * Database server is running
+
'''Application Server Launch Instructions'''
    * A file system path has been selected for binary data storage. The system default the user's home directory.
+
  
Application Server Launch Instructions
+
{| style="background:rgb(230,230,230);color:black; border:1px solid gray; font-family: fixedsys;text-align: left" cellpadding=20px cellspacing=0 width=80%
 +
|
 +
<nowiki>
 +
java -Dorg.osgi.service.http.port=8089 -Dosee.check.tag.queue.on.startup=true -Dosee.db.connection.id=<ConnectionId> -jar plugins/org.eclipse.equinox.launcher_<VersionForYourEclipse>.jar -console
 +
</nowiki>
 +
|}
 +
<br>
 +
For PostgreSQL:
 +
<br>
 +
{| style="background:rgb(230,230,230);color:black; border:1px solid gray; font-family: fixedsys;text-align: left" cellpadding=20px cellspacing=0 width=80%
 +
|
 +
<nowiki>
 +
runPostgresqlLocal.sh
 +
</nowiki>
 +
|}
  
  java -Dosee.log.default=INFO -Dorg.osgi.service.http.port=8089 -Dosgi.compatibility.bootdelegation=true -Xmx512m -Dosee.db.connection.id=postgresqlLocalhost -Dequinox.ds.debug=true -jar org.eclipse.osgi_3.4.0.v20080326.jar -console
+
<br>
  
OSEE Client Launch Instructions
+
'''OSEE Client Launch Instructions'''
  
'''COMING SOON'''
+
{| style="background:rgb(230,230,230);color:black; border:1px solid gray; font-family: fixedsys;text-align: left" cellpadding=20px cellspacing=0 width=80%
 +
|
 +
<nowiki>
 +
eclipse -vmargs -Xmx512m -Dosee.log.default=INFO -Dosee.application.server=http://localhost:8089 -Dosee.authentication.protocol=trustAll
 +
</nowiki>
 +
|}
  
 
==Configure a New Project in OSEE==
 
==Configure a New Project in OSEE==

Revision as of 14:25, 10 April 2017

What is OSEE?

The Open System Engineering Environment (OSEE) project provides a tightly integrated environment supporting lean principles across a product's full life-cycle in the context of an overall systems engineering approach. The system captures project data into a common user-defined data model providing bidirectional traceability, project health reporting, status, and metrics which seamlessly combine to form a coherent, accurate view of a project in real-time. By building on top of this data model, OSEE has been architected to provide an all-in-one solution to configuration management, requirements management, testing, validation, and project management. All of these work together to help an organization achieve lean objectives by reducing management activities, eliminating data duplication, reducing cycle-time through streamlined processes, and improving overall product quality through work flow standardization and early defect detection.

Installation and Initialization

Requirements

  • System with at least 4GB of RAM
  • Java Runtime Environment (JRE) 1.8
  • Eclipse Neon 2
  • Relational Databases: OSEE comes bundled with H2. For additional database support, see Supported Databases.

Eclipse Installation

To install OSEE: Start by downloading the OSEE Application Server and the OSEE Client Update Archive from the downloads page.

Quick Server Installation

If you are interested in a quick start, and are not setting up a custom database installation, setting up the OSEE server with the bundled HSQLDB database is simple.

  • Create a directory to place your server in, and unzip the downloaded server zip file (e.g. org.eclipse.osee.x.server.runtime.zip) into that directory.

You should end up with the following files and directories:

configuration
demo
eclipse
etc
plugins
runDemo.bat
runDemo.sh
runHsql.sh
runPostgreSqlLocal.sh
  • Edit the desired startup script file (e.g. "runDemo.bat") to provide the server the link to the binary data.

For example, if you were using Windows, and you installed to C:/UserData/OseeDemo, you would change the line in the batch file to:

-Dosee.application.server.data="C:/UserData/OseeDemo/demo/binary_data"
  • change to the etc directory, and edit the osee.hsql.json file.

Set the jdbc.server.db.data.path to the location of the hsql db. Following the example above, for instance, you would change the line in the json file to:

"jdbc.server.db.data.path": "file:c:/UserData/OseeDemo/demo/hsql/osee.hsql.db",

That completes the simple server setup. Run the server by setting up a command window, then running the script file to start the server. For example, if you were running with Windows, you would start a windows command shell, then run the "runDemo.bat" batch script. See Launch Application Server for details on running the server.

Client Installation

The OSEE client can be installed from within Eclipse like any other Eclipse plugin.

  1. Start Eclipse and select the menu item Help > Install New Software...
  2. Select the Available Software tab group and click the Add... button.
    Add site.png New update site.png
  3. In the Add Repository dialog, choose the Archive button, then navigate the file browser to the Client Update file downloaded in step one, "org.eclipse.osee.client.all.p2.zip". Please note that the use of the software you are about to access may be subject to third party terms and conditions and you are responsible for abiding by such terms and conditions.
  4. Click on the OK button to store update site information, "Eclipse OSEE Client All - (Incubation)".
  5. Select the OSEE update site entry and all features listed under its category. Click the Next button. AvailableSoftware.png
  6. If you receive a security popup Window regarding unsigned content, click OK.
  7. The update manager calculates dependencies and offers you a list of features to install. Select the needed ones and click the Next button.
  8. Accept terms of license agreement and click the Finish button in order to start the installation of selected features.AcceptTerms.png
  9. To apply installation changes click on the No button and shutdown Eclipse. It is important that you don't restart Eclipse until you have completed the database initialization steps below.

Restart dialog.png If you are using the default demo database and did the server quick start above, you just need to make one change to the eclipse eclipse.ini file - add the line

-Dosee.application.server=http://localhost:8089 to the end of the file.

Your installation is complete.

  • If you chose the quick server installation above, you can check to make sure the server is running in the command window, then start the OSEE client.
  • If you are using a custom database, then configure the database and initialize it before running the client.

Additional Configuration Options

  1. The following instructions apply if you are setting up a custom database, or if you are configuring OSEE for use by multiple users.
  2. Custom Data Base: Follow the instructions at Supported Databases to complete this step.
  3. Initialize the database with default OSEE data. See Database Initialization
  4. Setup config.ini and launch eclipse to start using OSEE Launch and Configuration
  5. You can find different OSEE perspectives, such as Define and ATS, and views in correspondent dialogs, activated by menu items Window > Open Perspective > Other... and Window > Show View > Other....
Open perspective.png Show view.png

Server Installation

  1. Download the server zip file from downloads.
  2. Unzip the file
  3. Set up the database (as described below)

Supported Databases

Data created and managed by OSEE is persisted into a data store divided into two sections. A relational database to store type, configuration, and small content (< 4000 bytes) and a remote file system to store larger binary content.

Before you can use OSEE, you will need to select and install a relational database suited for your needs and identify a file system path for binary content storage. OSEE provides support for the databases listed below. For launch and configuration instructions visit Launch and Configuration.

PostgreSQL Installation

Prerequisites

  • Ensure you have selected the best database for your needs

Instructions

  1. Download PostgreSQL from http://www.postgresql.org/download
  2. Follow PostgreSQL installation instructions
  3. By default, the PostgreSQL database server is configured to allow only local connections. If remote connections are to be allowed, edit postgresql.conf and pg_hba.conf to set the necessary

permissions. (To setup an unsecured database instance set listen_address to * in the postgresql.conf file and add the following line to the pg_hba.conf file: host all all 0.0.0.0/0 trust). These two files are located in the \PostgreSQL\<version>\data directory.

  1. Configure PostgreSQL for OSEE
    1. Launch pgAdmin (in windows Start->All Programs->PostgreSQL*->pgAdmin *)
    2. Double click on PostgreSQL Database Server (listed under Servers on the left hand side)
      1. If you are prompted for a password type the password selected during installation (user should be postgres by default)
    3. Create an "osee" user
      1. Right-click on Login/Group Roles (in the tree on the left hand side) and select "Create -> Login/Group Role..."
      2. Enter the following in the dialog:
        1. General Tab
          1. Name: osee
        2. Definition Tab
          1. Password: osee
        3. Privileges Tab
          1. Can login? Yes
          2. Superuser: Yes
          3. Create roles? Yes
          4. Create databases: Yes
          5. Update catalog? Yes
      3. Click 'Save'
      4. You should now have an "osee" user under Login Roles
    4. Expand the "Databases" item in the tree
      1. Create the "OSEE" database by right-clicking on "Databases" and selecting "Create -> Database..."
      2. Enter the following in the dialog:
        1. General Tab
          1. Database: OSEE
          2. Owner: osee
        2. Definition Tab
          1. Encoding: UTF-8
      3. Click 'Save'
      4. You should now have an "OSEE" Database under Databases
    5. Click on "OSEE" and then expand it, then expand "Schemas"
      1. Create the "osee" schema:
        1. Right click on "Schemas" and select "Create -> Schema..."
        2. Enter the following in the dialog:
          1. General Tab
            1. Name: osee
            2. Owner: osee
        3. Click 'Save'
        4. You should now have an "osee" schema under schemas
    6. The relational database is now configured. Proceed to OSEE Database Initialization

Launch Application Server

Prerequisites

  • Database has been installed

Instructions

  • Execute the launch script for your database and OS (if running from microdoc: http://osee.microdoc.com/node/2) - typical launch script names are runPostgresqlLocal.sh for a local Postgres on Unix and runH2.sh for H2 on Unix. It is straightforward to convert the downloaded scripts to Windows batch files.
    • If running PostgreSQL, be sure to add the driver bundle (downloads) to the server installation. Unzip the files into the server installation and add org.postgresql.driver@start to the bundles in config.ini. In addition, add the org.postgresql.driver_<version>.jar file to the plugins directory in the Eclipse installation.
  • Wait until server finishes the startup procedure - do not close the console
  • To check that the server has connected successfully to the database, enter the command osgi> osee server_status
  • You should see results similar to:

ServerStatus.jpg

Database Initialization

Prerequisites

Visit the 'User's Guide' if you need more information about any of the pre-requisites below.

  • Database has been installed
  • Database server is running
  • A file system path has been selected for binary data storage. The system default the user's home directory.
  • An application server is running. See 'Application Server Launch' for more info.


Warning: This process will delete all data from OSEE Data Store. Make sure you are certain before running this process.


Instructions


  • Ensure database connection information matches database installation. OSEE is pre-configured to work with a PostgreSQL server running on port 5432. If you need a specialized database connection see the 'Configuring Database Connection' section.
  • If using PostgreSQL, make sure the driver bundle has been installed on the client eclipse (available at downloads).
    • The zip file can be dragged and dropped on the install new software window.
    • Uncheck the "Group items by category" for it to show up.
  • In a console from the client installation, launch the database initialization application by entering the following:


eclipsec -nosplash -application org.eclipse.osee.framework.database.init.configClient -vmargs -XX:MaxPermSize=256m -Xmx512m -Dosee.application.server=http://localhost:8089 -Dosee.default.log=INFO -Dosee.authentication.protocol=trustAll


  • When prompted select "Y"
  • Wait for initialization to complete

Messaging Service

OSEE utilizes the Java Message Service (JMS) API for loosely coupled, reliable, and asynchronous communication with OSEE clients. You will need an implementation of this API such as ActiveMQ in order for clients to receive updates to cached artifacts that were modified by another client (remote events). Download the latest version from here.

Install

General installation instructions.

If you are downloading a release of ActiveMQ from the terminal and need to use an http proxy, this command will set up your proxy:

$ export http_proxy=http://proxy.host.com:1234

Start

General instructions on how to start ActiveMQ are here.

To direct the OSEE client to use this service, in your launcher ini file, include the following Java system property:

-Dosee.default.broker.uri=tcp://<localhost_or_your_server>:61616

Launch & Configuration

Before you can launch OSEE, you will need the address of an arbitration server or an application server to access the OSEE data store. If you have questions regarding client/server interactions, visit 'Client/Server Overview'. If everything is on the same machine, the following examples will work.

Prerequisites

  • Database has been installed
  • Database server is running
  • A file system path has been selected for binary data storage. The system default the user's home directory.


Application Server Launch Instructions

java -Dorg.osgi.service.http.port=8089 -Dosee.check.tag.queue.on.startup=true -Dosee.db.connection.id=<ConnectionId> -jar plugins/org.eclipse.equinox.launcher_<VersionForYourEclipse>.jar -console


For PostgreSQL:

runPostgresqlLocal.sh


OSEE Client Launch Instructions

eclipse -vmargs -Xmx512m -Dosee.log.default=INFO -Dosee.application.server=http://localhost:8089 -Dosee.authentication.protocol=trustAll

Configure a New Project in OSEE

  1. Create baseline branch
    1. From the Branch Manager's select parent branch -> open context menu -> select "branch" and enter new branch name
    2. From the Branch Manager's select new branch -> open context menu -> access control
      1. Add system administrators with Full Access
      2. Add Everyone with Read Access

Screencasts

The following screencasts provide an effective way to quickly learn what OSEE is and how it can be applied to your engineering project.

  • The OSEE Overview provides an overview of OSEE, including the driving forces that led to its creation, its architecture, the maturity of the application framework, and the status and maturity of the different applications that use the framework.
  • The OSEE Application Framework screencast introduces the application framework that OSEE applications use to persist their shared data. It also gives an introduction to the generic views and editors that are available to all OSEE applications.
  • The OSEE Demo Data Introduction introduces the data that is loaded into the OSEE Demo database for use by these screencasts. This helps the user understand how the data for an engineering environment fits into Application Framework and will help clarify the OSEE Define and OSEE ATS screencast demos.
  • The OSEE Define screencast introduces OSEE Define, the requirements and document management application that is built into OSEE. It will discuss the difference between requirements and document management and how both types are imported into OSEE. It will also introduce editing artifacts directly on the main branch, using working branches and show the basics of relating artifacts to each other.
  • The OSEE ATS screencast introduces OSEE ATS, the integrated configuration management/change request application built into OSEE. It will introduce the purpose of creating an integrated change management system, the terms and objects used in ATS, the benefits of integrated processes and configured workflows in an integrated environment and the scenarios of creating and transitioning an action to completion. It will also walk through a simple configuration of ATS for a new product and briefly introduce the peer review framework that is available.

Back to the top