UCE CASE EDITOR (UCE) - OPERATIONS


[UBET Installation & Setup][MSE User Guide][UCE User Guide]


This page describes user operations supported by the Use Case Editor (UCE).


Starting up with UCE

Launching UCE

On Windows 95 or NT, an icon for UCE  is placed in the UBET program group during installation.  Double clicking it will start UCE.  Entries are made in the registry during installation so that Use Case Graphs (UCG) are recognized by the operating system and are identified with the same icon.  Thus users may use Explorer to locate them and launch UCE by double clicking them.

On Solaris 2.5, make sure your environment has been set up for UBET. Click here if you need more detail. At your prompt, type the command, uce, to start the Use Case Editor.

Setting Up Environment Preferences

Users can set several preferences that help structure their environment and make working with UCE (and other parts of UBET) much easier.  The two most important for UCE are the Startup Directory and Reference Directory.  Taking advantage of these will greatly reduce the user's need to browse through directories to find design objects.  Use the UCE menu entry File/Preferences... to set them. The first six fields: AUTHOR, EMAIL, PHONE, PROJECT, GROUP and DEPARTMENT allow the user to capture their information in order to support any sort of output. This information currently is available for the HTML export feature only, but it will be available to any output in the short term.This displays the following dialog:

uce_preferences.gif (9777 bytes)

Location Preferences
Preferences 

Description

Miscelaneous fields: Author - Email - Phone - Project, etc. Allow to capture user information that can be used in UBET outputs. Currently HTML export use the information on these fields.
Start Up Directory The Start Up Directory field identifies the default start up directory for UBET. It is a convenience. If MSE or UCE is called without a file name on the command line, it starts in this directory.
Document Directory The Document Directory field identifies the path to the root directory where the Microsoft Word reference documents are located.The Create or Edit Reference Tag dialog automatically opens to this directory, showing all files that have a .doc suffix. 

                  UCE Parameter Settings

 Setting  Description
Filename in title for printed output Includes the file name as part of the title in printed outputs
Path in title for printed output Includes the path to the file as part of the title printed outputs. See Note on filename in output file.
Date and time in title for printed output Includes the date/time as part of the title printed outputs. See Note on filename in output file.
Use Images in Toolbar The tool bar is displayed with images, otherwise, the tool bar buttons display only text.
Use Scenario Generation Defaults This is a new preference for accepting the default parameters. It will allow the user to rapidly generate scenarios without being prompted for things like output directory and file prefix. 
Use Match Any Label Attribute for Edges This is a new preference that allows the users to turn on/off this feature. For more information about this feature please follow this link.  
Generate Textual Scenario Report The textual report provides complete information of the list of nodes in the particular UCG and the associated ITU files used to generate the scenario. There will be a textual report for each sceario file generated. The list of textual reports will also be presented along with the sceario files in the sceanrio list for easy viewing. 
InLine Methods The methods for mapping edge names between an upper level use case and a subgraph are supported. These are described below (Inline Methods).
Show unmapped lower level edge diagnostics A message box is shown during inlining if a lower level edge does not match an upper level edge if this is checked and the user has also checked the Strict InLine method. Otherwise, these diagnostics are not shown.
Enable label edit on node creation Assist with naming of nodes during graph creation.  A dialog is automatically presented each time the user adds a node. The node automatically generated name is highlighted and typing overwrites it. Hitting the carriage return closes the dialog accepting what ever the user has typed.
Enable label edit on edge creation Assist with naming of edges during graph creation.  A dialog is automatically presented each time the user adds an edge. The edge automatically generated name is highlighted and typing overwrites it. Hitting the carriage return closes the dialog accepting what ever the user has typed.
Interval for auto numbering This sets the interval for autonumbering operations. By default, this is set to one.

The InLine Methods preference refers to the edges from the upper and lower level graph are conected while inlining subordinate graphs. While many users are satisfied with the current method of inlining subordinate graphs (Map All), the method does not match the way future enhancements will treat hierarchical graph relationships. The new methods serve as diagnostic tools that can be used to align names of edges for use in generating useful outputs such as test generation and finite state machine generation (Spin models). If the Strict preference is set, only matching upper level edges are connected. Unmatching upper level edges are not shown, but a diagnostic is produced showing broken connections. Unmatched lower level edges are left connected to the start or stop connector. If the Direct preference is set, matching edges are directly connected and unmatching upper and lower level edges are connected to the start and stop connectors. the edge binding method will be used during inlining. Otherwise, the normal method is used.

The two preferences enable automatic properties dialog for nodes and enable automatic properties dialog for edges assist with naming of nodes and edges during graph creation. When one of these is set, a dialog is automatically presented each time the user adds of of the corresponding object. The objects automatically generated name is highlighted and typing overwrites it. Hitting the carriage return closes the dialog accepting what ever the user has typed.

Modify Environment Preferences

To change the values for these environment preferences, do:

These values are saved in the Registry for Windows 95 and in a file, $HOME/.mp, for Solaris 2.5. Solaris users can change the preference file location their preferences save in a file other than $HOME/.mp by setting the environment variable MP_ENV to point to a different file. For example:

MP_ENV=$HOME/.toolsdir/.ubet
export MP_ENV


UBET will look at the file at $MP_ENV to get and put preferences.

RETURN TO TOP

Opening a UCE Graph

Starting a New UCE Graph

  1. Click File/New on the menu bar

RETURN TO TOP

Opening an Existing UCE Use Case Graph

Use outputs are saved as Use Case Graphs (UCG) having a .ucg suffix.  For purposes of backward compatibility, the suffix .poga is also supported.

  1. Click File/Open on the menu bar or click {short description of image}on the toolbar.
  2. Use the file browse dialog to select the proper file

