UCE CASE EDITOR (UCE) 5.2 - USER
GUIDE
[UBET Installation
& Setup][MSE User Guide][UCE User Guide]
This document describes several aspects of the Use Case Editor (UCE) user interface. Some general points are worth mentioning before describing individual features.
At most one edge can connect two nodes in a
single direction.
The start node will only accept a message
tail(s)
The stop node will only accept the arrow-head(s)
end of the edge.
The following features are described further in this document
In addition to the scroll bars that allow the user to reposition the Use Case Graph, UCE supports mouse interactions with the nodes and edges of the graph, a menu bar and toolbar. These are described below. Before starting to describe UCE, here is a snap shot of an example use case presented in UCE.
|

The menu bar shown above supports the actions shown in the following table.
Menu |
Description |
| File | File management, preferences and the printer |
| Edit | Supports use case graph edit operations as well as undo/redo |
| View | Supports operations that affect what the user sees on the screen. |
| Tools | Provides access to reports such as use case comparison (UCG Difference Report) and reference tags (Reference Tags Reports and Comparisons) |
| Scenarios | Supports scenario operations |
| Help | Provides access to the UBET user guide, tutorial, home page, and bug reporting |
The file menu is used for interactions (Open, Export, etc.) with external files, preferences and printers, and global operations such as clearing context (New, Open) for MSE. The following operations are supported:

MENU ITEM |
DESCRIPTION |
| New | Readies the application for a new graph. Existing graph is cleared out and current context is reset. If changes have been made to the existing graph and not saved, the user is notified and allowed to save the graph. The start node is placed automatically into the canvas when creating a new graph. |
| Open... | Existing graph and context are cleared, and a dialog window is started to open a Use Case Graph. If changes have been made to the existing graph and not saved, the user is notified and allowed to save the graph. |
| Save | Current graph is saved to the already open Use Case Graph file. |
| Save As... | Starts a dialog window to save as a new Use Case Graph (current file becomes that file). |
| Image Generation | Starts a dialog window that will allow the user to generate GIF, MIF adn PS files. GIF images can be used in HTML pages and can be imported into MS Word. One can also produce at the same time a file containing a table with the list of reference tags used in the drawing that can be imported into Word. The file name has the same root as the GIF and a .csv suffix. Image Generation Look & Feel. |
| Export... | Starts a dialog to save current data in a non-native format (other than a Use Case Graph). Currently, five export formats are supported (HTML Output, Test Cases (TUCG), Spin Model (SPIN), Virtual Finate State Machine (VFSM) and TestMaster Model). Please note that the MIF, GIF and PS exports are now located in the Image Generation Menu Item. Export look & feel. |
| Preferences... | Brings up a dialog window that allows the user to set environment preferences. Preferences Look & Feel. |
| Sends the drawing directly to the default printer. | |
| Print Preview... (Solaris only) |
Previews the drawing. |
| Print Setup & Preview... (Windows 95/NT) | Brings up another view allowing the user to set printer characteristics and preview the print pages. |
| Print Setup... (Solaris only) |
Brings a window to set up the print and the preview commands and other postscript printing options in the UNIX environment. Print Setup Look & Feel. |
| Exit | Exits the editor (UCE). If changes have been made to the graph, the user is notified and allowed to save the graph, the application will exit immediately after saving the file. |
The Edit Menu controls use case graph edit operations.

MENU ITEM |
DESCRIPTION |
| Undo | Undo changes. User can repeatedly undo edits to the first performed on the current file. |
| Redo | Redo an undone operation. |
| Select | Enters to select mode, the default mode.
Objects can be selected or moved around. Edge attachment can be changed. To select
more than one node, use control-click. Use this menu item or the select button |
| Add Node | Enters to add node mode. While in this mode each click on the canvas adds a new node. |
| Add Edge | Enters to add edge mode. While in this mode, clicking on one node (it will color the node in red), then another will create a new edge. |
| Add Start Node | Automatically adds a single start node to the canvas. |
| Add Stop Node | Add a single stop node to the graph. |
| Delete Object | Enters to delete object mode. Clicking on a node deletes the node and all its edges. Clicking on an edge deletes the edge. Note: Before deleting a node move around any edges that need to be re-arranged. |
| Subgraph | The subgraph item has two submenus, New and Preview. New creates a new subgraph. Preview simply shows a temporary copy of the selected nodes as a subgraph. Additional information is available on subgraphing or by reading subgraphing.txt . |
| Auto Number | Auto Number allows the user to manage Note numbers for referencing graph objects (nodes and edges) from external documents. Additional information is available for autonumbering. |
| File Type | It assigns a type to the current file. The type could be "USES", "EXTENDS" or "NONE". When opening a file that was created with older releases the type will be assign to "NONE". Additional information is available for "File Type". |
The view menu is used to control the appearance of the application.

