UBET ANNOTATION FEATURE


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



Content


General Description

Annotation allows text to be associated at the file (itu or ucg) or graphical object level. Annotation allows the user to capture non-graphical information that supports the models.

Annotation capabilities

Files have the following annotation capabilities:

Objects, which include: nodes, edges, messages, processes or actors, have the following annotation capabilities:

Annotation operations

Three basic operations support editing textual information:

ADD BUTTON Open a dialog box to include a new entry on the annotation window. The specific entry is related to the selected TAB.
EDIT BUTTON Open a dialog box to change an existing entry on the annotation window. The specific entry is related to the selected TAB. An entry must be selected before this button can be activated.
DELETE BUTTON Delete a selected entry from the annotation window.

Interface Description

To activate the annotation window two mechanisms are available: (a) the annotation icon on the tool bar and (b) the annotation option under the View Menu. They are  switches that hide or unhide the annotation window. Once activated the annotation feature will expand the window.

Tabs description

The annotation window includes  BUTTONs or TABs associated with each file or object annotation capability. They are located on the top of the annotation window. Following is a description of each tab an their operation.

Tabs annotation - file level

a) DESCRIPTION TAB. Will allow capture of Use Case Title and a Use Case description. The title should be a short and meaningful name for the use case, related to its goal. The description area provides enough room to include details that make the Use Case goal clear and complete.

There are no constraints on text length and special characters are allowed.

b) ACTORS TAB Allow to capture actor's name and description of actors that participate in the Use Case.

To Add an actor press the ADD button on the right side; it will show the following dialog box in order to capture actor's data.

When ready, just press add  to post the information on the annotation window or exit to cancel the entry.

To change the data related to an actor, select it from the annotation window (mouse left button click) and press the EDIT button. It will move the selected entry on the dialog box.

After changes had been made, press change to update the actor's information or press exit to cancel the action.

c) CONTRACT TAB. Contracts allow to specify pieces of information that are interchanged between the system and actors for the Use Case. Three elements are specified for each contract:

  1. the message or piece of information
  2. contract type: having a system point of view; it is an input from an actor or it is and output to an actor
  3. The actor's name who receive or send the message.

Press add to include a new contract or press edit to modify an existing contract, after selecting the entry from the list box of contracts. The dialog boxes to ADD or to EDIT contract are

To add a new contract select the actor from the list of available actors, select the contract type with the radio buttons Input or Output,  describe the message name and press add to post the information on the annotation window.

d) Under CONDITION TAB, include details of the information exchange between actors.

The dialog boxes to add or edit a condition require a description of the state and define it as a pre or post condition.

The search button on the left, look for available "uses" on the active directory; the search button on the right side look for "extends" available on the active directory.

f) SPECIFICATIONS, ISSUES and REFERENCE TAB have a similar look and behave in a similar way.

The list box on the left side containt the available specification ID. The text field on the right allow to capture or to show available information for the selected specification id. An id can be selected by clicking it on the list box. Using the add button create a new entry on the list box and provide a clean area to start providing infomation. The id number is automaticaly assigned by the system.

e) Under the USES AND EXTENDS TAB the user will see the list of available USES and EXTENDS used in the Use Case.

i) Under the  VARIABLE TAB the user will define variables needed.  

the dialog boxes to add or edit an existing variables are similar to this one:

To edit an entry, just select if from the variable list boxes and press edit; the system will open the dialog box with its information allowing to modify it.
There is no constraint on the information that you can include on each field.

Tabs annotation - object level

To annotate an object select it from the canvas. The annotation window will present the available TABs and information for the selected object type.

a) DESCRIPTION TAB has two fields; the first one should be used for detailed information about the object. The second field is for a short object name that can be used when  building expressions.

b) ISSUES TAB. The fields and behavior for this tab is the same as the SPECIFICATION TAB at the file level, but its scope is constrained to the object.

For nodes and edges, the object window will be extended with the following TABs:

c) NODES EXPRESSION TAB. Allow expressions: constraint, action and select. Object names can be used or variables accessible to the object scope. There is no limitation on the number of characters per line. Currently there is no checking of expressions.

d) EDGES EXPRESSION TAB. Allows expressions: constraint, conditions and arguments. Object names can be used or variables accessible to the object scope. There is no limitation on the number of characters per line.

Current limitations

  • There is no printing facility for annotations. Via the HTML export facility, the user can produce output that includes annotation information.
  • Only messages and processes may be annotated.
  • When an object is removed, its annotation information is also removed. The undo command will not restore annotation information.
  • Annotation information is saved when the "ucg" or "itu" file is saved. If only the annotation information is modified, the user needs to ensure that the file is saved. The system will not detect the need for a file save based on annotation changes only.

Technical Details

The annotation information is saved in a "annotation" directory under the active directory. It uses a text file named: filename_type.ann. filename is the same name as the original file, type is "itu" for MSE files or "ucg" for UCE files.

The annotation file can be edited by a word processor like MS-Word, FrameMaker but the user must first remove special delimiters used to identify fields.

pos_lucent.gif (1187 bytes)