RETURN TO TOP

Quitting UCE

Click File/Exit to quit UCE. If the file has been modified, a dialog will prompt the user to save before quitting.

RETURN TO TOP

Saving a UCE Use Case Graph

UCE outputs are saved as Use Case Graphs (UCG).  Use Case Graphs have a .ucg suffix, but an earlier convention using a .poga suffix is still supported and can be read and written.  Users are encouraged to comply with the new convention.

RETURN TO TOP

Moded Operations in UCE

Several UCE commands initiated from the tool bars start modes that support repeated operations. For examples, the button {short description of image} allows the user to pick a node to highlight its incoming and outgoing edges. In this mode, the user can pick one node after another, showing each nodes context in turn. All of these modes can be terminated by double clicking these buttons on the Mode toolbar.

Moded operations can be terminated in one of three ways.

RETURN TO TOP

Adding Nodes and Edges

Adding a Node

  1. Click on the Add Node toolbar button {short description of image}
  2. Click the Select button on the canvas to place the node
  3. To name the node, directly edit the label or use the property sheet.

RETURN TO TOP

Connecting Two Nodes with an Edge

  1. Click the Add Edge button {short description of image}
  2. Click the Select button on the source node
  3. Click the Select button on the destination node
  4. To name the edge, directly edit the label or use the property sheet.

RETURN TO TOP

Moving an Edge from One Node to Another

You can move an edge from one node to another simply by dragging one end of the edge to another node. Some moves are not allowed:

If a user moves an edge, it is first checked for scenarios following the edge and the user is warned before completing the change.

RETURN TO TOP

Adding MSC Links or Sub graph Files

Links to Message Sequence Charts or UCE sub graph files are made through the properties dialog

  1. Click the Menu button on the label and drag it to Properties...
  2. Enter the path to the Message Sequence Chart file or the Use Case sub graph file in the appropriate field or browse to it by clicking the Browse button.
  3. Click OK when done.

RETURN TO TOP

Creating and Managing Reference Tags

Pointers to bookmarks in Word documents (reference tags) can be added processes and virtually all objects in MSE.  Each end of a message can also have reference tags (just use the Menu button close to the vertical process bar).  The tags can be entered and edited using the property dialogs. Reference tags can be added to all objects by using the menu button to selected the Properties entry. The dialog has a scroll list that holds the reference tags.

  1. Click New to bring up the Create New Reference Tag dialog.
  2. Click Browse to bring up the file browser. The file browser shows a list of all Word documents  in the Document Directory preference if set. Otherwise, it will list of all Word documents in the current working directory.
  3. Double Click the appropriate document. A path relative to the common root directory, Document Directory if set or the current working directory if a file is opened, will be set in the Doc: entry field. Users can always click the Select button in the Doc: field and type in the Document name. Typed entries are always preserved as is.
  4. Click the Select button in the Tag: field and type in the Tag name(s).
  5. Click Create to enter the tag into the list.
  6. Repeat this process for multiple reference tags.
  7. When done, click OK to save the information into tool.

The user is warned when the create button is clicked if the file does not exist or not readable on the file system.

Note: the data has not been saved into your file. Click File/Save to save the data into the file.

To modify or delete a tag, click on the item in the Reference Tag & Reference Document list first, then click either on the Edit or Delete button. If you click Edit, the Edit Reference Tag dialog appears. Modify the information accordingly. If you click Delete, the tag item will be removed from the list.

RETURN TO TOP

 

Setting Uses & Extends Types

UBET now supports the notion of Uses and Extends.  Release 5.1 will include Uses and Extends feature for UCG files only, our next release will provide full support for both UCG and MSC files.  Users can show graphically which nodes are linked to Uses or Extends files.  Users can assign a "file type" to a specific file when creating or modifying the file.  There are three different "file types": "USES", "EXTENDS", "NONE".  The "file type" can be assign by selecting the desired value from the Edit menu. (Edit/File Type)

uce_uses_extend_menu.gif (4116 bytes)

 

When linking files to nodes you can expect the following actions to take place:

  1. It will verify the type of the file to be link to.

  2. It will 'draw' the nodes with the correspondent characteristics depending on the type of the file.

  3. If the user changes the file link to the node, it will draw the nodes with the characteristics to the new file type.  Example: if the user has a node that is link to 'login.ucg' which is of type 'USES' and opens the 'Properties'' Window to change the link file to 'login_error.ucg' which is of type "EXTENDS", it will change the node from visually looking like a uses to an extend.

  4. It will change the filling color to white and the outline color to black if the user erases the "Node Link".

  5. It will assign the name of the file, leaving out the extension and adding an identifier, to the node label.
            example:  file name: login.ucg
                   file type of login.ucg:  USES
                           node label: USES 1: login
            If user links a different node to the same login.ucg file the node label of this other node will be:  USES 2: login.

  6. If the file has already been linked and the 'Properties' Window is closed, and the user changes the type of the file linked.  The link will remain showing the previous state. For this type of changes the user should run the 'Validation Check' and then manually open and close the node property window to refresh the information.  We are working on improving this action to a more automatic one.

Visual Representation of Uses and Extends Nodes

USES

    UCG files

  UCG files MSC files
USES
Node Outer Border Color:
Node Outer Border Thickness:
Node Inner Color:

PURPLE
3 (broader than normal outline)
YELLOW

PURPLE
3 (broader than normal outline)
WHITE
EXTENDS
Node Outer Border Color:
Node Outer Border Thickness:
Node Inner Color:

