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).
• In the Artifact Explorer, click Select Branch...
  • Select "SAW_Bld_2"
  • Click "OK"
• Search for Item:
  • Click on the Quick Search view
  • Select the "SAW_Bld_2" branch
  • 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.

Workflow Endorsement

The Requirements Team Lead (Joe) has approved the Requirement Team Workflow and wants to transition to analysis.

• Set the Target Version to SAW_Bld_2.
• Change Priority to 2.
• Transition to the "Analyze" state.
  • This is where the lead would normally assign another user to complete the work; however, we will not change the assigned user for the demo.

Workflow Analysis

Here, Joe (as the Requirements Developer) wants to analyze the action.

• Input "Fix It" as the Proposed Resolution
• As this change will impact Code as well as Test, we will add corresponding workflows for each.
  • Click on the Actionable Items hyperlink
  • Select "SAW Code"
  • Select "SAW Test"
  • Click OK. The Action View will now show new workflows. Email notifications have been sent to the team leads.
• Transition to "Authorize".

Workflow Authorization

Here, the Requirements Team Lead (Joe again) authorizes the Action.

• Input "A324324A" as the Work Package.
• Since the Team Lead needs concurrence from Kay (the Manager), a decision review is needed.
  • Click the Add Decision Review hyperlink.
  • Fill-in the Create Decision Review dialog:
    • Review Title: "Any Problems with authorizing this?"
    • Associated state: "Authorize"
    • Click OK

Preparing the Decision Review

Here, the Requirements Lead prepares the review:

• Set Review Blocks to "Transition"
• Set Estimated Hours to 3
• Click Assignee(s)
  • Select "Alex Kay"
• Transition the review to "Decision"

Approving the change

First, Alex Kay has to check his assigned work.

• In the ATS Navigator, double click on My World and select Alex Kay as the user.
• From Alex Kay's User's World, select the "Decision Review"
• Alex Kay decides "yes;" we will simulate this with a Privileged Edit.
  • Click the Privileged Edit icon (second from the right).
  • Click Override and Edit.
  • Select "Yes" as the Decision.
  • Transition the Review to "Completed".

Completing the Authorization

Note that before Alex Kay had completed the decision review, Joe was not able to transition to the next state.

• Set Estimated Hours to "2.5".
• Transition to "Implement".

Implementing a Change

• From the Implement State, select the Create Working Branch icon (the leftmost icon).
• Using the Artifact Explorer, navigate to and right click the "Robot Object" software requirement.
  • From the context menu, select Open With > Artifact Editor.
• Under the Attributes tab, change Qualification Method to "Inspection" and save the file (File > Save).
• From the Artifact Editor's toolbar, select Open With > MS Word Edit, and, if prompted, specify that Word is to open the file as an XML document.
  • Insert into the document the next "Need more information here."
  • Save and close the document. The Artifact Editor's Word Template Content Attribute should update accordingly.
• Switch to the Workflow Editor and select the "Show Change Report" icon from the toolbar.