MESSAGE SEQUENCE EDITOR (MSE) -
OPERATIONS
[UBET Installation & Setup][MSE User Guide][UCE User Guide]
This page describes operations that can be performed with the Message Sequence Editor (MSE).
On Windows 95 or NT, an icon for MSE
is placed in the UBET program group during installation. Double clicking
it will start MSE. Entries are made in the registry during installation so that
Message Sequence Files (MSC) having the .itu suffix are recognized by the operating system
and are identified with the same icon. Thus users may use Explorer to locate them
and launch MSE 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, mse, to start the Message Sequence Editor.
Users can set several preferences that help structure their environment and make working with MSE (and other parts of UBET) much easier. The two most important for UCE are the Design Directory and Document 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 figure below shows the MSE Preference Dialog
| Preferences | Description |
| Help Director | The Help Directory field can be used to point to an alternate location for program help. It is not necessary to set this, since UBET tools use the documentation delivered with the software. |
| 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. Saving a file in another directory makes the new directory the current directory for that instance of UBET. |
| Object Structural Model | The Structural Model field is the name of the file containing an ObjecTime model supporting the ObjecTime interface. The ObjecTime model serves to constrain the naming of Processes, Ports, Protocols, and Messages so that Message Sequence Charts generated by MSE can be read and matched to an ObjecTime design. |
| Reference 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, listing all files that have a .doc suffix. |
In addition to the preferences in the table above, the user may configure several other
parameters for the operation of MSE. These are listed in the table below.
| Setting | Description |
|---|---|
| msc name in output file | The MSC has a name that can be set through the canvas menu. Setting this checkbox includes it in exported figures. |
| filename in output file | Includes the file name as part of the title in graphical outputs |
| path in output file | Includes the path to the file as part of the title in graphical outputs |
| date and time in output file | Includes the date/time as part of the title in graphical outputs |
| use Images in Toolbar | The tool bar is displayed with images, otherwise, the tool bar buttons display only text |
| enable automatic label editing | When checked a small text box appears as each new named object is added to the drawing. |
| Interval for auto numbering | This sets the interval for autonumbering operations. By default, this is set to one. |
| allow spaces | user can create name containing spaces (not Z.120 compliant) |
| convert spaces to underscores in names | when users use spaces in names automatically map spaces to underscores as they leave any dialog. This avoids collisions with keywords in the Z.120 specification. |
| allow ObjecTime characters | permit a single colon and slashes in process names(not Z.120 compliant) |
| allow dashes | user can create name containing dashes (not Z.120 compliant) |
| allow ampersands | user can create name containing ampersands (not Z.120 compliant) |
| Wrap textbox texts chars | set the width in characters for textbox wrapping |
The user may also identify non-standard characters that they wish to use in naming objects in MSE. The characters we check are space (' '), dash ('-'), underscore ('_'), and ('&') as well as colon (':') and forward slash ('/') for ObjecTime. As users have been using several of these in previous releases, MSE is shipped to allow all of these characters except those needed for ObjecTime (':' and '/'). We strongly urge customers to turn these switches off to increase the probability that the MSCs they generate can be read in other tools. The consequence of turning off the switches is users will be warned when they change a name after entering one of the non-standard characters. This way they can easily change the entry to stay within the standard. Even if non-standard characters are saved with the file, it will still be read by MSE. Also, the Text object always allows these characters even if they are not checked.
Finally, the preference enable automatic properties dialog assists with naming objects during MSC creation. When one of these is set, a text entry widget is automatically presented each time the user adds an object (process, message, timer, condition, textbox). 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. Hitting escape leaves the text entry widget without applying changes. Textboxes are handled slightly differently since they can contain serveral lines and the carriage return is needed to create the new lines. Close textboxes by clicking the OK button or the select button on the canvas.
To change the values for these environment preferences, do:
These values are saved in the Registry for Windows 95/NT and in a file, $HOME/.ubet, for Solaris 2.5. Solaris users can change the preference file location other than $HOME/.ubet by setting the environment variable MP_ENV to point to a different file. For example:
UBET will look at the file at $MP_ENV to get and put preferences if it is set.
RETURN TO TOP
RETURN TO TOP
It is possible to aggregate Message Sequence Charts using the MSE program. Each new file is added to the current Message Sequence Chart trace by appending any new process bars to the right of existing process bars. Any new events are added after existing events or to the new process bars.
RETURN TO TOP
Click File/Exit to quit MSE. If the file has been modified, a dialog will prompt the user to save before quitting.
WARNING: do not quit by using the window manager's menu on the title bar. It does not prompt for save before quitting when the file has been modified.
An Message Sequence Chart can be saved in the native format (Z.120) and five export formats: Ascii, MIF, GIF, Postscript and WMF (Windows 95/NT only). The export formats cannot be read by MSE, so be careful to save in the native format.
RETURN TO TOP
Several alternative export formats are supported by MSE. These are shown in File/Export
dialog box as the following:
| Format | Description |
| ASCII Scenario | Generate a text file describing Scenrios in a human readable format. |
| FrameMaker MIF | Imported format for FrameMaker |
| GIF | Graphics Interchange File |
| Postscript | Generates a Postscirpt file |
| WMF | Generates a Windows Meta File |
| SeqFlow | Produces a message sequence chart specification in the Seqflow dialect |
The GIF format is provided to make it possible to import drawings into MS Word (this also allows them to be placed on the web). At the same time you generate the GIF, you can also produce a file with the same root name and a .csv suffix that shows the complete set of reference tags defined in the drawing.
RETURN TO TOP
MSE can produce a Postscript file that can be sent to many printers.
RETURN TO TOP
MIF can be imported into FrameMaker documents or simply opened as a FrameMaker document.
RETURN TO TOP
The ASCII Scenario is a human readable format useful for debugging and review.
RETURN TO TOP
The Windows Metafile is a vector graphics format that can be imported into Microsoft Word as a picture. Word handles this format more efficientely than it does GIF files.
RETURN TO TOP
SeqFlow file is a message sequence chart specification in a specific language.
RETURN TO TOP
It is now possible to print a drawing on Windows 95/NT directly from MSE. 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:
After the printing setup is completed, you can choose File/Print to print the MSC directly or choose File/Preview... to view the MSC any time.
With the exception of process bars, adding objects is always started by clicking the appropriate menu or toolbar item, then clicking with the Select button at an empty spot on a process bar. The initial step depresses the corresponding object button and starts a moded insert operation. The user can exit insert mode by:
Most objects added to an MSC have a name or identifier (see naming notes). This includes processes, messages, states, and timers. Text boxes have free text. There are two methods for adding these. They can either be added with an program generated name or the user can request through preferences that the a small text box be brought up as each object with text is added. To use the second approach, check the enable automatic label editing check box in the preferences dialog (found in the File/Preferences... menu item). The name can always be changed later by clicking over the text.
The storage format for MSE is the ITU standard Z.120 format. The grammar for Z.120 is quite restrictive and many users have found it too constraining. We have added several preferences that allow additional, Z.120-disallowed characters in names, but the most annoying problem customers have faced is constraints on the use of Z.120 keywords. For example, "from", "to", "in", and "out" are prohibited by the grammar. There is a user preference that will allow users to use keywords such as these. The preference is the "convert spaces to underscores in names" checkbox on the File/Preferences... dialog. Checking it will cause all dialogs (other than textboxes) to automatically convert all spaces to underscores as they leave the dialog. If the user enters just a single kyeword, the program will append an underscore to the name.
RETURN TO TOP
Most Message Sequence Chart objects are added to an existing process bar. To do that, room must exist on the process bar to place the object. Attempts to place objects on occupied spaces will fail. To make room for another object, click the Select button over the vertical process bar to spread existing objects. Note coregions must have a place for the top of the coregion AND the bottom.
Once in message insert mode, the user can repeatedly add messages by repeating the following steps. NOTE: this mode does not end after the first message. The user must hit the escape key or start another operation to end insert message mode.
RETURN TO TOP
RETURN TO TOP
RETURN TO TOP
Adding a timer is a two step process. Add the timer box, then add the timer reset or timeout below the box. Note: both parts of the timer (timer set and timeout or reset) must be added for a valid timer.
RETURN TO TOP
A coregion is attached to a process bar at two points, one above the other. A coregion can include several messages, but do not try to put a state in a coregion. Be certain to make space for the upper and lower attach points.
RETURN TO TOP
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.
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.
All objects are deleted in the same way. If a process bar is deleted, all attached objects (messages, timers, etc.) are deleted as well.
NOTE: to delete a process, 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.
Another way to delete any object is to place the mouse over the object, and click the Menu button to invoke the object's menu. From the object's menu, click Delete. To delete a process, user can click anywhere on the process. To delete a coregion, user must click on the outline of the coregion excluding the top.
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 apply only
to mesages in MSE. They appear in front of the label within square brackets. Once a note
number is established, they show up in all graphical outputs (GIF, MIF, encapsulated
postscript, etc.). The figure to the right shows a node with the note number 10 preceding
the message label, getkey.
Note numbers can be created in two ways: through the edit menu or through an individual object's properties dialog. The menu generated numbers are applied to all messages, so it makes sense to use the menu if you plan to comment on every message. The properties dialog allows the user to supply a note number for an individual message. This approach is useful if the user is only going to annotate a few of the messages in the drawing.
The
menu for note numbering is under the Edit menu. Click Edit/Auto
Number.../Auto Number All Messages to insert note numbers for all messages. 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., 10, 20, 30, etc.).
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.
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 messages that already have note numbers. To resequence the
currently numbered messages, click on Edit/Auto Number.../Renumber Messages or use
the toolbar button
. The sequencing interval from preferences
is used to resequence.
Note numbers can be removed one at a time by using the messages properties dialog. Just backspace over the note number. The user can also remove the note numbers for all messages by using the Edit/Auto Number.../Clear Message Numbers.
Cutting and pasting help users to move a text box from one location to another.
To cut a Text box away from a process,
The Cut function will cut away the Text object and store it in a buffer.
To paste the object in the buffer on another process,
The object in the buffer will be paste at the spot where the mouse was clicked.
The same state can be in effect for several processes at the same time. This is often
the case at the start of an MSC. MSE supports copies of states from one process bar to
another.
To copy a State on a process,
The Copy function will copy the State object and store it in a buffer.
To paste the object in the buffer on another process,
The object in the buffer will be paste at the spot where the mouse was clicked.
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:

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
RETURN TO TOP
It is possible to change the attach points of a message to a different place on the process bar or even to another process bar. As always, room must exist for the new attach point and the arrow end of the message cannot be placed higher in the drawing than the starting end.
RETURN TO TOP
It is possible to change the attach points of a Timeout or Reset arrow to a different place on the process bar. As always, room must exist for the new attach point and the arrow tail (Timeout) or head (Reset) end cannot be placed higher in the drawing than the starting end.
RETURN TO TOP
It is possible to stretch the bottom of a Coregion to a different place on the process bar. As always, room must exist for the new attach point and the the coregion tail end cannot be placed higher in the drawing than the starting end.
RETURN TO TOP
Any of the following will expand or shrink the bottom of the drawing or a process bar
RETURN TO TOP
Clicking View/Redrawor Redraw tool button
will remove any gaps on
process bars and properly sequences messages.
RETURN TO TOP
There is little room to show the text of long names or the reference tags on an Message Sequence Chart. To display long names or reference tags, place the mouse over the text field on objects. Any truncated text or reference tags will be shown in a small balloon similar to tool tips on Microsoft applications.
Users can enable or disable this feature by toggling the Enable Tool Tips switch under the View menu.
One can compare two MSCs to find the first place in the current graph that differs. This activity is initiated from the Tools/MSC Difference Report... menu item. The user is shown a dialog with the current file's name in the Current MSC field. File in the name of the comparison file (probably a predecessor of the current file) in the Original MSC: field using the Browse button. The Report Detailed Difference checkbox reports when there are differences such as changes in reference tag associations. If the user clicks the Show First Difference button, the first difference is displayed.

MicroSoft Word documents can import either GIF or WMF outputs. With this release, it is possible to produce outputs in both of these formats. Export the drawing in GIF format or WMF format to produce a graphical view that can be imported into Word. 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 do this. The description includes steps showing how to get gif files to the PC. It assumes you have saved several drawings using the .gif and .csv suffixes and that you are using command line (DOS Window) ftp to move them to the PC. The similar instructions can be applied for importing WMFs into Word.
WARNING: Word is not tolerant of import file anomalies. In transferring 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. If you are working on a UNIX machine, you need to do the following steps to transfer the gif and csv files to a Windows system.
Now follow these instructions to import the gif and the csv files into your Word document.
RETURN TO TOP
Race condition and real-time conflict audits can be run at any time with the current parameter settings by clicking the appropriate toolbar button or by clicking the Checks/Check Timing Conditions or Checks/Check Race Conditions menu items. To set the parameters click Check/Set Checking Parameters to pull up the following dialog.