DARK GREEN
3 (broader than normal outline)
YELLOW

DARK GREEN
3 (broader than normal outline)
WHITE

Creating and Managing Note References

{short description of image}UBET supports the notion of a note number. A note number is an identifier associated with a node or an edge that can be used to tie externally maintained documentation to that object. Users can maintain tables in external documents that provide additional information about nodes or edges and use the note number showing in exported files to tie annotation in the table to features on the drawing. Note numbers show up on the same line as the node or edge label. They appear in front of the label within square brackets. Once a note number is established, they show up in all graphical outputs (GIF, encapsulated postscript, EMF, WMF, etc.). The figure to the right shows a node with the note number N_3 preceding the node label, SetUp.

Creating Note Numbers

Note numbers can be created in two ways: through the edit menu or through an individual object's properties dialog. The menu numbers all objects at once, so it makes sense to use the menu if you plan to comment on every node or every edge. The properties dialog allows the user to supply a note number for an individual object. This approach is useful if the user is only going to annotate a few of the objects in the drawing.

Menu Creation of Note Numbers

The{short description of image} menu for note numbering is under the Edit menu. Click Edit/Auto Number.../Auto Number All Nodes to insert note numbers for all nodes. Choose Auto Number All Edges in the same menu to number the edges. When autonumbering is performed, the numbers for nodes begin with the string "N_" and the edges begin with the string "E_". Note numbers are sequenced in a left to right, top to bottom sequence.

The counter for note number sequencing can be incremented at user-specified intervals, set in the Preferences field labeled Interval for autonumbering. The default interval is 1, but the user may wish to choose something like 10, so that they get numbers allowing insertion of new notes without changing their tables (e.g., N_10, N_20, N_30, etc.).

Properties Dialog Creation of Note Numbers

Note numbers can be placed on individual objects. Use the Note Number: field to enter an identifier string. Note numbers are subject to the same restrictions as labels. They do not have to have the "N_" or "E_" prefix.

Changing Note Number Contents

Similar to creation, users can edit the contents of any note number by using the object's properties dialog, but they can also resequence any numbers they've entered. The resequencing is applied only to objects that already have note numbers. To resequence the currently numbered nodes, click on Edit/Auto Number.../Renumber Nodes or use the toolbar button {short description of image}. To renumber the edges, use the menu Edit/Auto Number.../Renumber Edges or use the toolbar button {short description of image}. The sequencing interval from preferences is used to resequence and the same prefixes as in creation are used.

Removing Note Numbers

Note numbers can be removed one at a time by using the object's properties dialog. The user can also remove the note numbers for all nodes or all edges by using the Edit/Auto Number.../Clear Node Numbers or Edit/Auto Number.../Clear Edge Numbers respectively.

RETURN TO TOP

Comparing Use Cases

Users{short description of image} can compare two use cases to see what differences exist between them. This is useful if the user has made changes to a copy of some uce. Changes are reported text form that tells what changes would have to be made to the original use case to achieve one matching the second.

Use the Tools/UCG Difference Report... menu item to start the comparison (There is also a command-line interface to the UCG comparison program). That pops up a dialog that allows the user to identify the original use case, the current use case (prepopulated with the current files address), and a output file where the results will be placed. Use the original UCE browse button to find the original file. Set the Show All Differences if you want to see details of changes. Details include such things as note numbering changes.

{short description of image}

The results are presented as text in a window. All objects in the report are marked as changed, added, or deleted. Added means the object did not appear in the original file. Deleted means it was found in the original file, but not in the new file (current). Since the basis for comparison is the node names, the program reports changes in node names as a delete and an add.

A comparison example is shown below. The two comparison files are shown first. The left

{short description of image} {short description of image}
{short description of image}

RETURN TO TOP

Validating Uses and Extends Information

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. Possible inconsistencies are as follow:

uce_validation_check_win.gif (5738 bytes)

This window requires the user to enter the file to be validated and the name of the report file to generate.  The user can select which kind of files want to validate, example only validate the uses.  If only uses are going to be validated then EXTENDS and SUBGRAPHS must be in the "Not In Report" window.

The results are presented in a text window at the end of the generation.

Opening Reference Tags

In order to open a reference tag in a Word document two things must be in place:

After the bookmark is created in the referenced document and the object has been tagged with a reference to it, the user can  navigate to the document containing that tag by doing the following:

  1. Click and hold the Menu button (right mouse button) over the object's label string to bring up the objects menu.
  2. Drag the mouse down while pressing the menu button to invoke the Open References sub menu. Below is a picture of a Open References sub menu:
  3. While holding the menu button down, drag the mouse pointer over the reference tag, then release.

Word will be launched if it is not already running. The reference document will be loaded and opened to the specified bookmark.

RETURN TO TOP

Deleting a Node or an Edge

  1. Click  the Delete toolbar button {short description of image}. This puts you in delete mode and changes the mouse to an  X to indicate that you are in delete mode
  2. Click the Select button over a node will delete the node and all connected edges
  3. or click the Select button over an edge deletes it

RETURN TO TOP

Building a Scenario through the Graph

A scenario is a sequence of nodes. This is shown in UCE by highlighting the nodes and intervening edges in green. The sequence can be broken (we call them fragments). A scenario can be made a permanent part of a use case by stashing it with a name. Fragmented scenarios can be stashed and repaired later. In general, scenarios are built by entering scenario mode, then clicking in sequence on a set of nodes. If there are intervening nodes between the clicked node and a fragment already underconstruction, the tool takes the shortest path. If this is not what the user desires, clicking again on the nodes removes them from the scenario. Edges coming out of the tail end of a fragment can also be used to add nodes to the list.

  1. Click the New Scenarios toolbar button {short description of image}, or click the Menu button and select Create Scenario...
  2. Click the Select button over 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.
    For hierarchical scenarios see the following section.