MENU ITEM |
DESCRIPTION |
| Redraw | Redraws the image. It positions the edges labels to the right of the edge. It does not means that it will necessarily fit the image in the window. |
| Fit | Fits the drawing to the current window. Fits its typically used after resizing the window. |
| Zoom | Zoom contains a submenu that allows the user to make the size of the drawing Larger (Zoom In), or Smaller (Zoom Out). |
| Show annotation window | Hide/un-hide the annotation window. See more detail about annotation. |
| Show Edge Label | Toggles the visibility of edge labels. Note: Node labels are not affected by this action. |
| Show Attributes | Toggles the display of object attributes, such as reference tags. |
| Enable Tool Tips | Toggles the display of tool tips. |
| Show Numbers | Toggles the display of Note Numbers. |
| Show Node + Strongly Connected Components | Shows the selected node and its strongly connected components. Strongly connected components (Scc) refers to a set of nodes in which a path can be found from each node to all others in the set. |
| Show Context of Node + Strongly Connected Components | Shows the context of the selected node and its strongly connected components. Node context is an I/O view of a node, highlighting its incoming and outgoing edges. Strongly connected components (Scc) refers to a set of nodes in which a path can be found from each node to all others in the set. |
| Show All Strongly Connected Component | Highlights each strongly connected component set in a different color. Strongly connected components (Scc) refers to a set of nodes in which a path can be found from each node to all others in the set. |
| Show Root | Highlights the root nodes. A root node is a node from which all other nodes can be reached. It is not necessarily a node without predecessors. |
| Show Leaves | Highlights all leaves (nodes without outgoing edges). |
| Show Node Context | Shows its (node selected) input edges in red and output edges in blue. Node context is an I/O view of a node, highlighting its incoming and outgoing edges. |
| Static Menu | Brings up a persistent menu holding many convenient commands. Useful for repeated operations. Static Menu Look & Feel. |
Tools Menu
The tools menu holds access to useful reports.
MENU ITEM |
DESCRIPTION |
| Reference Tag Report | This starts the reference tag report utility. |
| Reference Tag Comparison | This starts the reference tag comparison utility. |
| UCG Difference Report | Compares the current use case with some other use case (normally a predecessor use case). |
| Validation Check report | The validation check will create a report. The report will include any inconsistency between the current data in the current graph and the data type saved of the file link to the node. See more detail in Validation ... |
Scenario Menu
The scenario is used to display, create, update, delete and audit named scenarios associated with the current use case graph.
| MENU ITEM | DESCRIPTION |
| New Scenario | Allows the user to define the path for a new scenario |
| Open Scenario | Brings up a window with a list of scenarios from which the user can select from. The path of that scenario will be displayed on the use case graph. Open Scenario Look & Feel. |
| Display Scenarios | Display one or more scenarios using a persistent select window. Only one scenario can be viewed at the same time. Display Scenario Look & Feel. |
| Stash Scenario | Stash new features of the current scenario. |
| Stash Scenario As | Brings up a dialog window that allows the user to enter a name for the new scenario. |
| Delete Scenario | Brings up a dialog window that allows the user to select the scenario to be deleted. Delete Scenario Look & Feel. |
| Delete Fragment | Invokes a dialog that allows to view the list of scenario fragments and delete them from memory inside the dialog.Delete Fragment Look & Feel. |
| Generate Scenarios | Generates MSCs from the scenario, its subgraphs' scenarios and their referenced .itu file. |
| Parameterized Scenario Generation | Let users change parameters without affecting his/hers preference settings. Parameterized Scenario Generation Look & Feel. |
| Scenario Audit | Check for missing or extra nodes in scenario definitions. |
| Unset Path | Removes path highlighting. |
| Scenario Text | Displays a table showing all nodes in the current scenario as wells as information about their partitioning into fragments (broken scenario parts). Scenario Text Look & Feel. |
Help Menu
The help menu is disabled. UBET documentation was included in the zip file which was part of the software download.

