Quick Start for Installing OSEE

Prerequisites for installation

System with at least 16 GB of RAM
Java JDK 1.11 or greater
Recent version of Git

OSEE Installation Steps

Download and install the latest JDK

Website for download: [Eclipse Temurin](https://projects.eclipse.org/projects/adoptium.temurin/downloads)

Download and install git

Website for download: [Git - Downloading Package](https://git-scm.com/download/win)

image:1_-_git_windows_download.png

Run the git executable

Adjusting your PATH environment

Use Git and optional Unix tools from the Command Prompt

Choosing HTTPS transport backend

Use the OpenSSL library

Configuring the line ending conversions

Checkout as-is, commit as-is

Configuring the terminal emulator to use with Git Bash

MinTTY

Leave the rest of the settings as default

Set up the proxy for git

If you haven't registered with eclipse, register and log in to
eclipse.org
Clone the repository (see the code block below for an example of cloning the repository)

$ cd /c/Code/ $ mkdir git_main $ cd git_main $ git clone https://github.com/eclipse-osee/org.eclipse.osee.git --branch main --depth 1

Download and install the org.eclipse version of OSEE from the OSEE site

Website for download: [Eclipse Nightly Build Downloads](https://ci.eclipse.org/osee/job/osee_nightly/lastSuccessfulBuild/artifact/org.eclipse.osee/plugins/org.eclipse.osee.client.all.product/target/products/)
This will be the most recent nightly build. If you are running Windows OS, choose the download similar to the picture just below:

image:updatedimageeclipsedownloads.png

Make an Eclipse folder

For example: /c/Code/Eclipse

Extract all of the files from the eclipse download into your Eclipse folder.
When you run eclipse, it will ask to make a workspace. Make a workspaces folder.

For example: /c/Code/Eclipse/workspaces
Tip: Placing all workspaces within a single folder makes it easier to locate each workspace.

Make a folder to use for your first workspace.

For example: /c/Code/Eclipse/workspaces/first_git_main

OSEE Workspace Setup

Import Projects

Run the eclipse instance by switching to its directory and double clicking ‘osee.exe’

For example: ‘osee.exe’ would be located in ‘/c/Code/Eclipse/workspaces/first_git_main’

Select the directory of your first workspace and launch

image:3_-_directory_of_first_workspace.png

Close the welcome window

image:4_-_welcome_window.png

Switch to the Git Perspective

image:5_-_switch_to_git_perspective.png

Add an existing local Git repository

image:6_-_add_an_existing_local_git_repo.png

Search, select, and add the org.eclipse.osee Git repository

image:7_-_select_and_add_the_org.eclipse.osee_git_repo.png

Right click on the imported Git repository and select ‘Import Projects…

image:8_-_import_projects.png

Uncheck the following folders if present (click ‘Finish’ upon completion):

org.eclipse.osee
org.eclipse.osee\plugins\org.eclipse.osee.icteam.ui

image:9_-_deselect_folders.png

Set Preferences

Double check to make sure the OSEE environment you are pulling code into matches the code you have.

e.g. if you are developing for the dev line, make sure your osee is a dev version.

Import OSEE Team Preferences

Switch back to the Java Perspective, then File → Import, in the import wizard, select General → Preferences and click Next
In the From preference file: input box, enter the path to the preferences (substitute your directory for {git dir}) in the From preference file:
Browse to {git dir}\org.eclipse.osee\plugins\org.eclipse.osee.support.config then select the preference file: osee_team_preferences.epf and click Open.
Leave "Import All" checked and Choose Finish. Accept the prompt to restart the IDE.

Set Target Platform

Select Window → Preferences
Expand Plug-in Development → Target Platform
Check OSEE Client Server Target Platform
Click Apply then Apply and Close

Turn Project → Build Automatically back on
Remove errors that we do not care about

In the Problems tab at the bottom of OSEE, select the white triangle icon on the right side
Choose Filters...
Uncheck Show all items
Choose New under Configurations
Deselect "Errors / Warnings on Project", then make sure New Configuration is both selected and highlighted
Under Types, click Deselect All for the errors
Go through the list of types selecting all Java, Javascript, and Plug-in Problems
Click Apply and Close

Remove Null Analysis Errors

Choose Window → Preferences → Java → Compiler → Errors/Warnings
Expand Null Analysis and set the following to Warning instead of Error
Null pointer access
Potential null pointer access
Redundant null check
Uncheck Enable annotation-based null analysis
Click Apply (which will prompt to rebuild all) then Apply and Close
After the rebuild there should no longer be any errors, otherwise ask your Mentor

Running the Application Server

Switch to the Debug Perspective
Click on the dropdown arrow next to the debug icon
Click 'Debug Configurations…'

image:10_-_debug_config_dropdown.png

Double-click 'OSEE_Application_Server_[HSQLDB]'

image:11_-_application_server.png

Wait until the console produces this output:

image:12_-_application_server_output.png

Open 'Debug Configurations…' (again)
Double-click 'AtsIde_Integration_TestSuite'

image:atstestschoice.png

Wait until the JUnit test completes

If the ‘Runs’ reach a stopping point, terminate the test by pressing the red square icon.

image:14_-_test_suite_expected_output.png

Open 'Debug Configurations…' (again)
Double-click 'OSEE_IDE_[localhost]'

image:15_-_eclipse_client.png

You should expect an application that appears as such:

image:16_-_expected_client.png

Quick Start Complete

The additional sections below describe how to download and run the OSEE as a client server installation.

Below here 'there be dragons' e.g. the documentation was written a while ago and needs to be updated - it may have bad links or incorrect instructions

Getting_Started

		Installation and Initialization