Here are a few tasks that one encounters during scenario editing and methods for dealing with them:

Scenario Edit Operations
Task or problem Method for Accomplishing Results
Add a node or set of nodes to a scenario Just click on the node with the select button. If the node is downstream from the tail of the last fragment, it and intervening nodes are added to the fragment. If the node is not downstream, a new fragment is started and the node placed in it. If you want to add more to that fragment, you may have to use edge clicking to force it into the fragment.
Remove a node from the scenario Clicking on a selected node removes it from the scenario. If it is between two other scenario nodes, this breaks the scenario into two fragments.
Insert some nodes into an existing path. Break the scenario into fragments by either clicking on the undesired node or by breaking between nodes by clicking on the highlighted edge between two nodes. Then use edge selection to follow another path eventually joining the fragments.
Understand exactly what fragments and nodes are part of the scenario Use the Scenario/Scenario Text menu item to pull up a

Hierarchical Scenarios

  1. Hierarchical scenarios are scenarios that span levels of use case graphs. In customer example, customer.ucg is the upper level graph having a scenario called ToughCustomer (Inquiry ->Presentation ->Eval ->Negotiate ->Order). The node Eval has a subgraph called evaluation.ucg which also can have scenarios. The scenarios of evaluation.ucg are sub scenarios for customer.ucg. The node Eval becomes the reference node for sub scenarios.
  2. Rules for creating sub scenarios are as the following:
    <1>Sub scenarios must start from the nodes directly connected to start node and the stop node {short description of image}should not be included, otherwise messages will be given on the status bar.
    <2>If the reference node has outgoing edge, the sub scenario must attach to stop node.
    {short description of image} (right) {short description of image} (wrong)
    <3>If the user wants to used the existing scenarios created by the version before 4.0, please remove and from the scenarios while reading in.

RETURN TO TOP

Operating with Named Scenarios

Creating a Named Scenario

  1. Follow the instructions above to build a scenario through the graph.
  2. Click the Scenarios menu and select Stash Scenario As... or {short description of image}on the toolbar
  3. Type inside the Scenario Name: entry field the name of your scenario (e.g. Sunny Day Scenario)
  4. Hit <CR> or click on the Stash button to create the named scenario

Opening a Named Scenario

  1. Click the Scenarios menu and select Open Scenario... or {short description of image}on the toolbar
  2. Double click on named scenario you wish to see
  3. The scenario will be highlighted on the graph

Deleting a Named Scenario

  1. Click the Scenarios menu and select Delete Scenario...
  2. Click on the named scenario you wish to delete and click on the Delete button or double click on the named scenario
  3. The selected named scenario is displayed on the graph and a dialog appears to prompt you if you really want to delete it
  4. Click the yes button if you want to confirm the deletion or the no button if you don't want to delete it

NOTE: If a node that is part of a previously defined scenario is deleted, the deleted node and all the nodes following it will not be shown. If the first node participating in a scenario is deleted, then the entire scenario will not be shown.

Displaying Named Scenario

  1. Click the Scenarios menu and select Display Scenarios...
  2. Double click on named scenario you wish to see
  3. The scenario will be highlighted on the graph
  4. Repeat steps 2-3 to display other named scenarios

Modifying an existing Named Scenario

  1. Follow the instructions above to select and open the scenario you want to modify.
  2. The tool will automatically enter into the Build Scenario mode. New nodes can be appended to the end of the scenario (by selecting additional nodes), or previously added nodes can be unset (see instructions for Unset Last Path Addition).
  3. To save the modifications, click the Scenarios menu and select Stash Scenario.

Unset Path

  1. Follow the instructions above to select and open the scenario you want to modify
  2. Click Scenarios/Unset Path or bring up the canvas menu by holding down the menu button over white space on the canvas, then pick Unset Path from the menu

Auditing Named Scenarios

  1. Click the Scenarios menu and select Scenario Audit
  2. If inconsistencies are found, the Scenario Audit dialog will appear listing all the inconsistent scenarios.
  3. To view details of an inconsistency(ies) detected in a scenario, click the scenario in the list box. The following data will be displayed in the fields at the bottom of the Scenario Audit dialog:
    FIELDS DESCRIPTIONS
    Scenario Path the path of nodes the scenario actually contains
    Missing Nodes the nodes that are missing in the graph which are part of the Scenario Path
    Missing Edges he edges that are missing in the graph which are part of the Scenario Path. A missing edge is described by a node pair that includes: the originating node (the node that the edge should have originated from), and the terminating node (the node the edge should be terminated on)
  1. Double clicks or the click on Open to display the selected scenario as best as it can on the graph. The path will stop at the first point inconsistency is detected
  2. Click on Create Report to create an ascii report file on all inconsistencies found on all scenarios associated with this graph

Notes: The name of the current working scenario is always displayed on the lower right hand corner of the tool which is part of the status bar. Any changes you made with named scenarios are not committed until you save the Use Case Graph. Also, while you have nodes inlined (see Inlining UCE Subgraphs below), display/create/update/delete/audit of name scenarios are prohibited.

RETURN TO TOP

Generating a composite MSC from a Scenario (Path)

