http://www.tutorialspoint.com/eclipse/eclipse_perspectives.htm
If you close/lose views and editors, you can right-click on the perspective icon in tool bar or use the Window menu > Perspective > Reset Perspective. This will reset the perspective back to the default.
To easily see an editor or view in full screen mode, you can double-click the tab for that editor/view to maximize and again to restore to normal size.
You can drag views and editors off the workbench by grabbing the tab of that editor/view and dragging off the workbench to the desktop or another monitor. You can the drag back on to restore into workbench. In addition, you can duplicate your current workbench by choosing Window pulldown > New Window. This creates a duplicate workbench that can be used independently of the existing one. Selecting the Windows X will close that duplicate workbench.
We highly recommend going through the Workbench User Guide in Help menu > Help Contents. This will give a overview of how to use the workbench to it's full potential. You can also view the Help Contents on the web and go through the Eclipse Platform User Guide at https://help.eclipse.org/latest/index.jsp?nav=%2F0.
OSEE has a number of perspectives based on the included applications. All perspectives can be accessed through Window pulldown > Open Perspective. To easily navigate through OSEE developed perspectives, select the OSEE pulldown and select your desired perspective.
http://www.tutorialspoint.com/eclipse/eclipse_shortcuts.htm
Press F10 to activate the Menu bar
Press Ctrl+F7 to see a list of open views and editor area and switch to one of them.
Once you have gotten used to running one OSEE, you'll realize that you can run 2 or more. Or, if your a developer of OSEE applications, then you could have one for development, another for run-time testing and another for production use. It can get confusing to figure out which to switch to in a windowing environment.
OSEE provides the ability to override the icon shown in the Windows toolbar.
OSEE > ATS or Define Perspective > Enter “icon” in the navigator > Select “Set Workbench Override Icon”. > This opens an editor where you can select a 32x32 image to use as the application icon. > Select Run.
You'll now see that icon in the top left of your workbench and in the windowing toolbar.
Here are a few that you can use
Branch Manager > Select Branch > Open Associated Artifact > This will either open the Action or show the User that created the branch.
Branch Manager > Double-click branch > This opens an Artifact Explorer to the branch selected
When OSEE starts collecting many Baseline and Working branches, it may be nice to see the Baseline branches first before all the Working branches. By creating a Table Customization from the branch manager, this view and any branch selection dialog will sort/filter based on your saved and defaulted selection.
Sort and filter Branch Manager as you wish > Select Table Customization > Select Save Customization > Enter in customization name eg “Baseline First” > Select saved customization on left > select “Set as Default” > Select Ok in dialog.
You can show artifact types, versions and even valid attributes next to the name of the artifacts on a branch in Artifact Explorer. Simply use the white pulldown to select items you want to show. If you want to save these selections for future Artifact Explorers, just select “Store Label Settings”.
You can open a new Artifact Explorer using the “Open Artifact Explorer” button on the top right of the Artifact Explorer. It will open the new Explorer to the same branch as the one open.
For branches that were created from an ATS Action, the “Open Associated Action” button will open those Actions in ATS. If a branch was created manually by a user, it will show a dialog of the user that created the branch.
There is an easy way to open the selected artifact on another branch. Select that artifact > right-click > Reveal on Another Branch. This will open another Branch Manager and reveal the artifact on that branch.
Select the “Open Quick Search View” button. This will open the Quick Search view, set the selected branch to the same as the Artifact Explorer and place your cursor in the Search text box.
OSEE creates a web of artifacts and relations. The Artifact Explorer allows the user to easily navigate the Default Hierarchical relations. At times, it is nice to be able to easily navigate other relations. You can do this anytime by selecting the white triangle pulldown on the Artifact Explorer > select “Show Relations”. You will now see all relations that the artifact has.
You can easily create new related artifacts from the Artifact Explorer. Select the white triangle pulldown > select “Show Relations” > Select the artifact to add a related artifact to > right-click > select New Related. This will pop-up a dialog showing valid relations for this artifact. Follow the prompts to add a newly related artifact.
If you want to add a new artifact to an existing relation. Select the relation to add the artifact to > right-click > select New Related. This will pop-up a dialog showing valid relations for this artifact. Follow the prompts to add a newly related artifact.
Open Change Report via Branch Manager or ATS > Click the Customize icon in the top right > Search on “Last” in the ‘Hidden Columns’ list > Select ‘Last Modified Date’ and ‘Last Modified by’ and move to ‘Visible Columns’ > Select Ok
This will show the user that last modified the artifact and the time they did it. Refreshing the Change Report will refresh these values.
This section gives 2 videos on using the OSEE to author requirement changes using GitLab Markdown. The first is an explanation of our demo database that we use for these videos and demonstrations but can be skipped. The second gives a 6 minute walkthrough of using OSEE GitLab Markdown for requirements and other engineering artifact CM.
This section gives step by step videos on using the OSEE to author requirement changes. If you watch the videos in the following order, you will get a good overview of how to use OSEE to configuration manage requirements or other artifacts.
The Artifact Explorer allows a user to explore, read, edit and perform other operations on artifacts, like requirements, on a branch. This video shows a number of different ways to open this view.
If a set of changes are not needed, you can delete your working branch in order to cancel the work or create another working branch.
OSEE Actions (Problem Change Requests) can be assigned to one or more users to work. In addition, multiple teams can track their work in OSEE at the same time. Even things like Processes or even Facilities requests can be tracked. My World gives the easy ability to view all the items your assigned to in one place.
ATS was designed to be 100+ PCRs systems in one. You can write an action against one thing, and then add new workflows as you learn all the teams and products that are impacted for that action.
The “Action” is the top object that groups all the “Team Workflows (workflow)” that have work to be done.
A good example is a bug found in a software product. You can write an action against the “code” and you will get the “action” object and the “team workflow” object created. The “Team Workflow” is where the work is done by the Code Team. Now, let‘s say the coder determines that the problem isn’t a code issue, but a requirements one. You can add a new “Team Workflow” to the existing action against the “requirements”. You now have one “action” object and 2 “Team Workflows”. You can then cancel the Code workflow with a note that it‘s a requirements issue. Now, the requirements are changing which requires a test fix. You can add a Test “Team Workflow”. And, you realize that some tool changes will be needed, so you can add a Tool “Team Workflow”. You now have 4 teams doing work to fix the single “bug” that was found. Each team workflow is going through it’s own flow of work to complete the task.
Goal artifacts are used as an ordered list of Actions, Reviews and Tasks. If you want Actions written against an Actionable Item (AI) or Team Definition to be automatically be added to your Goal: Open an Artifact Explorer > Select to Common Branch > Open “Action Tracking System” > Expand down to find your AI or Team Definition > Open your Goal artifact in the ATS Editor > Select the “Workflow” tab > Expand the “Relations” section > Drag your AI or Team Definition to the “AutoAddActionToGoal” relation. > Save
Write or open an Action, Review or other ATS object and can't find it? Select “My Recently Visited” in the ATS Navigator to view all ATS objects viewed in the current OSEE session. This list gets cleared after restart.
Actions can be created in bulk by importing from a spreadsheet. Select “Import Actions Via Spreadsheet” in the ATS Navigator > push the “Open Excel Import Example Spreadsheet” button > Save this sheet off > Using the examples, add appropriate items to the existing columns and add new rows as desired > In OSEE, push the “Select File” button > select your spreadsheet > Select “Email POCs” if emails to assignees is desired > Select Goal to add to, if desired > Select Run
Open Workflow to add tasks to > Select “Tasks” tab > Select gear icon in upper right > Select “Import Tasks from Simple list” > Enter titles of tasks, one per line > Select Workflow state if tasks must be completed in a specific state > Select Assignees, if desired > Select Run
Actions are the top level ATS object that groups all Team Workflows that are need to be completed. As more information becomes available to the user, more Team Workflows may need to be created.
Open any Team Workflow in the Workflow Editor > Select “Actionable Items” hyperlink > using the right window, select any number of Actionable Items > Select Run
New workflows will be created in the same Action.
And advanced feature exists in ATS that will duplicate an existing workflow in the same action. This is good when the work being done by a team needs to tracked in separate Team Workflows.
Open Team Workflow to duplicate in Workflow Editor > Open “Operations” section at bottom of editor > Select “Duplicate Workflows” > Select approprate options depending on how you wish the new workflow to be created > Enter title for new workflow > Select Run
There are a number of ways to search ATS for what your looking for. Searching by Id includes ATS Id, GUID (system generated unique id) or Legacy PCR Id. Using specific searches in Navigator gives more detailed search options.
The ATS Navigator has a quick search field to quickly find open actions. This field will not only work for text, but also ATS ids (eg ATS10001) and system ids, like guids (A61fqvlZOGa83OyWbCQA) or artifact ids (12453).
The IC checkbox stands for “Include Completed/Cancelled” (cursor over to see tooltip notation). This will include completed and cancelled actions in the search.
Remember, as with any search you want to try to limit the result set that comes back.
The ATS User Search provides more searching criteria that would allow you to easily find an Action that was written by a user. Once common case is finding an Action that you originated.
OSEE > ATS Perspective > ATS Navigator > Select “User Search” > Select User > Select “Originator” checkbox and un-select “Assigned” > Check objects you want to search for, Workflows, Reviews or Tasks > Select Team that Action was written against, if desired > Select Search
As with any search, the more fined grained the criteria, the faster it will return and the closer to the answer you'll get.
You can also widen your search and use the advanced filtering, searching that ATS World provides to narrow in on what you're looking for.
There is an easy way to show all Actions that were targeted for a version associated with a team.
OSEE > ATS Perspective > ATS Navigator > Expand “Versions” > Select "Workflows Targeted-For Version > Select your Team > Select your version.
This will open an ATS World to show all the Workflows in that version.
Select the world icon or select “My World” in the list to show all workflows, tasks and reviews you are assigned to.
In the ATS Editor, you can select the yellow star in the menu bar and in ATS World, you can select items > right-click > Add to Favorites. This will mark these items as your favorites.
In the ATS Navigator, you can select the yellow star in the toolbar or “My Favorites” in the list. This will open an ATS World view of all items you have marked.
If you have created a branch or committed changes via ATS, you can easily open a Change Report by selecting the “Open Change Report by ID” > enter in ATS Id. Change Report for that ATS Workflow will open.
You can also select the “Open Change Report(s) by ID(s)” in the list to perform the same operation.
Select the “ID” toolbar icon > Enter in an ATS Id or a Legacy PCR Id or a guid. All items matching that id will be opened in ATS World. You can also open multiple items by entering in a comma delimited list of Ids.
ATS Team Definitions are configured with Team Leads, who automatically get assigned an Action when it's created, and Team Members, who have have extra configurations and permissions to operate on Team Workflows.
In addition, ATS has a feature that enables you to easily email Team Members, Team Leads or both.
Open OSEE > ATS Perspective > ATS Navigator > type “email” in filter box > You will see “Email Team Leads/Members”, “Email Team Leads” and “Email Team Members”. Select one of these > Select Team > Select “Include all children Team Definition Actions” if you wish > select “ok” > OSEE will open your configured mailtool with the appropriate email addresses based on your selection.
OSEE has a User Group artifact type with a Users relation. Create this artifact on the common branch and drag in User artifacts to this relation. Then, from ATS, Select “Email User Groups” and select the appropriate group. Osee will open your configured mail tool with the related User's email addresses.
Select "Email Message to Action(s) Assigness or Originator from the ATS Navigator > Drag in the Team Workflows, Tasks or Reviews into the “ATS Workflows” box > enter a subject > select the recipient (Assignees or Originator) > Enter the body of the message > Select Run.
The appropriate users will receive an email with your subject and message and the list of workflows that you selected which the user is an assignee or originator.
In the ATS Workflow Editor, select the “Action View” icon at the top of the editor. This will open a graphical representation of the “Action”, “Team Workflows”, “Reviews” and “Tasks”
To add a new Team Workflow to an action, select the “Actionable Items” hyperlink at the top of the ATS Editor. On the right pane, select the other Actionable Items that are impacted. New Team Workflows will be created as needed.
In the ATS Editor, select the “Open in World Editor”. This will open the object starting at the “Action”. Expand-all will show all items in the hierarchy.
Select the pulldown-menu next to the gear and select “Filter Out Completed/Cancelled”. You can also use the Ctrl-F hotkey.
Select the pulldown-menu next to the gear and select “Filter My Assignee”. You can also use the Ctrl-G hotkey.
You can easily open selected items in a World or Task View by selecting the World or Task icons in the top right of the editor. You can also right-click > Open With > and select the desired editor for the selected items.
The Defect table of a Peer Review only shows 5 lines by default which makes reading the defects difficult. In addition, the Description and Location columns are too narrow to see all the text. There are a few things you can do to help view this data easier.
Open Java File > Ctrl-F (search) > Select “Incremental” checkbox > Enter text to search. This will highlight the first occurrence of what you type as you type.
The XViewer is an advanced and dynamic Tree/Table Viewer that has the filtering and sorting the capabilities of a spreadsheet while providing the users the ability to customize their table to suit their current needs and save/restore these customizations for future use by individual or group.
OSEE has used this widget in many of it's views and editors including: Branch Manager, Results Editor, ATS World Editor, ATS Task Editor, Change Report Viewer, Commit Manager, Merge Manager etc...
There are many advanced features of the XViewer that will help organize and manipulate your view of whatever you're looking at.
Select any item inside the table > right-click > View Table Report. This will open an HTML view of the data. The top left options allow for emailing, printing and exporting to csv. The export to csv will write the file to disk and open whatever application is configure to view comma separated value files, like Excel or Open Office.
Within the current editor or view, select Ctrl-M to maximize. Select again to minimize.
Ctrl-Shift-E shows a dialog of all open editors with editor name and file path, if applicable. Options to select editor to open, close all editors and save selected editors.
OSEE stores versions of most text files as changes are made. You can access these versions to restore these changes. This includes a file or directory that was deleted. Select the file or folder in the Package Explorer > right-click > Restore from local history.
OSEE will show the ‘>>’ indicator after 4 to 8 files are opened. You can configure your workbench to automatically close editors automatically. Select Window pulldown menu > Preferences > General > Editors > select “Close editors automatically” > enter number of editors open before auto-close.
An OSEE Quick Search will open a search results view to show the results. A history of all searches is available by default. You can view previous searches by selecting the search history pulldown in the top right corner of the Search View.
If you want to show multiple search results views, you can > perform the first search > select the Pin icon in the top right > perform the second search. This will open a new results view.
OSEE stores every change made to every artifact. This is very usefull in determining who did what and when. In addition, these “transactions” can be purged, thus un-doing an operation that was made in error.
From any artifact > right-click > open-with > Resource History. This will display the Resource History View
Another way to show the changes made in OSEE, is too look at the Branch Transactions. This will show all the changes for that branch. There are two main ways to do this. First is thorugh the Branch Manager View.
The other is to open the Change Report Editor. On the Transactions tab, you'll see all the transactions listed.
You can also easily open the Transaction tab of the Change Report Editor by selecing a branch off the Branch Manager View > right-click > Branch Transaction Report
OSEE has a built in Problem Change Request and Configuration Management system called the Action Tracking System (ATS). This tracking system has some powerful features that supports Value Management
These are the intial requirements (user stories) for the inclusion of EV Work Package management in OSEE.
Work Package = Active account that has calculated and reported earned value. Planning Package = Planned work, not yet active. Activity Id = End user account to charge.
Note: Activity Id can be set on Team Workflow, Task, Goal and Reviews
Note: Activity Id can be set on Team Workflow, Task, Goal and Reviews
OSEE has a built in Problem Change Request and Configuration Management system called the Action Tracking System (ATS). This tracking system has some powerful features that supports Agile Software Development and SCRUM Software Development
The “Action” object in ATS exists to relate all the Team Workflows, Reviews and Tasks that are necessary to complete a single “action” such as “Make these changes to that widget”. The “Goal” object, in contrast, is used to group any ATS objects for any other purpose, such as an Agile backlog.
Goals can contain any Team Workflows, Reviews, Tasks and even other Goals. In addition ATS objects can belong to multiple Goals.
Items can be added to goals by one of the following methods
Goals are ordered which supports the need for a ordered backlog.
Items in the Goal members tab can be re-ordered by one of the following methods
Add the “Points” column and select points by
It is easy to sum the points column for the selected items when using the Points Column. Add the “Points” column > Select items to sum > Right-click the “Points” column header > Select “Sum Selected for Column” > a dialog will popup with the sum of points for the selected items.
There are a number of different ways to track Sprints in OSEE. Targeted Versions are normally used to track builds and releases, but could also be used to track Sprints. If Targeted Versions are already used for builds or releases, other text-based columns can be used. Among these are the “Notes” column or any of the 3 open “Category” columns.
A common characteristic in Agile is a daily stand-up or scrum meeting. These meetings are commonly held using a post-it-note task board. Another option is by showing the backlog Goal with current spring items at the top or by having another Goal containing only the current sprint items. The team members can call out the current item order number they finished and which they will work on next.
Since an Agile backlog is supposed to contain all items, ATS has a configuration that will automatically add new Team Workflows to any number of Goals. How to configure
OSEE has a number of existing features to easily create ATS objects for use in backlogs.
Among these are:
As OSEE is used more an more for Agile/Scrum, new features will be incorporated.
Some ideas for improvements are:
NOTE: These are ideas only and are not yet scheduled for implementation. As always, contributions to OSEE in this or any area are welcome.
There are a lot of features and capabilities available in the OSEE application. We've created a number of short videos to show these. We try to keep each video under two minutes and focus on a specific feature or task. These videos can also be shared for training purposes or as an answer to user support questions.