MESSAGE SEQUENCE EDITOR (MSE) 5.2 - USER GUIDE


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



This document describes several aspects of the Message Sequence Chart Editor (MSE) user interface. Some general points are worth mentioning before describing individual features.

The following features are described further in this document

Before starting to describe MSE, here is a snap shot of an example message sequence chart using MSE.

 

{short description of image}

Menu Bar

{short description of image}

The menu bar shown above supports the actions shown in the following subsections. The main menus have the following functions.

MENU DESCRIPTION
File File management, preferences, export and the printer.
Edit Supports message sequence chart (MSC) 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 MSC comparison and reference tags.
Checks Set parameters and check for race conditions and timing conflicts.
Help Provides access to the User Guide, tutorial, UBET's home page, and bug reporting.

File Menu

The file menu is used for interactions with external files, exports, printers, and user preferences. The following operations are supported:

../images/mse_file_menu.gif (2744 bytes)

MENU ITEM DESCRIPTION
New Readies the application for a new design.  Existing design data is cleared out and current context is reset.  If changes have been made to the existing design and not saved, the user is notified and allowed to save it.
Open Existing data is cleared, context is cleared, and a dialog is started to open a MSC file (itu).  If changes have been made to the existing design and not saved, the user is notified and allowed to save it.
Add Starts a dialog to browse for the file to append.  Concatenates a   MSC file onto the current MSC.  It appends the contents of a MSC to the contents of the current drawing.  If a new process appears in the added file, it is appended to the right of the existing processes.  Any events in the new MSC are appended to the appropriate process bar.
Save Current graph is saved to the already open itu file. The default of the Save command is to preserve blank rows when the MSC is saved. For compacteness please change the MSE preferences.
Save As... Starts a dialog to save current data to a new itu file.
Image Generation Starts a dialog window that will allow the user to generate GIF 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. GIF Image Generation.
Export... Starts a dialog to save current data in a non-native format (other than itu).  Currently five formats are supported (ASCII Scenario, FrameMaker MIF, PostScript, Windows Meta File (WMF), and SeqFlow) .  Export look & feel.
Preferences... Preferences... brings up a dialog allowing the user to set environment preferences.  Preferences look & feel.
Print Prints the drawing to the default printer.
Print Preview...
(Solaris only)
Previews the drawing.
Print Setup & Preview
(Windows 95/NT only)
Bring up a view that allows changing the printer or its characteristics as well as previewing pages before printing.
Print Setup...
(Solaris only)
Brings up a window to setup the print and the preview commands and other postscript printing options.
Exit Exits MSE. If changes have been made to the MSC, the user is notified and allowed to save the MSC.

RETURN TO TOP

Edit Menu

The Edit menu has submenu entries that permit the creation and removal of objects in the MSC. Many are used to insert objects on a process bar. Currently, an object cannot be inserted unless there is space to place it on the bar. The user can open space by clicking on the process bar between objects.

../images/mse_edit_menu.gif (3577 bytes)

MENU ITEM DESCRIPTION
Undo Undo changes. User can repeatedly undo edits to the first performed on the current file.
Redo Redo an undone operation.
Add Process Creates a new process (instance).  It is given a default name until the user explicitly names it.
Add Message Starts message mode, in which multiple messages can be repeatedly added by using the Select button to drag from one process bar to another. The user can exit add-message mode by hitting the escape key  or choosing another menu item.
Add State Triggers state mode, signaled by a small bullseye on the mouse cursor. Clicking on a process bar where there is room results in a state with a dummy name being added. The user must again click on Add State to add another state.
Add Text Starts  text box mode. A pencil replaces the normal mouse cursor and if clicked on an empty section of a process will place the text box on the process bar.
Add Timer Set Starts timer set mode, replacing the mouse cursor with a square. Click on an open process bar to add a timer. NOTE: A timer is not complete until a reset or timeout is added (see Add Timer Reset and Add Timeout below).
Add Timer Reset Before adding a reset, add a timer set (see Add Timer Set above).   Add Timer Reset starts timer reset mode, replacing the mouse cursor with a square. Click on a process bar below a timer to add a timer reset.
Add Timeout Before adding a timeout, add a timer set (see Add Timer Set above).   Add Timeout starts timeout mode, replacing the mouse cursor with a square. Click on a process bar below a timer to add a timeout.
Add Coregion Add Coregion prepares to place a coregion on a process bar. Click the mouse next to a process bar and drag it down to include any messages that will be included in the coregion. Include only messages and make certain to open space on the process bar to locate the top and bottom of the coregion. Space can be made on a process line by clicking it with the middle button.
Delete Object Enters to delte object mode, e.g., a process, timer, coregion, etc. After clicking on the menu entry, click on the target object to delete it. NOTE: to delete a process, the user must click on the blue vertical process bar or the black horizontal bar at the base of the process.  Clicking on the process name box will not work.
Autonumber Auto Number allows the user to manage Note numbers for referencing graph objects from external documents. More information is available for autonumbering.
Lengthen Processes Lengthen the tail of all processes to make it easier to work at the bottom of the graph.
Shorten Processes Shorten all process tails.