This operation allows a user to view a composite MSC generated from MSCs referenced in the Scenario. The resulting Message Sequence Chart is a scenario representing a single path through the graph. From release 4.0 UBET supports multilevel MSC generation which provides the ability to generate an MSC from a hierarchical scenario. As of Release 4.2, several scenarios can be generated at one time. Each MSC file represents a single path through the hierarchical UCGs. The way can achieve or avoid multiple scenarios in a single generation is described below.

  1. Complete the steps in building a Path through the graph as instructed above.
    {short descr iption of image}
  2. At this point, the user has a choice. They can constrain generation to generate a single scenario for each top level scenario, or they can allow the generation software to generate a separate scenarios for all matching subscenarios (scenarios in the subgraph). Matching is based on matching the names edges connected to the referencing node with incoming and outgoing edges in the subgraph. The method used to determine matching is the Direct Method. To guarantee that a single scenario is generated for a top level scenario, resolve each subgraph reference to a single subscenario. However, for complex graphs, constaining a top level to scenario to just one generated scenario can create a maintainence nightmare for a complex hierarchical graph. It means that for all possible scenarios, the user must define a separate top level scenario. Then for each of those, they must also resolve every subgraph reference (and this must be done at all levels of a hierarchical graph). The other method, multi-scenario generation, is easier to maintain and requires much less user effort. The user basically does edge matching, defines the appropriate top level scenarios, and allows the generation software to decide which lower level scenarios are approapriate. The two approaches are described below:
  1. {short description of image}

  1. The user can then double click on desired subscenario. This must be done for all nodes at all levels

{short description of image}.

  1. Once sub-scenarios are set up, click the Select button over Scenario to MSC {short description of image} or select Scenario to MSC from Scenarios menu. A dialog is presented that allows the user to determine where the resulting scenarios will be placed, since several may be generated. When the user clicks OK, the user is asked if they want to clear out any similarly named scenarios before the run. It is usually advisable to answer yes.
  2. After the scenarios are generated user is asked if they want to browse the scenarios. If they answer yes, the MSE tool will be brought up with the file browser pointing to the appropriate directory. Otherwise the scenario interactions terminate.

RETURN TO TOP

Inlining UCE Sub graphs

Inlining allows user to view another UCE sub graph as part of the current graph by replacing the referencing node with the sub graph. Before you can inline a node containing a sub graph, the sub graph must contain a Start node and a Stop node to the sub graph.

Adding Start and Stop Nodes

In order to inline a sub graph, user must identify all the start nodes (nodes that the incoming edges of the parent node will be connected to) and terminating nodes in the sub graph. To do this:

  1. Start the UCE tool and load the sub graph file.  You can do this from the properties dialog for the referencing node, by clicking the Edit Subgraph button
  2. Click the Select button (left mouse button) on Add start node {short description of image} that is located on the toolbar. The cursor will change into a target. Click the Select button again on the empty part of the canvas. A node shaped like an inverted triangle {short description of image}is created.
  3. Repeat the previous step, but this time click on Add stop node {short description of image} to add the Stop node {short description of image}onto the canvas.
  4. Create edges from the Start node to all the nodes that are considered as start nodes.
  5. Similarly, create edges from all the terminating nodes to the Stop node.
  6. Save the changes by selecting File->Save.

Now that the start and stop nodes have been identified in the Sub graph and the parent node in the current graph has the sub graph file added in it's properties, you can do the following to inline the sub graph:

  1. Open the current graph in the UCE tool by selecting File->Open...
  2. Nodes with sub graph associated with them are highlighted yellow.
  3. Click and hold the Menu button (right mouse button) over the object's label string to bring up the objects menu.
  4. Drag the mouse down while pressing the menu button to select the Inline <sub graph file> item in the menu.
  5. Release the Menu button while the mouse is over the Inline item to inline the sub graph.

The sub graph is added to the current graph. Additional nodes can be inlined at the same time. Each sub graph cluster will be highlighted with a different color. If user inlines more than 10 graphs, the colors are recycled. If the mouse is placed over the sub graph's nodes, the name of the file is displayed. While a sub graph is inlined, editing is disabled. However, you can continue to do all other operations including context and path operations. To undo the inlining and return to the current graph, double click anywhere on the canvas.

The pictures below illustrates the results of inlining. The graph on the left is the original graph with 3 nodes that containing sub graphs: S4, S7 and S8. Note they are highlighted in yellow. The graph on the right shows the results of inlining S7 and S8.

Edge Binding

The edge binding enhancement provides the users with the ability to inline subordinate graphs using methods that take into account the names of the edges in the upper and lower graph. This capability provides a useful diagnostic when trying to align edge names for the purpose of generating downstream driving outputs such as test generation and Spin and VFSM model generation. The discussion below shows how these methods work.

In the followng figure, the refer node contains a reference to the subordinate graph. Egdes A and B in both upper and lower graphs are called as incoming edges while edges C and D as outgoing edges. The {short description of image}and {short description of image}are known as start connector and stop connector for inlining. During the inline operation, the nodes in the subordinate graph visually replace the referencing node in the display. The following three methods are used: Map All, Strict and Direct. The user can choose these methods using the preference settings (see Edge Mapping Preference Setting).

{short description of image} {short description of image}
Upper Level Graph Lower Level Subgraph referenced by the Refer node

Map All

Map All binds all the upper level incoming edges (edges going into the refer node, e.g., A and B in upper graph) to all the lower level incoming edges (those attached to the start node, e.g., A and B in sub graph) and all the upper level outgoing edges (those leaving the refer node, e.g., C and D in upper graph) with all the outgoing edges (attached to the stop node, e.g., C and Z in sub graph) of the subgraph. It does the binding by connecting the upper and lower level edges to the start and stop connectors. The first box in the figure below shows the results of inlining the "Refer" node using the Map All method.

