Structured Specification Tab

The Structured Specification tab enables you to define the structure, actions and interactions of the scenarios defined for an element such as a Use Case. These scenarios can be the main or basic path, alternate paths, or exception paths.

elementscenario2

When you open the Structured Specification tab it defaults to the basic path (as shown above) so that if it does not already exist, you can create it. You can create alternate paths and exception paths as part of the process of adding them to steps of the basic path.

You can also create all three types of scenario paths on the Description tab, or in the Scenarios & Requirements window.

Set Up Scenario Specification

You can create a specification for a scenario in one of several ways:

To enter the specification yourself, starting with the basic path, follow the steps below:

  1. In the Scenario field, click on the drop-down arrow and select the Basic Path scenario.
  2. In the new step field in the Action column, type the text of the first step or action.

Note:

An entry for the basic path displays in the Entry Points tab, as Step 0 with no value in the Join column (the basic path does not rejoin itself).

  1. Tab to the Uses column and, if necessary, type the name of each element used in this step.

Note:

The values in the Uses, Results and State columns, whilst optional, are significant if you want to generate a diagram from the specification. If you type the name of an element linked to the current element (and listed in the Context References tab), the element name is highlighted and underlined.

  1. Tab to the Results column and, if necessary, type the outcome of completing this step.
  2. Tab to the State column and, if necessary, type the name of the state into which the step moves the action.
  3. When you move out of the Action column, the next new step field displays underneath. Repeat steps 2 to 5 as many times as is necessary.

By default, the steps begin with a user step (indicated by an actor icon) and alternate between user and system (indicated by a screen icon) steps. To change the entity responsible for a step, either double-click on the icon, or right-click on the step and select the Set Step as 'System' or Set Step as 'User' context menu option as required.

The Structured Specification tab should now resemble the following illustration:

Structspec

Repeat the Scenario Steps procedure for each scenario you have created. You can now adapt, enhance and interrelate the scenario specifications using the facilities of the Structured Specification tab.

Facilities Of the Structured Specification Tab

The Structured Specification tab offers a wide range of facilities for generating and modifying scenario specifications. These are available through the tab toolbar and a number of context menus.

Toolbar

The icons on the Structured Specification toolbar offer the following facilities:

Icon

Use to

Specsave

Save changes to the scenario specification.

specbasic

Display the basic path specification (only if another specification is currently displayed).

specalt

(Only enabled when the basic path is displayed - you cannot add an alternate path to another alternate path or an exception path.)

Create a branch from the selected step to an alternate path scenario - select the path from the displayed list. If the appropriate scenario does not yet exist, double-click on the new path line and type the scenario name, then click off the line and back on to it. Click on the OK button.

Note:

An entry for this alternate path displays in the Entry Points tab, as Step a of the basic path step it branches from; in the Join column, click on the drop-down arrow and select the number of the step at which action flows back to the basic path, or select End if the path terminates separately from the basic path.
 

scenario paths

specexcept

(Only enabled when the basic path is displayed - you cannot add an exception path to another exception path or an alternate path.)

Create a branch from the selected step to an exception path scenario - select the path from the displayed list. If the appropriate scenario does not yet exist, double-click on the new path line and type the scenario name, then click off the line and back on to it. Click on the OK button.

Note:

An entry for this exception path displays in the Entry Points tab, as Step a of the basic path step it branches from; in the Join column, click on the drop-down arrow and select the number of the step at which action flows back to the basic path, or select End if the path terminates separately from the basic path.

upscen

Move the currently-selected step one place up.

scendown

Move the currently-selected step one place down.

scendiag

Display a list of diagrams that you can generate from the scenario; select the type of diagram that you want to generate.

scentest

Generate Test Cases based on this Use Case scenario; you can generate either internal Test Cases or External Test Cases.

scendel

Delete the selected step from the scenario.

scenHelp

Display the Help topic for this tab.

Item/Blank Space Context Menu

To display this context menu, right-click on a step or blank line on the Structured Specification tab. The following options are available:

Option

Use to

Create Structure From Clipboard Text - New Lines

Create Structure From Clipboard Text - Sentences

Generate a set of steps from a text description or list captured on the clipboard. A new step is generated:

  • after each carriage return in the captured text (New Lines), or
  • for each sentence in the text; that is, after each full stop/space/capital letter combination (Sentences).