RETURN TO TOP

View Menu

The view menu is used to control the appearance of the application.

mse_view_menu.gif (2548 bytes)

MENU ITEM DESCRIPTION
Compact Vertically compacts MSC by deleting blank rows. A blank row is defined as any row which does not contain an object in that row for all processes (actors) present in the MSC.
Resize MSE Brings up a scroll bar that permits scaling of the drawing.  Resize MSE look & feel.
Show Annotation Window Hide/un-hide the annotation window. See more details at annotation
Toolbar Toggles the display of the toolbar.
Status bar Toggles the display of the status bar at the bottom of the MSE window.
Pop Up Comments Toggles the display of the object attributes, such as reference tags.
Enable Tool Tips Toggles the display of tool tips
Show Numbers Toggles the display of Note Numbers on Messages

RETURN TO TOP

Tools Menu

The tools menu holds access to useful reports.

mse_tools_menu.gif (2198 bytes)

MENU ITEM DESCRIPTION
Reference Tag Report This starts the reference tag report utility
Reference Tag Comparison This starts the reference tag comparison utility
MSC First Difference Report Compare this use case with some other use case (normally a predecessor use case).

RETURN TO TOP

Checks Menu

The checks menu supports audits of race conditions and timing conflicts.

mse_checks_menu.gif (1910 bytes)

MENU ITEM DESCRIPTION
Set Checking Parameters Brings up a dialog that permits to audit parameter setting.
Check Race Conditions Runs the race condition audit.  The wider lines show the violation. The results display can be cleared with The View/Clear Context menu item.

RETURN TO TOP

Help Menu

The help menu is disabled. UBET documentation was included in the zip file which was part of the software download.

RETURN TO TOP

Toolbar

mse_toolbar.gif (2275 bytes)

The toolbar shown above supports the actions shown in the following table.  In the table below, all moded insert states can be disabled by:

BUTTON ACTION

{short description of image}

New
Starts a new MSC.  Existing design data is cleared out and current context is reset.   If changes have been made to the existing design and not saved, the user is notified and allowed to save it.

{short description of image}

Open
Existing data is cleared, context is cleared, and a dialog is started to open a MSC file (itu).  If changes have been made to the existing design and not saved, the user is notified and allowed to save it.

{short description of image}

Save
Saves the current MSC. The default of the Save command is to preserve blank rows when the MSC is saved. For compacteness please change the MSE preferences.

{short description of image}

Print
Prints the current MSC in the default printer.

{short description of image}

Add Processes
Creates a new process (instance). It is given a dummy name until the user explicitly names it.

{short description of image}

Add Messages
Starts message mode, in which multiple messages can be added by clicking on one process and dragging to another. Creating a message does not exit message insert mode so multiple messages can be defined in one insertion session.

{short description of image}

Add State
Triggers state mode, signaled by a small bullseye on the mouse cursor. Clicking on a process bar where there is room results in a state with a dummy name being added.

{short description of image}

Add Text Boxes
Starts text box mode. A pencil replaces the normal mouse cursor and if clicked on an empty section of a process will place the text box on the process bar.

{short description of image}

Add Time Set
Starts timer set mode, replacing the mouse cursor with a square. Click on an open process bar to add a timer. NOTE: A timer is not complete until a reset or timeout is added (see Add Timer Reset and Add Timeout below).

{short description of image}

Add Timer Reset
Starts timer reset mode, replacing the mouse cursor with a square. Click on a process bar below a timer to add a timer reset.  Note: Before adding a reset, add a timer set (see Add Timer Set above)

{short description of image}

Add Timeout
Starts timeout mode, replacing the mouse cursor with a square. Click on a process bar below a timer to add a timeout.  Note: Before adding a timeout, add a timer set (see Add Timer Set above).

{short description of image}

Add Coregion
Prepares to place a coregion on a process bar. Click the mouse next to a process bar and drag it down to include any messages that will be included in the coregion. Include only messages and make certain to open space on the process bar to locate the top and bottom of the coregion. Space can be made on a process line by clicking .

{short description of image}