{short description of image} {short description of image} {short description of image}
Upper graph after inlining by Map All Upper graph after inlining by Strict Upper graph after inlining by Direct

Strict

Strict binds only matching upper and lower level incoming and outgoing edges, essentially dropping unmatching upper level edges. The start and stop connectors will connect to any lower level edges that do not have matching upper level edges. If all edges match for the given connector, it will not be displayed.

The center box shows the results of inlining the "Refer" node in the previous example. The upper level incoming edges A and B are bound with their matching lower level incoming edges A and B. Upper level outgoing edge C is bound to the lower level outgoing edge C. Upper level outgoing edge D is dropped because there is no matching outgoing edge in subgraph. Note node four is now a floating node. Since lower level outgoing edge Z does not have matching upper level outgoing edge, stop connector connects to it. As a part of the Strict inlining, the following diagnostic was also produced.{short description of image}

Direct

The Direct method combines aspects of the Strict and Map All methods. It directly binds matching upper and lower level incoming and outgoing edges, but attaches all non-matching edges of both upper and sub graphs to enter and exit connectors. This basically wild-cards non-matching edges. If the user chooses to match upper and lower level edges, then connections to subgraphs are constrained and any generation activities (such as SPIN, VFSM, scenario, or test generation) generates the minimum correct connections. Users may start out and work with graphs with unmatching edges, but should try to match all upper and lower level edges as work on the use cases proceeds.

In the above illustration (right hand box) the upper level edges A, B and C directly connect to lower level nodes. Upper level outgoing edge D does not match to lower level outgoing edge Z, so both edges D and Z are attached to the stop node.

Edge Mapping Preference Settting:

  1. Click File/Preferences... to invoke the Set Preferences dialog
  2. Select one inline method from Map All/Sctrict/Direct options to enable edge binding for inlining
  3. Check the show unmapped lower level edge diagnostics checkbox to show diagnostics during Strict inlining.

RETURN TO TOP

Subgraphing

Subgraphing is essentially the inverse of inlining. Subgraphing is the ability to select several nodes in a graph, then either view them as though they were a new graph or to actually create a new subgraph using the selected nodes. During subgraph creation takes place the following operations are performed.

Use these steps to subgraph a set of nodes.

  1. Select the nodes by entering select mode using the tool bar's select button {short description of image}. A click on a node selects it (and removes others from the select list). As a node is selected its border turns red. Control clicking adds nodes to the select list. Control clicking on a node in the select list toggles its membership. You can use the context button to identify logically adjacent nodes{short description of image}. The following images shows two nodes as members in a select list.{short description of image}
  2. From the canvas menu, choose Subgraph
  3. {short description of image}

  4. Choosing Preview will create a temporary version of a subgraph consisting of all selected nodes and displays it automatically in another copy of UCE. The subgraph will contain all things associated with those nodes including their parts of scenarios from the original graph.TIP: this is a great way to print a coherent portion of a complicated graph so that the text is readable.
  5. Choosing New brings up another dialog allowing the user to choose the name of the replacement node and the name of the new use case graph.
  6. {short description of image}

RETURN TO TOP

Manipulating the Layout

Redrawing

After adding, deleting or moving nodes and edges, can redraw the graph:

  1. Click the Select button on the Redraw toolbar button {short description of image}. This redraws the graph.
  2. Click the Select button on the Fit graph in canvas toolbar button {short description of image}. This roughly fits the graph to the size of the canvas.

RETURN TO TOP

Resizing

Enlarging

To more easily see a section of a complicated graph:

  1. Click the View/Zoom on menu bar and drag the cursor to Larger. Repeat this step as many times as needed to enlarge the graph to the desired size.
  2. You might need to drag the horizontal and/or the vertical scroll bars to view the section of the graph you wanted.
  3. When you are done, click the Select button over Redraw {short description of image}, then Fit {short description of image} to return to the normal size.

Reducing

To see more nodes of a large graph:

  1. Click the View/Zoom on menu bar and drag the cursor to Samller. Click this button as many times as needed to achieve the desired size.
  2. When you are done, click the Select button over Redraw, then Fit to return the graph to the normal size.

RETURN TO TOP

Displaying Object Attributes

Node Attributes

  1. Move mouse pointer over the text label of the Node. A small popup containing the Node attributes (MSC Link, Sub graph and Tags) will appear.
  2. Move the mouse pointer away from the Node, the popup will disappear.

Edge Attributes

  1. Move mouse pointer over any part of the edge. A small popup containing the Edge attributes (Edge label, and Tags) will appear.
  2. Move the mouse point away from the Edge, the popup will disappear.

Note: you can be in any mode to view object attributes. The small popup resemble tool tips on Microsoft applications.

RETURN TO TOP

Printing

Printing is supported on the Solaris and PC platforms. TIP: use the new subgraph previewing capability to print a subset of complicated graphs.

It is now possible to print a drawing on Windows 95/NT directly from UCE. Two entries have been added to the file menu in support of this operation. Choosing File/Print prints the drawing directly to the user's default printer. Choosing File/Print Setup & Preview... brings up a view that allows the user to send the printout to another printer, set printer attributes, or preview the printout.

It is also possible to print a drawing on Solaris 2.5 directly from MSE. The user needs to set up the commands used to print and preview by choosing File/Print Setup... before printing for the first time. In the Print Setup dialog, do the following:

