Installation and Initialization
Previous Next
Introduction Screencasts

Installation and Initialization

Requirements

Eclipse Installation

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

To install OSEE:

  1. Download the OSEE Application Server and the OSEE Client Update Archive from the downloads page.
  2. Start Eclipse and select the menu item Help > Install New Software...
  3. Select the Available Software tab group and click the Add... button.

  4. In the Add Repository dialog, choose the Archive button, then navigate the file browser to the Client Update file downloaded in step one. 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.
  5. Click on the OK button to store update site information.
  6. Select the OSEE update site entry and all features listed under its category. Click the Next button.
  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.
  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.

  1. If you are using the default demo database, you can skip the database installation and initialization and go to the configuration step.
  2. Before you can use OSEE you will need to install a relational database. 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....

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. You can skip down to the instructions for Launching the Server.

PostgreSQL Installation

Prerequisites

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

Instructions

File:ServerStatus.jpg

Database Initialization

Prerequisites

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


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


Instructions




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


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
Previous Introduction Next
Introduction Screencasts