Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
OSEE/Tutorial
This page is being adapted from this presentation.
Requirements
System Requirements
OSEE requires a system with at least 1GB of RAM running JRE 1.6 or higher. Microsoft Office is useful for the demo.
Eclipse Dependencies
The following Eclipse dependencies are required, although it is easiest to simply use the Ganymede Eclipse install.
- Eclipse 3.4.2 SDK
- org.eclipse.gef
- org.eclipse.draw2d
- org.eclipse.birt
- org.eclipse.datatools
Installation
Database
Install PostgreSQL using the following settings:
- Default install path and data directory
- Password "Postgre1"
- Port 5432
- Default locale
- On the final screen, ensure that "Launch Stack Builder" is not selected
After saving the database password using pgadmin, run the osee_db_setup script, which is located under the "PostgreSql" folder.
More on PostgreSQL installation
Java Runtime Environment (JRE)
Ensure that the directory in which the JRE is installed is in the path by typing "java --version" at a command prompt.
OSEE Client
Extract and launch Eclipse. From the update manager, install the update sites located under "OseeClient":
- org.eclipse.osee_integration_build_incubation.zip
- osee.add.ons.updatesite.zip osee.add.ons.updatesite.zip
Initialization
Launch Application Server
Execute the osee_app_server script located under "OseeApplicationServer" and wait until the server finishes the start up procedure before closing the console.
Database Initialization
In a command prompt, change to the Eclipse install directory and execute the following command:
eclipsec -application org.eclipse.osee.framework.database.configClient -vmargs -Xmx512m -Dosee.log.default=INFO -Dosee.application.server=http://localhost:8089 -Dosee.authentication.protocol=trustAll -Dosee.prompt.on.db.init=false -Dosee.choice.on.db.init="OSEE Demo Database"
Once db init closes, type "exit" in the server console.
Populate Demo Data
Launch the Application Server and then the OSEE client with the following command:
eclipse -vmargs -Xmx512m -Dosee.application.server=http://localhost:8089 -Dosee.authentication.protocol=demo
Switch to the ATS perspective (Window > Open Perspective > ATS); in the ATS Navigator window, enter "Populate" as the filter and press Enter, then double click on the "Populate Demo Actions" item.
Case Study
Scenario
User Joe Smith finds a problem in a requirement impacting multiple teams, namely Code, Test, Website, and IT. Multiple reviews will be needed:
- Decision Review (off Code Team Workflow)
- Peer Review (off Test Team Workflow)
In addition, certain tasks will need to be performed off Code Team Workflow.
Requirements Search
- Switch to the Define perspective (Window > Open Perspective > Define).
- Click "Select Branch..."
- Select "SAW_Bld_2"
- Click "OK"
- Search for Item:
- Click on the Quick Search view
- Enter "robot object" in the search string text box
- Check the "Match Word Order" option
- Check the "All Match Locations" option
- Click the search button
Exploring the requirement
- The search results will be listed in a tree or list view with match locations. We want to explore the robot object requirement. From the search result list (not tree),
- Right click on the "Robot Object" software requirement
- Select each of the following from the pop-up menu individually
- Reveal Artifact in Explorer
- Resource History
- Open With > Artifact Editor
- Open the "Attribute" tab
- Open the "Relation" tab
- Open with > MS Word Preview
- Convert file from XML Document
- Sky Walker
- Here, we can see how the "Robot Object" software requirement relates to other artifacts.
Creating an action
We want to create an action against the "Robot Object Requirement."
- Switch to the ATS Perspective (Window > Open Perspective > ATS).
- Click on the New Action icon () in the ATS Navigator.
- Fill in the "Create ATS Action Dialog"
- Enter "Robot Object requirement needs more detail" as the Title
- Select "SAW Requirements" (under "SAW CSCI") as the Actionable Item
- Click "Next"
- Fill in the fields as follows:
- Description: "See title"
- Change Type: "Problem"
- Priority: "3"
- User Community: "Program_1"
- Click "Finish". Joe Smith will automatically be assigned to team lead.
- Fill in the "Create ATS Action Dialog"