{short description of image}

  1. Click in the Print Command: entry field and enter the print command. Default is the lp command.
  2. Click in the Preview Command: entry field and enter the preview command. Default is the pageview command.
  3. Check Show Reference Tag to enumerate all objects containing reference tags and generate a table containing the reference tags. Default is unset.
  4. Set Multi for color postscript output or Black/White for monochrome output. Default is Black/White.
  5. Set Portrait or Landscape for the output orientation.
  6. Set the size of the postscript fonts (Small 8, Normal 10, or Large 12) used for the output.
  7. Click Set to save the setup.
  8. Click Print to sent the output to the postcript printer with the command you provided. MSE will append the name of a temporary postscript file containing the description of the MSC to the print command you have entered and then execute it.
  9. Click Preview to view the postscript output with the command you provided. MSE will append the name of a temporary postscript file containing the description of the MSC to the preview command you have entered and then executed.
  10. Click Cancel if you changed your mind.

After the printing setup is completed, you can choose File/Print to print the UCE directly or choose File/Preview... to view the UCE any time.

RETURN TO TOP

GIF Image Generation

The GIF image 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.

Generate GIF Dialog


    Option Description
    File name It is the name that will be used for the generated GIF file.
    Browse Invokes the file browser to select the file you wish to generate the gif into.  A relative path will be placed in the entry field.
    OK Button It makes all the changes performed at this window and closes the window.
    Option Button Invokes the Image Output Preferences dialog to set your output preferences.
    Cancel Button It cancels all the actions that were performed in this window and closes the window.

Image Output Preferences


Click on next to the font names to invoke the list of fonts
Click on next to the font size to invoke the list of font sizes