If a set of steps is already displayed, it is overwritten by the generated steps.

Create Structure From Generated Activity Diagram

Generate a set of steps from an Activity Diagram created for a Use Case.

If a set of steps is already displayed, it is overwritten by the generated steps.

Add Alternate Path

Create a branch from the selected basic path step to an alternate path (see previously).

Add Exception Path

Create a branch from the selected basic path step to an exception path (see previously).

Set Step As 'User'
Set Step As 'System'

Switch the entity responsible for performing the action of the selected step between user and system.

Link Step to Use Case

Either include the actions of an existing Use Case element, extend an existing Use Case element, or invoke a Use Case as the action of the selected step. Selecting the appropriate sub-option displays the Select Use Case dialog, which you use to browse for and select the required Use Case element.

The appropriate includes, extends or invokes stereotyped connector is created between the current element and the selected Use Case.

For the include and extend actions, any text in the Action field is overwritten by the link to the Use Case. For the invoke action, the following link is added to the end of the Action text:

[Invokes: <Use Case Name>]

Merge With Step

Merge the selected step with another. A list of the other steps in the scenario displays; click on the step to merge with the selected step.

Move After Step

Move the selected step to another position in the scenario. A list of the other steps in the scenario displays; click on the step after which to position the selected step.

Delete

Delete the selected step. A prompt displays to confirm the deletion. Any subsequent steps are moved up one place.

Text Selection Context Menu

To display this context menu, highlight the text in a user-editable field within a step on the Structured Specification tab. The following options are available:

Option

Use to

Create

Create a glossary definition or a new element based on the highlighted text.

Link Step to Use Case

Either incorporate the actions of an existing Use Case element, or extend an existing Use Case element, as the action of the selected step. Selecting the appropriate sub-option displays the Select Use Case dialog, which you use to browse for and select the required Use Case element.

Any text in the Action field is overwritten by the link to the Use Case.

Link to existing Element

(Uses and Results fields only.) Create a Realization or Dependency relationship to a Requirement, Feature or other element elsewhere in the model.

You select the element and connector types from submenu options, which then display the Select Element dialog, which you use to browse for and select the required element.

Insert Context Reference

Add a reference to an element stored elsewhere in the model, and create an entry for the element in the Context References tab.

Selecting this option displays the Select Element dialog, which you use to browse for and select the required reference element.

See also the Floating Toolbar section, below.

Insert glossary definition

Insert an existing glossary term at the cursor position. To select the term, double-click on it in the displayed list.

When you select the term it is inserted into the field as highlighted and underlined text, which displays the definition when you move the cursor over it. If you highlighted part of the original text, the term overwrites that text.

Split Step

Splits the selected step into two consecutive steps.

The option is available only if you highlight a portion of the text in the selected field. The new step takes the highlighted text as its Action text.

Search for <text>

Displays a sub-menu of options for locating the selected text in a number of locations.

Undo

Undo any unsaved changes you have just made in the step.

Cut

 

 
Perform simple editing operations on the highlighted text.

Copy

Paste

Delete

Select All

Entry Points Context Menu

The Entry Points tab shows how the basic path, alternate path and exception path scenarios for the element are organized and interrelated. If an alternate path or exception path has been defined but has not yet been added to the basic path, it is not listed on this tab.

You can switch focus between the Entry Points tab and the Structured Specification tab by pressing [Alt]+[Q].

To display the context menu for this tab, highlight an entry and right-click on it. The following options are available:

Option

Use to

Edit Path

Display the steps of the scenario in the Structured Specification tab, with the first step highlighted.

Join with Step

(Available only if the basic path scenario is displayed in the Structured Specification tab. Not available to edit the basic path scenario.)

Highlight the Join field and its drop-down arrow. Click on the drop-down to define or change the step number at which the alternate or exception path rejoins the basic path. Select End if the path does not rejoin the basic path steps.

Delete

(Available only if the basic path scenario is displayed in the Structured Specification tab. Not available to delete the basic path.)

Delete the relationship between the selected path and the basic path, and remove the entry from the Entry Points tab.

Floating Toolbar

Wherever a reference to another element exists on the Scenario tab (that is, where the text is highlighted and underlined), if you hover the cursor over the element name a short floating toolbar displays, which you can use to:

  • display the element Properties dialog
  • locate the element in its parent diagram
  • locate the element in the Project Browser.