Delete
Enters delete mode, i.e., prepares to delete features such as a process, timer, coregion, etc. After clicking on the menu entry, click on the target object to delete it.

{short description of image}

Undo Last Change
Backs out the most recent change. This can be done repeatedly, so that several changes can be backed out.

{short description of image}

Redo Last Change
Reverses the result of the latest undo (can redo as many Undos as exist).

{short description of image}

Compact
Vertically compacts MSC by deleting blank rows. A blank row is defined as any row which does not contain an object in that row for all processes (actors) present in the MSC.

{short description of image}

Length Processes
Makes room at the bottom of all processes for more process objects.

{short description of image}

Shorten Processes
Pulls up the bottoms of processes until the bottom of each process hits an object.

{short description of image}

Check Race Conditions
Runs the race condition audit, showing the process bars with wide red bars where violations have occurred and showing the participating messages and timer interactions with wide blue lines. Pops up a list of race conditions that may be clicked to further highlight the violations.

 mse_annot_icon.gif (914 bytes)

Show annotation window
Hide/un-hide the annotation window. See more details at annotation

RETURN TO TOP

Object Menus

Object Menus provide a simple and intuitive method for invoking functions related to the particular objects.

Canvas Menu

The canvas menu provides some of the most frequently used functions involving the entire application. To invoke the canvas menu, click and hold the Menu button over the canvas. The canvas menu will appear looking like this:

 mse_canvas_menu.gif (2361 bytes)

While holding down on the Menu button, drag the mouse down to the function desired and then release the Menu button to select it. The functions provided in the menu operates in the same manner as the buttons in the toolbar.

RETURN TO TOP

Process Menu

Process Label Menu

The Process menu allows the user to invoke the Properties dialog, open References to Word documents, and delete the process. To invoke the Process menu, click and hold the Menu button on the mouse over the process's label. A Process menu instance will appear and it looks like this:

 mse_process_menu.gif (1573 bytes)

While holding down on the Menu button, drag the mouse down to the function desired and then release the Menu button to select it.

FUNCTION DESCRIPTION
Properties Invokes the Process Properties dialog for editing the process's label, and reference tags.
Open References If the process contains reference tags, the Open References submenu containing entries for each reference tag will be enabled.
Delete Deletes this process and all objects on it.

RETURN TO TOP

Process Bar Menu

The Process Bar menu allows user to paste an object on the process and delete the process. To invoke the Process Bar menu (instance), click and hold the Menu button on the mouse over the process's bar. A Process Bar menu instance will appear and it looks like this:

{short description of image}

While holding down on the Menu button, drag the mouse down to the desired function and then release the Menu button to select it.

FUNCTION DESCRIPTION
Paste It paste the process.  The Paste function is only enabled if a Text or State object has been cut or copy, respectively.
Delete Deletes this process and all objects on it.

RETURN TO TOP

Process Bottom Menu

The Process Bottom menu allows user to delete the process. To invoke the Process Bottom menu (instance), click and hold the Menu button on the mouse over the process's bottom. A Process Bottom menu instance will appear and it looks like this:

{short description of image}

While holding down on the Menu button, drag the mouse down to the Delete function and then release the Menu button to select it. The Delete function will delete this process and all objects on it. Delete is available in all Process Bottom menu instances.

RETURN TO TOP

Message Menu

Message Label Menu

The Message menu allows user to invoke the Properties dialog, open References to Word document, and delete the message. To invoke the Message menu (instance), click and hold the Menu button on the mouse over the message's label. A Message menu instance will appear and it looks like this:

mse_message_menu.gif (1393 bytes)

While holding down on the Menu button, drag the mouse down to the desired function and then release the Menu button to select it.

FUNCTION DESCRIPTION
Properties Invokes the Message Properties dialog for editing the message's label, and reference tags.
Open References If the message contains reference tags, the Open References submenu containing entries for each reference tag will be enabled.

RETURN TO TOP

Message Arrow Menu

The Message Arrow menu allows user to invoke the Show Predecessors/Successors.    To invoke the Message Arrow menu (instance), click and hold the Menu button on the mouse over head or tail of the message arrow. A Message Arrow menu instance will appear and it looks like this:

 mse_message_arrow_menu.gif (1254 bytes)

Shows Predecessors/Sucessors to the message selected.

RETURN TO TOP

Text Menu

The Text menu allows user to invoke the Properties dialog, open References to Word document, cut the Text object into a buffer, and delete the message. To invoke the Text menu (instance), click and hold the Menu button on the mouse over the Text's character string. A Text menu instance will appear and it looks like this:

{short description of image}

While holding down on the Menu button, drag the mouse down to the function desired and then release the Menu button to select it.

FUNCTION DESCRIPTION
Properties Invokes the Text Properties dialog for editing the Text's character string, and reference tags.
Open References If the Text object contains reference tags, the Open References submenu containing entries for each reference tag will be enabled.
Cut Cuts away the Text object and store it in a buffer. Text Objects can be pasted by invoking the paste function on a Process Bar menu.
Delete Deletes this Text object.

RETURN TO TOP

State Menu

The State menu allows user to invoke the Properties dialog, open References to Word document, copy the State object into a buffer, and delete the message. To invoke the State menu (instance), click and hold the Menu button on the mouse over the State's label. A State menu instance will appear and it looks like this:

{short description of image}

While holding down on the Menu button, drag the mouse down to the function desired and then release the Menu button to select it.

FUNCTION DESCRIPTION
Properties Invokes the State Properties dialog for editing the State's label, and reference tags.
Open References If the State object contains reference tags, the Open References submenu containing entries for each reference tag will be enabled.
Copy Copies the State object and store it in a buffer. Later user can paste this State object on another process by invoking the Paste function on the Process Bar menu.
Delete Deletes this State object.

RETURN TO TOP

Timer Menu

The Timer menu allows user to invoke the Properties dialog, open References to Word document, and delete the message. To invoke the Timer menu (instance), click and hold the Menu button on the mouse over the Timer's label. A Timer menu instance will appear and it looks like this:

{short description of image}

While holding down on the Menu button, drag the mouse down to the function desired and then release the Menu button to select it.

FUNCTION DESCRIPTION
Properties Invokes the Timer Properties dialog for editing the Timer's label, and reference tags.
Open References If the Timer object contains reference tags, the Open References submenu containing entries for each reference tag will be enabled.
Delete Deletes this Timer object and it's associated arrow.

RETURN TO TOP

Timeout/Reset Menu

The Timeout/Reset menu allows user to show Predecessors/Successors, and delete the Timer and the arrow. To invoke the Timeot or Reset menu (instance), click and hold the Menu button on the mouse over the Timeout/Reset arrow. A Timeout/Reset menu instance will appear and it looks like this:

 mse_timeout_reset_menu.gif (1493 bytes)

While holding down on the Menu button, drag the mouse down to the function desired and then release the Menu button to select it.

FUNCTION DESCRIPTION
Show Predecessors/Succesors Highlights the diagram according to it's findings.
Delete Deletes the Timer and the arrow.

RETURN TO TOP

Coregion Menus

Concur Menu

The Concur menu allows user to invoke the Properties dialog, and open References to Word document of a coregion. To invoke the Concur menu (instance), click and hold the Menu button on the mouse over the center of the coregion's top. A Concur menu instance will appear and 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.

FUNCTION DESCRIPTION
Properties Invokes the Coregion Properties dialog for editing the reference tags
Open References If the Coregion contains reference tags, the Open References submenu containing entries for each reference tag will be enabled.

RETURN TO TOP

Endconcur Menu

The Endconcur menu allows user to invoke the Delete function. To invoke the Endconcur menu (instance), click and hold the Menu button on the mouse over any part of the coregion's except for the center of the top. A Endconcur menu instance will appear and it looks like this:

{short description of image}

While holding down on the Menu button, drag the mouse down to the Delete function and then release the Menu button to select it. The Delete function will delete this coregion. Delete is available in all Endconcur menu instances.

RETURN TO TOP

Mouse Bindings (Mouse/Object Interactions)

This section describes using the mouse to interact with objects in the Message Sequence Editor's drawing area. In the discussion below, "Select Button" refers to the pointer finger or left mouse button for a right-hander and "Menu Button" refers to the ring finger button or the right mouse button for a left hander.  If the discussion says to click or double click something without specifying which button, assume the "Select Button". In general:

Context sensitive interactions are described in the following table.

BUTTON CONTEXT DESCRIPTION
Select on any label directly edit the label
Select on blue process line between objects opens a vertical space to insert something
Select & Drag on a blue process line drag and place a process and it's associated objects
Select & Drag on black process tail grow or shrink that process up or down
Select & Drag on a message arrow or tail drag and place message on another process
Select & Drag on the bottom of the timeout or reset arrow stretch the arrow up and down
Select & Drag on the bottom of the coregion stretch the coregion up and down
Escape key <ESC> During moded operations exits the mode and returns the drawing to its normal view
Menu on any object's label bring up the object's menu

RETURN TO TOP


pos_lucent.gif (1187 bytes)