Option Description
Dimensions Allows the user to change the default WIdth and height of the GIF file.   Default Width and Height have already been set to the same dimension as in the tool's canvas. The Width and Height are measured in pixels.
Hue Selects either monochrome or color for the gif.
Orientation Selects the output orientaion (Portrait or Landscape)
Show Reference Tag If this option is set, a Reference Tag report will be generated. The Reference Tag item number [#] will be appended to the node label or edge label.
Apply Anti-aliasing If the Black/White hue is selected, the Smooth option will be enabled. Click on the check box to set or unset this option. If this option is set, anti-aliasing technique will be applied to the gif which will blurr the image to make it appears to be smooth. This option can be used to remove the jaggies.
Set The Set button stores the information into the user's preferences. These setting (except for the Dimension) will be reused in your next invocation of UBET.

RETURN TO TOP

Exporting to Non-native Formats

Several alternative export formats are supported by UCE. These are shown in File/Export dialog box as the following:

{short description of image}

Formats Description
FrameMaker MIF Imported format for FrameMaker
Postscript Generate a Postscript file
Generated Test Cases Generate Test Cases exercing all edges for the flattened use case
Spin Model Generate a Promella model file for use in SPIN
VFSM Model Generate VFSM model files for use in VFSM

Exporting to GIF Format

The GIF format 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.

  1. Click File/Export...
  2. Click the GIF Format radiobutton if not set
  3. Click show Reference Tags to produce a separate Comma Separated Values (.csv) file holding the reference tags for import into MS Word
  4. Click Multi if color output is desired or Black/White if monochrome output is preferred
  5. If desired, change the node separation and/or rank separation of the graph in GIF by changing the Horizontal and Vertical Separations, respectively
  6. Click Portrait or Landscape to set your output's orientation

RETURN TO TOP

Exporting to MIF Format

MIF is a markup format that can be imported into FrameMaker documents or simply opened as a FrameMaker document.

  1. Click File/Export...
  2. Click the FrameMaker MIF radiobutton if not set
  3. Click show Reference Tags to produce a separate Comma Separated Values (.csv) file holding the reference tags for import into MS Word
  4. Click Multi if color output is desired or Black/White if monochrome output is preferred
  5. If desired, change the node separation and/or rank separation of the graph in GIF by changing the Horizontal and Vertical Separations, respectively
  6. Click Portrait or Landscape to set your output's orientation

RETURN TO TOP

Exporting to Postscript Format

Postscript is a format understood by many printers.

  1. Click File/Export...
  2. Click the Postscript radiobutton if not set
  3. Click show Reference Tags to produce a separate Comma Separated Values (.csv) file holding the reference tags for import into MS Word
  4. Click Multi if color output is desired or Black/White if monochrome output is preferred
  5. If desired, change the node separation and/or rank separation of the graph in GIF by changing the Horizontal and Vertical Separations, respectively
  6. Click Portrait or Landscape to set your output's orientation
  7. Font size can control the size of the font. We have generally found the Normal setting to be the most readable.

Note: to print postscript files on Windows 95, see the release notes.

RETURN TO TOP

Exporting Spin Models

Spin is a software system developed by Gerard Holzmann that supports the formal verification of distributed software. UBET generates Spin models in Promela, the native specification language used by Spin. General information about SPIN as well as stand-alone instructions for generating spin models is available.

  1. Click File/Export...
  2. Click the Spin Model radiobutton if not set
  3. Change the file name if desired.
  4. Click OK

RETURN TO TOP

Exporting VFSM Models

Virtual Finite State Machines (VFSM) are extended finite state machines that support validation, simulation, and code generation. UBET generates the models from a use case with underlying MSCs. An individual model is generated for each process in the underlying MSCs. Information about generating VFSM from UBET including command line execution can be found in mkvfsm_readme.txt. General background information about VFSM can be found on the Virtual Finite State Machine (VFSM) Home Page (note: if you are not inside the Lucent firewall, you will not be able to access this url). To generate VFSM models from UCE:

  1. Click File/Export...
  2. Click the VFSM Model radiobutton if not set
  3. Change the directory name if desired. Because each VFSM model consists of several files and several models are generated for any use case, dropping the spin model in the current directory is not recommended. The directory browser can be used to place them in a separate directory and will create the directory if it does not exist.
  4. Click OK

Exporting Test Cases

A test case generation algorithm developed by Mihalis Yannakakis and David Lee can be used to generate test cases that exercise all choices in a hierachical Use Case. It first flattens the hierachy, then generates a set of scenarios that are then saved with the flattened graph. Because nodes must be named uniquely, the node names in the flattened graph will contain prefixes distinguishing them from each other.

  1. Click File/Export...
  2. Click the Generate Test Case radiobutton if not set
  3. Change the file name if desired
  4. Click OK

RETURN TO TOP

MS Word Outputs

The GIF and .csv formats  can be imported into Microsoft Word documents. Export the drawing in GIF format. Choose the check box labeled show Reference Tags to produce a separate Word-importable file showing the reference tags. The following scenario shows how to export the files and then import them into MS Word.

  1. Click the File/Export... menu item to get the export dialog
  2. Click the Graphics Interchange Format (GIF) radio button
  3. Click the show Reference Tags check box.
  4. Click OK
  5. In MS Word, place the mouse where you want to place the GIF and click the Insert/Picture menu
  6. Be sure to choose Files of type: All Graphics Files so you can see the gif. Use the dialog to navigate to where you ftped the gif and double click the right GIF file.
  7. Place the mouse where you want the Reference tags table to show up and choose the Insert/Database... menu item.
  8. Click the Get Data... button under Data source: in the dialog to bring up another file browser.
  9. Make sure the Files of type: field is set to "All Files"
  10. Navigate to the directory containing the ftped files and choose the appropriate .csv file (named with the same prefix as the GIF file).
  11. The database dialog will reappear. Choose the Table AutoFormat button to pick a table format.
  12. Click Insert Data and pick the All radio button, then click OK.

TIP: Not all installations of MS Word have the ability to import .csv files.  The user may have to reinstall Word using the Custom install option to chose the .csv filter.
WARNING: Word is not tolerant of import file anomalies.  In tranfering the .cvs file from UNIX to Windows, use binary mode in ftp.  The GIF is also a binary file.  Use binary mode to transfer from UNIX to Windows in ftp. The following scenario tells how to move the files without damage to the PC.  It assumes you have saved several drawings using the .gif and .csv suffixes and that you are using command line ftp to move them to the PC.

  1. From a DOS window change to the directory where you want the files to appear
  2. Open an ftp connection to the UNIX machine where you created the GIFs and CSVs. CD to the UNIX directory containing the files.
  3. type "prompt"
  4. type "binary"
  5. type "mget *.gif"
  6. type "mget *.csv"
  7. In MS Word, place the mouse where you want to place the GIF and click the Insert/Picture menu
  8. Be sure to choose Files of type: All Graphics Files so you can see the gif. Use the dialog to navigate to where you ftped the gif and double click the right GIF file.
  9. Place the mouse where you want the Reference tags table to show up and choose the Insert/Database... menu item.
  10. Click the Get Data... button under Data source: in the dialog to bring up another file browser.
  11. Make sure the Files of type: field is set to "All Files"
  12. Navigate to the directory containing the ftped files and choose the appropriate .csv file (named with the same prefix as the GIF file).
  13. The database dialog will reappear. Choose the Table AutoFormat button to pick a table format.
  14. Click Insert Data and pick the All radio button, then click OK.

RETURN TO TOP

Graph Relationship Utilities

Displaying Node Context

Node context is an I/O view of a node, highlighting its incoming and outgoing edges.

  1. Click the Select button over the Context mode bar button {short description of image}
  2. Click the Select button over the text label of any node. All the incoming and outgoing edges of the node selected will be colored.
  3. Continue to click on new nodes for new context views
  4. Re-click the Select button on the Context mode bar button to leave Context mode or double click the Select button on the canvas to clear the context state information.

RETURN TO TOP

Showing Node with 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. To show the Node with its strongly connected components (Scc), do:

  1. Click the Select button over the Show node and its strongly connected components button {short description of image}
  2. Click the Select button over the text label of any node. The Scc of that node will be colored
  3. Click the Menu button and dragging it to Clear All Context or re-click {short description of image} when done

RETURN TO TOP

Showing Node with Strongly Connected Components and I/Os

Similar to above, to show the Scc and all of its edges, do:

  1. Click the Select button over the Show node and its neighbors button {short description of image}
  2. Click the Select button over the text label of any node. The Scc and all of its in/out edges will be colored
  3. Click the Menu button and dragging it to Clear All Context or re-click {short description of image} when done

RETURN TO TOP

Showing All Sccs

To show all the Sccs in the graph, do:

  1. Click the Select button over the Show all sccs button {short description of image}. Each Scc in the graph will be colored with a separate color.
  2. Click the Menu button and dragging it to Clear All Context when done

Note: It is easy to run out of colors if the graph contains many Sccs.

RETURN TO TOP

Showing All Roots

Root nodes are nodes from which all other nodes can be reached. Root nodes are not necessarily nodes without predecessors.:

  1. Click the Select button over the Show roots button {short description of image}. All nodes without predecessors will be colored
  2. Click the Menu button and dragging it to Clear All Context when done

RETURN TO TOP

Showing All Leaves

To show all nodes that have no successors, do:

  1. Click the Select button over the Show leaves button {short description of image}. All nodes without successors will be colored
  2. Click the Menu button and dragging it to Clear All Context when done

RETURN TO TOP


pos_lucent.gif (1187 bytes)