Revision as of 16:06, 23 November 2011

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 1GB of RAM
• Java Runtime Environment (JRE) 1.6 or higher
• Current Eclipse Release
• Relational Databases: OSEE comes bundled with H2. For additional database support, see Supported Databases.

Eclipse Installation

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

To install OSEE:

1. Start Eclipse and select the menu item Help > Install New Software...
2. Select the Available Software tab group and click the Add... button.
   
   
3. On the Add Site dialog copy the URL for the OSEE Client Incubation Update Site from downloads page. 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.
5. Select the OSEE update site entry and all features listed under its category. Click the Install button.
6. The update manager calculates dependencies and offers you a list of features to install. Select the needed ones and click the Next button.
7. Accept terms of license agreement and click the Finish button in order to start the download of selected features.
8. 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.

1. Before you can use OSEE you will need to install a relational database. Follow the instructions at Supported Databases to complete this step.
2. Initialize the database with default OSEE data. See Database Initialization
3. Setup config.ini and launch eclipse to start using OSEE Launch and Configuration
4. 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....

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.

H2 Installation

H2 is bundled with the OSEE Application Server and requires no additional installation.

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)
4. Configure PostgreSQL for OSEE
   1. Launch pgAdmin (in windows Start->All Programs->PostgreSQL*->pgAdmin III)
   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 Roles (at the bottom of the tree on the left hand side) and select "New Login Role..."
      2. Enter the following in the dialog:
         1. Role Name: osee
         2. "Can login" should be checked
         3. Password: osee
         4. Password (again): osee
         5. Role Privileges--select all of the following:
            1. Inherits rights from parent roles
            2. Superuser
            3. Can create database objects
            4. Can modify catalog directly
      3. Click 'OK'
      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 "New Database..."
      2. Enter the following in the dialog:
         1. Name: OSEE
         2. Owner: osee
         3. Encoding: UTF-8
      3. Click 'OK'
      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 "New Schema..."
         2. Enter the following in the dialog:
            1. Name: osee
            2. Owner: osee
         3. Click 'OK'
         4. You should now have an "osee" schema under schemas
      2. 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.
• 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 "tagger_stats". If all is well, you will get a list of statistics. If not, you will get an exception. If the database has not been initialized, exceptions regarding missing tables are OK.

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:

• 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

For PostgreSQL:

OSEE Client Launch Instructions

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 Demo Introduction Screencast presents preliminary material and introduces the other available screencasts.

• 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.