The toolbar shown above supports the actions shown in the following table. In the table below, several of the buttons start mode operations. (Mode operations are presented as green text to help you to distinguish them). All mode operations can be disabled by:
Top Row
BUTTON |
ACTION |
|
New Starts a new use case graph. Existing graph is cleared out and current context is reset. It automatically places a start node in the canvas. |
|
Open Existing graph and context are cleared, and a dialog window is started to open a Use Case Graph. |
|
Save Current trace is saved to the open Use Case Graph. |
|
Print Sends the drawing directly to the default printer. |
|
Select Mode Enters to select mode, the default mode. Objects can be selected or moved around. Edge attachment can be changed. To select more than one node, use control-click. Use this button to exit other modes. |
|
Add Nodes Enters to add node mode. Each click on the canvas creates a new node. |
|
Add Edges Enters to add edge mode. While in this mode, clicking on one node, then another will create a new edge. |
|
Add Start Node Creates a start node. Click on the canvas to add a start node: required for several generation programs. |
|
Add Stop Node Creates a stop node by clicking on the canvas. Good use case graphs end all scenarios in a stop node. Currently, only one stop node is allowed in a graph. |
|
Delete Enters to delete object mode. Clicking on a node deletes the node and its edges. Clicking on an edge deletes the edge. Note: Before deleting a node move around any edges that need to be re-arranged. |
|
Undo Last Change Cancel the last change. Clicking multiple times will eventually step back to the beginning of the session. Warning: Currently does not support scenario changes. |
|
Redo last Undo Reverses the action of Undo. |
|
Re-sequence node numbers Resequence any existing node note numbers. |
|
Re-sequence edge numbers Resequence any existing edge note numbers. |
|
Hide/un-hide annotation window. For more details visit annotation. |
Bottom Row
BUTTON |
ACTION |
|
New Scenario Enters to scenario mode. Start to create a new scenario by defining the scenario path. The user can incrementally build a Path (scenario) through the graph -- clicking at nodes along the path one at a time. The nodes need not be adjacent, but they must be connected via zero or more intermediate nodes. |
|
Open Scenario Provides a dialog window to let user to open an existing scenario by selecting its name. Choosing one, displays the scenario and enters Scenario Mode so the scenario can modified. |
|
Stash Scenario Stash the current scenario. If it is a new scenario, a new name is requested. |
|
Generate Scenario Generates MSCs from the scenario, its subgraphs' scenarios and their referenced .itu file. |
|
Redraw Redraw the graph. This is useful after changes have been made (i.e. nodes/edges added, deleted or moved). The graph is replotted. |
|
Fit Graph in Canvas Make the graph roughly the size of the canvas. Fit is typically used after resizing the window. |
|
Show Node + Strongly Connected
Components Shows the selected node and its strongly connected components. Strongly connected components (Scc) refers to a set of nodes in which a path can be found from each node to all others in the set. |
|
Show Context of Node + Strongly
Connected Components Shows the context of the selected node and its strongly connected components. Node context is an I/O view of a node, highlighting its incoming and outgoing edges. Strongly connected components (Scc) refers to a set of nodes in which a path can be found from each node to all others in the set. |
|
Show All Strongly Connected Components Highlights each strongly connected component set in a different color. Strongly connected components (Scc) refers to a set of nodes in which a path can be found from each node to all others in the set. |
|
Show Root Highlights the root nodes. A root node is a node from which all other nodes can be reached. It is not necessarily a node without predecessors. |
|
Show Leaves Highlights all leaves (nodes without outgoing edges). |
|
Show Node Context Shows its (node selected) input edges in red and output edges in blue. Node context is an I/O view of a node, highlighting its incoming and outgoing edges. |
Object Menus provide a simple and intuitive method for invoking functionalities related to the particular objects. In UCE, three types of object menus are supported: Canvas (background), Nodes and Edges.
Canvas Menu
To invoke the canvas menu instance, click and hold the Menu button on the mouse over any white spaces away from the graph on the scrollable canvas. The canvas menu will appear, it looks like this:

While holding down on the Menu button, drag the mouse down to the function desired and then release. Some window managers will maintain the canvas menu (or any menu selected with the menu button of the mouse) open without having to hold the button of the mouse until the user makes his/her selection or click elsewhere.
MENU ITEM DESCRIPTION Redraw Redraws the graph New Scenario, Open Scenario, Stash Scenario, Unset Path, Scenario Text Refer to Scenario Menu Subgraph, Auto Number Refer to Edit Menu Uninline All Returns the graph to its normal view. Uninlines all the subgraphs. Clear All Context Stops any mode operations and returns the tool to the select state.
Node Menu
To invoke the node menu (instance), click and hold the Menu button on the mouse over the node's label. A node menu instance will appear, it looks like this:

While holding down on the Menu button, drag the mouse down to the function desired and then release the Menu button to select it.
| MENU ITEM | DESCRIPTION |
| Properties... | Invoke the Node Properties dialog for editing the node's label, MSC and/or Subgraph Links, node number and reference tags. Node Properties Look & Feel. |
| Inline "file.ucg" | If the file has a subgraph linked to that node, this option will be enabled. It inlines the subgraph as part of the graph. |
| Edit "file.ucg" (UCG) | If the file has a subgraph linked to that node, this option will be enabled. It brings a new UCE window with the subgraph open to allow the user make changes on it. |
| Edit "file.itu" (MSG) | If the file has a message sequence chart (msc) linked to that node, this option will be enabled. It brings a new MSE (Message Sequence Editor) window with the msc open to allow the user make changes on it. |
| Open References | If the node contains reference tags, the Open References submenu containing entries for each reference tag will be enabled. |
| Delete | Deletes this (the current) node and all edges connected to it |
| Truncate Path | It brakes the path from this node on. It takes the current node and any other nodes connected through this out of the scenario path. |
Edge Menu
To invoke the edge menu (instance), click and hold the Menu button on the mouse over the node's label. An edge menu instance will appear, it looks like this:

While holding down on the Menu button, drag the mouse down to the function desired and then release the Menu button to select it.
| MENU ITEM | DESCRIPTION |
| Properties... | Invoke the Edge Properties dialog for editing the edge's label, edge number and reference tags. Edge Properties Look & Feel. |
| Open References | If the edge contains reference tags, the Open References submenu containing entries for each reference tag will be enabled. |
| Delete | Deletes this (the current) edge |
This section's goal is to show how the mix and match of Mode, the Mouse Action and the Context get together to create a different action through UCE.
Mode |
Mouse Action |
Context |
Description |
| Any | Escape Key | any time | Clear all contexts and operations. Return to Select Mode. |
| Any | Menu button | on node label | bring up node menu instance |
| Any | Menu button | anywhere on edge | bring up edge menu instance |
| Any | Menu button | anywhere on canvas | bring up canvas menu instance |
| Any | Mouse Over | any object label | show tooltip for object |
| Select |
Select | any node label | direct edit label |
| Select |
Select | any edge label | direct edit label |
| Select |
Select+Move | any node | move node |
| Select |
Select+Move | end of edge | move edge to another node |
| Add Node |
Select | anywhere on canvas | add a node |
| Add Edge |
Select | source node then destination node | add an edge |
| Delete |
Select | any object | delete the object |
| Context |
Select | on node label | show all in and out links |
| Scenario |
Select | on start node label and subsequent node labels separated by 1 edge | build path |
| Scenario |
Select | on start node label and end node label separated by > 1 edge | build the shortest path |
| Scenario |
Control-Select | anywhere on canvas | undo the path |
| Strongly Connected Components (SCC) |
Select | on node label | highlight the node plus it's strongly connected components |
| Context of Node + Strongly Connected Components |
Select | on node label | highlight the node plus it's scc and shows the scc links |