IBM
Contents Index Previous Next



Menu Bar


This section describes the menu bar of the Organizer Main window and all the available menu choices.

The menu bar contains the following menus:

Available Menu Choices

The following concepts affect the menu choices that are available in the menu bar.

Long and Short Menus

The user can choose between long and short menus with the menu choice View Options in the View menu. Menu choices only available in long menu mode are presented with the menu choice name within parenthesis in the textual enumeration of menu choices for a menu in the following sections.

License Dependent Menu Choices

The following menu choices are only available if the corresponding tool is available according to the license configuration:

License Affected menu choices

Code Generator

Make

Simulator

SDL > Simulator UI

Explorer

SDL > Explorer UI

Configurable Menus

In the SDL Suite, some menu choices may be available through the concept of user-defined menus. For more information, see "Defining Menus in the SDL Suite" on page 18 in chapter 1, User Interface and Basic Operations.

File Menu

The File menu contains the following menu choices. (Menu choices within parenthesis are not available in short menu mode.)

New

This menu choice displays a dialog, with the following possibilities:

If you want to start with a template system, you will have to specify the directory to unpack the archive file in, in "Unpack Archive" on page 69 that follows.

If a system file already is open in the Organizer, the behavior is determined by the status of the existing system. If modified information exists, the user first gets the possibility to save it; see "The Save Before Dialog" on page 65.

The new system is then created in memory. Source Directory and Target Directory are left unchanged, i.e. set to the values they had before the New operation.

Note:

The actual value of a directory in the Set Directories dialog may change if the directory is set to System file directory. Since there is no system file associated with a new system, the SDL Suite and TTCN Suite start-up directory is used until the file is saved.

You have to save the system to create a system file on disk.

The old contents of the drawing area is replaced with the basic Organizer view. If any of the documents in the old system managed by the Organizer were opened in an editor, these editor windows are closed.

Open

This menu choice is usually used to open an existing system file. It can also be used to open a single diagram or document file, as well as to open and resolve a *.scu file.

Opening a System File

If a system file is already open in the Organizer, the behavior is determined by the status of the existing system. If the information is not modified, the Open dialog is issued (see below). If modified information exists, the user first gets the possibility to save it; see "The Save Before Dialog" on page 65.

The Open dialog is a standard file selection dialog, with the file filter set to *.sdt. The Open button in the dialog opens the specified system file. The old contents of the drawing area is replaced with the new system. If a system window state file is found, see "System Window State File" on page 200, the window position and size is restored to the position and state it had when the system file was saved. If any of the documents managed by the Organizer were opened in an editor, the editor windows are closed.

If the system file does not specify the Source Directory and/or the Target Directory explicitly, these directories are set to the directory where the system file was found.

The following information consistency checks are performed when opening a system:

Opening a Diagram or Document File

If you are only interested in examining the contents of a single diagram or document file, you can specify the filename of that diagram or document in the open dialog. (It might be helpful to change the filter in the open dialog first, to be able to view the existing files of the type that you are interested in.)

If you specify the filename of a single diagram or document in the open dialog, then a new system file will be created, only containing the specified diagram or document. The diagram or document will also be loaded and shown in an appropriate editor. Note that no sub(structure) diagram files will be visible in the Organizer view.

Opening a *.scu File

Software control unit files *.scu are used to allow several people to work in parallel on the same SDL diagram structure. When you update your *.scu files, for instance by using the Configuration > Update menu choice, the SDL diagram structure might change, if someone else has changed the structure and checked in an updated *.scu file.

You can have a top *.scu file associated with the system file symbol in the Organizer drawing area. This *.scu file will take control of the diagram and document structure in the Organizer, leaving the *.sdt file with only control over the user settings (print, view...) and a little system state information (when was the SDL system analyzed without errors last?)

Opening an *.scu file is the same as creating a new system by attaching a *.scu file to the system file symbol in the Organizer and using Configuration > Update to update the diagram and document structure according to the contents of the *.scu file.

Opening an Archive File

Opening an archive file (*.tgz) invokes the unpack archive file operation. Read more about this in "Unpack Archive" on page 69.

Save

This menu choice saves all modified documents and control unit files known to the Organizer, the link file, and finally the system file used by the Organizer. You can still perform a save even if the Organizer contains a completely new system, or if the system has not been changed since the last save operation. The menu choice has the text Save (not needed) in this situation.

Whenever the system file is saved, the system window state file is saved as well. See "System Window State File" on page 200.

If the system file is modified and needs saving, an asterisk `*' is appended to the name of the system file in the Organizer's title bar.

When the first document that is modified is encountered in the Organizer's view of files, the Save dialog below appears. If not Save All, Quit All or Cancel is selected, the dialog will remain on the screen and all modified documents will be handled by the dialog subsequently.

Whether the document is connected to a file or not will affect the layout and behavior of the Save dialog. For any unsaved and unconnected documents found, the user must provide a filename to connect to.

If the system has been saved before, the system file is saved (without a dialog) after all diagrams and documents have been saved. If the system never has been saved, the Organizer presents a dialog and proposes a name for the system file; the prefix is the name of the first document in the structure, the extension is .sdt.

The fields and buttons in the Save dialog are:

Save As

This menu choice works as the Save menu choice with the following differences:

The Save Before Dialog

Some operations in the Organizer need to save information before the actual operation can be performed. The saving is only performed if modified information exists in the system. In these cases a Save Before dialog is opened, which is very similar to a normal Save dialog. The dialog title is Save before <command> and some buttons may behave differently (see Figure 12 on page 71). If not Save All, Quit All or Cancel is selected, the dialog will remain on the screen and all modified files will be handled by the dialog subsequently.

The Save Before dialog is opened for the following menu choices:

Auto Saving

When selecting any of the Generate commands Analyze, Make, Convert to PR/MP or SDL Overview, the Save Before dialog does not appear if the preference AutoSaveBefore is set. However, unconnected and modified documents still require user interaction. If such documents exist, the dialog appears.

Pack Archive

Pack files related to the system loaded in the Organizer into an archive file (*.tgz).

The archive file has the extension *.tgz and is packed using tar and gzip. This means that the archive file can also be unpacked without using the SDL Suite, from the command line, using g(un)zip and tar.

Note:

Packing and unpacking archive files will only work if the SDL Suite can access the external tar and gzip programs, see "Additional required tools and utilities" on page 4 in chapter 1, Platforms and Products. The external tools can be pointed out with the preferences "TarCommand" on page 246 in chapter 3, The Preference Manager and "GzipCommand" on page 246 in chapter 3, The Preference Manager.

The first Pack Archive Dialog

To use the pack operation, have the files you want to create an archive file for in the Organizer and invoke the operation. The first pack archive dialog will appear, where you can do the following things:

The second Pack Archive Dialog

When pressing the Next button in the first pack archive dialog, the second pack archive dialog appears, where file types to include can be decided. The following file types are included as default:

The following file types are not included as default:

The second pack archive dialog also makes it possible to include files from the source or target directories with specific extensions. These extensions should be specified in the Also include files with the following extensions text field (a comma separated list of extension names). As default, *.lst files from the source or target directory are included in this way, with the text field text set to lst.

The third Pack Archive Dialog

Pressing the Next button in the second pack archive dialog displays the third pack archive dialog, where all files that will be included in the archive are listed. A file in the list is usually presented in the following way:

<file system file name> (-> <archive file name> )

In the dialog, it is possible to include or exclude individual files.

When you are satisfied with the list of files that will be packed, press the Pack button to start the pack operation. Information from the pack operation can be found in the Organizer Log.

Unpack Archive

This operation unpacks files in an archive file (*.tgz), and places them in a directory in the file system.

An archive file is created and unpacked with the external tools tar and gzip, that both must be available for the operation to work. The external tools can be pointed out with the preferences "TarCommand" on page 246 in chapter 3, The Preference Manager and "GzipCommand" on page 246 in chapter 3, The Preference Manager.

An archive file can be unpacked in one of the following ways:

The Unpack Archive Dialog

Whenever SDL Suite is used to unpack, and the unpack directory has not been specified, the Unpack Archive dialog appears. The dialog has three things that should be considered:

Print > All

Similar to Print > Selected. The difference is that for Print All, the selection is not considered, all diagrams and documents are always printed, if the set of diagrams and documents to print is not further refined in the print dialog.

Print > Selected

Prints all or some of the diagrams in the Organizer. See chapter 5, Printing Documents and Diagrams, for more information about the dialog and some examples of how to print. The Organizer selection decides the set of diagrams and documents to print, if the set is not further refined in the print dialog.

Print > Selected and Colored

Similar to Print > Selected. The difference is that for Print Selected and Colored, only pages (when pages are shown in the Organizer drawing area) or diagrams (when pages are not shown in the Organizer drawing area) with at least one colored symbol are printed. A symbol is colored when the symbol has a border color other than black or a fill color other than white.

Print > Selection File

A file selection dialog appears, where a print selection file should be specified (*.sel). The print selection file is read, and the Organizer print dialog is displayed, updated to reflect the state that the print dialog had when the print selection file was saved from the print dialog. The print selection file is capable of remembering:

Note that print selection files can also be used by having a print selection symbol in the Organizer. In that case, you can use the print selection file and invoke the print dialog by double-clicking on the print selection symbol.

Set Directories

This menu choice sets the source and target directories. For more information on these directories, see "Source Directory" on page 44 and "Target Directory" on page 44.

This menu choice is only available if the system file can be changed.

If the source directory is changed while a Save dialog is active in an editor, the directory where the editor saves the diagram is undefined. An ongoing analysis is not affected by changing the target directory.

Figure 12 : The Set Directories dialog

PC Drives

This menu choice displays the drive table of the currently opened system, i.e. the mapping between drive names in Windows and the beginning of corresponding directory paths on UNIX. For more information, see "Windows and UNIX File Compatibility" on page 216.

This menu choice is only available if the system file can be changed.

The following dialog is opened:

Figure 13 : The PC Drives dialog

The text area displays the drive table currently used in the system. The table can be edited directly in the text area. When the system file later is saved, the table is stored in the The Drives Section.

When clicking OK, a basic syntax check is performed on the entered drive table. Each line should consist of two items only:

Paths containing spaces must be put within double quotes. Note that within double quotes, each backslash must be entered as two backslashes, i.e. a UNC path \\host\dir name (containing spaces) must be entered as "\\\\host\\dir name".

If any errors are found, the user is notified and the dialog is not closed. If the table was changed and found to be syntactically correct, the system file is marked as modified.

Note:

Changes made in the PC Drives dialog only take effect when the system file is reloaded.

Compare System

Works as Merge System, except that there is no possibility to merge the differences found during the compare operation.

Merge System

This menu choice compares the contents of the Organizer Main window with the contents of a system file (.sdt file). The compare operation is performed on a diagram/document level.

This menu choice is only available if the system file can be changed.

The two systems are compared and possible differences are reported to the user, with the option to merge them, by specifying which documents to add and which to remove in the Organizer system.

The information is processed according to the following scheme:

  1. The user is asked to exit any editors, if any is found running. This means that modified documents must be saved before the comparison can be started.
  2. If the system file is modified, the user is prompted to save it in a The Save Before Dialog.
  3. A standard file selection dialog is issued, where the system file to compare the Organizer system with may be selected. Choosing a system file in this dialog starts the compare operation.
  4. If there are differences between the options set in the Organizer and the options saved in the system file to compare with, these are reported first, as a text in a separate dialog. The text might look like this:
    Comparing system in Organizer
    
    with /home/develop/lat/target/DemonGame.sdt.
    
    
    
    Options saved in system file differs:
    
    
    
    SemanticControl differs: False True
    
    Kernel differs: SCTVALIDATOR SCTADEBCOM
    
    
    
    If you want to remove these differences, you have to do it manually by changing different settings in the Organizer. For instance, to remove the SemanticControl difference by updating the Organizer settings, bring up the Analyzer dialog and select Semantic analysis. (SemanticControl is the word used in the system file, Semantic analysis are the words used in the graphical user interface for the same thing.)
  5. The Compare System dialog is issued, where the diagram and document differences are reported (if the Organizer system and the contents of a system file are found identical, this is reported in a message box and the operation is terminated).

Figure 14 : The Compare System dialog

  1. The user decides if and how to merge the two views, by selecting or deselecting the items to include or exclude from the resulting system. OK updates the system in accordance with the settings.
The Merge System Dialog

The items in the Organizer diagrams list are the icons that were found in the Organizer's chapters.

By default, all items that originate from the Organizer are selected, meaning that they will be included in the merged view.

Figure 15 : A diagram originating from two sources

The MSC DemonGame has been found both in the current Organizer view (where the diagram is connected to a file) and in the system file (where it is connected to another file). The dialog suggests by default to include the diagram originating from the Organizer (the left list) and to exclude the diagram originating from the system file. The user may however change the selection to merge the systems in a different way.

The <system file> list indicates the directory and name of the selected system file. The items in this list are the items that were found in the system file.

By default, given two documents that are considered almost equal, the dialog will select the document originating from the Organizer, not the document originating from the system file. See example in Figure 15, above.

How Systems Are Compared

Some rules that govern how systems are compared:

Note:

Compare System and Merge System do only compare the structural system information saved in the system file. Compare System and Merge System do not compare the document contents, such as page names.

Associations and Dependencies

The Compare System function preserves, as far as possible, the association and dependency links that exist between documents:

  1. When an association link is found in a system file, the file names of the two documents are saved.
  2. If a document with an association link is selected by the user to be included in the Organizer, a new link is generated if a document with the previously saved file name can be found in the Organizer structure. If such a document cannot be found, the association link is removed from the included document.

Import SDL

Imports an SDL diagram or a number of SDL diagrams in SDT-2 or SDT-3 format, and extracts the diagram structure with the possibility to save it in a system file. The command may, on demand, convert the imported diagrams into SDT-3 format without the need to involve the user for each diagram to convert. It is not possible to import an SDT-3 system file.

This menu choice is only available if the system file can be changed.

To avoid potential name conflicts when saving an imported diagram structure, the menu choice will not perform any action, and causes a message box to be displayed, in the case any files are opened in an editor.

Basically, the involved diagrams and their corresponding files are bound and presented in the Organizer. A number of information entities can be extracted from the diagrams.

If a system file already is open in the Organizer, the behavior is determined by the status of the existing system structure. The user is first asked to exit any editors, if any is found running. This means that modified documents must be saved before the import is started. If a modified system file exists, the user first gets the possibility to save it; see "The Save Before Dialog" on page 65.

The following dialog is then opened:

Figure 16 : The Import SDL dialog

The root diagram to import and convert can either be named logically with type and name, or physically with a file name. The specified diagram will become a new root diagram, placed last in the Organizer.

Figure 17 : The Import SDL Details dialog

Figure 18 : Import diagrams warning

Recently used system files

Just above the Exit menu choice, there can be up to four menu choices representing recently opened system files. To open one of them again, select the appropriate menu choice. The information about recently used system files is saved in a file called .sdtfiles, in your home directory (see "Environment Variables" on page 33 in chapter 4, System Setup, in the Installation Guide).

Exit

This menu choice exits the Organizer.

The exit operation consists of four phases:

  1. Handling of modified files managed in the Organizer structure.
    If modified information exists in the current system structure, the user gets the possibility to save it; see "The Save Before Dialog" on page 65. The dialog is opened for the first file (document/system file) that is modified in the Organizer's view of files. The user can then choose how to continue. If the user does not select Save All, Quit All or Cancel, the dialog will remain on the screen and all modified files will be handled by the dialog subsequently.
    The link file and the system file are saved last, if necessary. If the Exit process at a later stage is cancelled, all documents in the editors are still available, since they are not closed until all modified documents are handled.
  2. Confirmation of Exit.
    If no analyze, make, simulation or validation jobs are active, the Organizer exits without user confirmation. If there are such active jobs, or a simulator/explorer UI is executing, the user has the possibility to force an exit of these jobs:

Figure 19 : Exit confirmation with active jobs

  1. Removing of documents in editors.
  2. Shutdown of tools.
    All SDL Suite and TTCN Suite tools are terminated, possibly issuing a Save before exit dialog. Finally, the Organizer itself is terminated.

Edit Menu

A general mechanism to edit the document structure(s) in the Organizer does not exist. Some of the menu choices in the Edit menu are used for basic operations on root documents and file connections. However, most changes to the document structure are a result of operations made in the diagram editors; see "Reference Symbols" on page 1897 in chapter 43, Using the SDL Editor.

The Edit menu features the following menu choices (menu choices within parenthesis are not available in short menu mode):

Edit

This menu choice edits the selected symbol or document. A document is edited by starting the corresponding editor. A document which is opened in an editor has its name shown in bold face in the Organizer.

The menu choice is dimmed if the selected icon is invalid, or if an instance or dashed SDL diagram icon is selected.

The operation performed depends on the type of symbol or document selected, according to the following:

Type of symbol or document Operation performed

System file

The CM Group dialog is opened (see "Configuration > Group File" on page 97).

Link file

The Link Manager is opened.

Directory symbol

The Set Directories dialog is opened (see "Set Directories" on page 71).

Chapter

The Edit Chapter dialog is opened. This dialog contains three choices:

  • Edit chapter symbol: the Edit dialog is opened (see below) to allow editing the symbol type, the chapter name, or the connected text file.
  • Edit chapter options: the Chapter Options dialog is opened (see "Chapter Options" on page 110).
  • Edit first page after chapter: the first connected SDL diagram or page after the chapter symbol is edited (see below).

Module

The Edit dialog is opened (see below) to allow editing the module name.

Connected document or header/footer file

The document/file is opened in an editor. For a diagram, the first page in the diagram is shown, or if the user has specified a page to open first in the editor (see "The Open This Page First Option" on page 2039 in chapter 43, Using the SDL Editor), this page is shown instead.

Association or dependency link

The corresponding referenced document is edited as if it was the selected document.

Page symbol

The page is opened in an editor.

Unconnected document or header/footer file

The Edit dialog is opened (see below).

The Edit dialog looks like this:

Figure 20 : The Edit dialog

Add New

This menu choice adds a new document to the system. Normally, the added document is placed as a root document below the current selection. If there is no selection, the document is placed as the first root document in the Organizer. Adding a diagram also involves an update of a control unit if there is one that is associated with the diagram substructure affected by the Add New command.

There are two exceptions to this:

This menu choice is only available if the system file can be changed.

To add SDL diagrams other than root SDL diagrams, the SDL Editor is used (see "Adding a Diagram Reference Symbol" on page 1915 in chapter 43, Using the SDL Editor).

The same dialog is opened as for Edit on an unconnected document (see Figure 20 on page 88). By default, the Show in editor button is on.

If there is a selection, Document type and Document name in the dialog will be set to the selected symbol's type and name. If there is no selection, the dialog will show the settings from the previous invocation. If it is the first time this dialog is used, the default type Module and the default name "Untitled" will be used.

Multiple root diagrams with the same name are allowed.

If an SDL diagram was selected and an MSC diagram is added, an association link to the MSC diagram is automatically added to the SDL diagram.

Add Existing

This menu choice adds an existing document file to the system. (It is also possible to add several documents by specifying a directory) The existing document is added at the same place as described for the Add New menu choice. Adding a diagram also involves an update of a control unit if there is one that is associated with the diagram substructure affected by the Add Existing command.

This menu choice is only available if the system file can be changed.

A dialog will be opened, that allows you to specify the file to add, either via a text field or via a standard file selection dialog.

There are also three options in the dialog:

If the standard file selection dialog is used, the file filter is set to reflect the currently selected document type. If a module is selected, the file filter is the same as in the previous invocation. If no document is selected, the file filter is set to .s??.

The document type and logical name of the existing document is determined in different ways for different document types. The type and name is determined by:

Note:

It is not possible to add a document that does not have a default file extension. For information about default file extensions, see "Save" on page 11 in chapter 1, User Interface and Basic Operations.

If an SDL diagram was selected and an MSC or Overview diagram is added, an association link to the MSC or Overview diagram is automatically added to the SDL diagram.

The existing document is by default opened in an editor. This behavior can be changed by the preference Organizer*ShowAddExisting.

Remove

This menu choice removes a selected root document and its document substructure, if any, from the system structure. Modules, chapters and top-level documents in modules can also be removed.

This menu choice is only available if the system file can be changed.

Removing a root document may also involve the update of one control unit file if there is any containing the diagram substructure that has been removed. The menu choice is dimmed if no such document, module or chapter is selected, or if the document is modified.

Removing a chapter symbol does not remove the documents in that chapter; only the chapter symbol itself is removed.

The following dialog is opened:

Figure 21 : The Remove dialog

Connect

This menu choice connects a selected document to a file. It is possible to reconnect an already connected document. The menu choice is hazed if a directory, page, instance diagram, dashed diagram, chapter, or module symbol is selected. The menu choice is also hazed if the loaded system file (*.sdt) or any associated configuration group file (*.scu) file is read-only.

The following dialog appears:

Figure 22 : The Connect dialog

Figure 23 : The Connect error message

If the file contains a document of the correct type but with an incorrect name, the symbol in the Organizer is renamed.
If the file contains a document which has an incorrect type or name, the user is warned in a dialog:

Figure 24 : The Connect warning dialog

If the document already is connected and only the directory part of the existing file connection is changed, the following dialog is opened:

Figure 25 : The Connect change directory dialog

Error Notification

If an error occurs, the user is informed in a message box and control is returned to the Connect dialog.

Reconnect Connected SDL Diagram

When performing a reconnect to an already connected SDL diagram, the current SDL child diagram references are matched against those found in the connected file. If mismatches are found, icons are marked as such but the structure is kept intact, if possible.

Connect Open Documents

When connecting an unconnected document that is opened and unsaved in an editor, the file name binding is not conveyed to the editor, i.e., the editor binding is lost.

Disconnect

This menu choice disconnects the connected file from the selected diagram. The menu choice is hazed if the selected symbol has no file connection. The menu choice is also hazed if the loaded system file (*.sdt) or any associated configuration group file (*.scu) file is read-only.

The following dialog is opened:

Figure 26 : The Disconnect Diagram dialog

If the document is currently loaded in an editor and is modified, the document reference in the Organizer gets the same status as if a new document is edited, i.e. new and unconnected. The editor binding is then lost.

Configuration > Group File

This command operates on the currently selected diagram, and is used to create or remove a Configuration Management Group for the diagram structure. The menu choice is hazed if the loaded system file (*.sdt) or any associated configuration group file (*.scu) file is read-only. When invoked, a dialog appears:

Figure 27 : The Group File dialog

Figure 28 : A group file in the Organizer view

The name of the group file is presented directly below the document name, in italics. The asterisk `*' indicates that the control unit file is dirty and needs saving. After saving, the asterisk will be removed.
The name of the control unit file is presented directly below the document's file name.

Configuration > Update

A faster version of Configuration > Full Update. The *.scu files are only read if they have changed since the last save.

Configuration > Full Update

Updates configuration groups recursively below the selection in the Organizer. Use this menu choice to update the Organizer contents if you have a system with configuration groups loaded in the Organizer and the configuration groups have changed outside the control of the Organizer, for instance by a software configuration management system operation.

Color > Set Default Colors

Invoking this menu choice will make sure that all SDL diagram symbols are colored according to preference values (such as Editor*StateSymbolColor) instead of individual colors set with SDLE > Edit > Symbol Border Color and SDLE > Edit > Symbol Fill Color. Note that this menu choice only operates on the diagrams selected in the Organizer.

Color > Set Black and White

Same as Organizer > Edit > Color > Set Default Colors, but instead of preference values, black and white is used for all symbols.

Associate

This menu choice associates or disassociates a selected document with another document. An association symbol indicates that two document symbols are connected. (A related symbol is the dependency symbol, see "Dependencies" on page 139.)

The menu choice is hazed if the loaded system file (*.sdt) or any associated configuration group file (*.scu) file is read-only.

If an association icon is selected, this menu choice operates on the associated document, not the icon itself. Any document may be associated with any other document, and a document may have more than one associated document.

The following dialog is opened:

Figure 29 : The Associate dialog

Paste As

This menu choice is used to paste copied objects as new diagrams in the Organizer. This menu choice is only available if the system file can be changed. A root diagram is created and opened in an editor. The following transformations are possible via Paste As in the Organizer:

For more information about the Paste As dialog, see "The Paste As Command" on page 450 in chapter 9, Implinks and Endpoints.

Go To Source

This menu choice is used to open an editor with a document according to an SDT reference. The SDT reference is specified in a dialog, see Figure 30. If the SDT reference includes information about an object in the document, that object will be selected. SDT references can be obtained by using the menu choice Show GR Reference in an editor.

For information about SDT references, see chapter 18, SDT References.

The following dialog is opened:

Figure 30 : The Go To Source dialog

An error message appears if the format of the SDT reference is incorrect or if the requested SDT reference cannot be found.

Update Headings

This menu choice checks the headings of SDL, HMSC, OM, and SC diagrams for correctness with respect to what is defined in the Organizer structure.

It operates on the selected diagram and its substructure. If no diagram is selected, all SDL, HMSC, Object Model, and State Chart diagrams in the Organizer are checked. For SDL diagrams, the kernel headings are checked.

Before the headings are checked, a check is made to see if any file is connected to more than one diagram. Such files are reported in the Organizer log, and a warning box is issued to the user. These files may be modified for each appearance and will cause all but the last update to be incorrect.

The heading check is made silently until the first incorrect heading is found. The diagram checked is then shown in the dialog below. If an incorrect qualifier is found, the user is prompted in the dialog whether to update the header or not. The user also has the possibility to silently update all incorrect headings. That is, they are loaded in an editor and are then corrected without confirmation by the user.

After the operation, all updated headings are in an unsaved mode in the editor.

This operation should be done regularly in order to avoid peculiar and hard-to-find analysis error caused by incorrect diagram headings.

In SDL diagrams, qualifiers can be placed in other symbols than the heading in the system, such as qualifying data types in a text symbol. Such qualifiers are not found by the Update Headings menu choice.

The following dialog is opened:

Figure 31 : The Update Headings dialog

Update Visibility

Update SDL symbol visibility according to include expressions and external synonym values.

The SDL symbol visibility can also be set manually, see "Symbol Visibility > Hide" on page 2017 in chapter 43, Using the SDL Editor and "Symbol Visibility > Show" on page 2017 in chapter 43, Using the SDL Editor.

For more information about include expressions, see "Include Expression" on page 2017 in chapter 43, Using the SDL Editor.

External synonyms are saved in a plain text file with the extension *.syn in the Organizer. To specify that the boolean external synonym variable DEBUG should have the value of true, and the boolean external synonym variable VERSIONTWO should have the value of false, the *.syn file should have the following contents:

DEBUG 1
VERSIONTWO 0

By using these variable names as include expressions on selected symbols, and by having a reference to the *.syn file in the Organizer, it is possible to hide or show groups of symbols by setting up the correct values in the external synonym file and applying this command. Note that the symbol visibility can not be updated in read-only diagrams.

Properties

Edit bookmark properties for a selected bookmark symbol. Location should be set to a valid SDT reference or URL. Name is any name that makes it easy to remember the place the bookmark represents. You can get valid SDT references from SDL Suite editors, by selecting a symbol and using <editor>>Tools>Show GR Reference. The easiest way to create a new bookmark with a valid SDT reference is to use <editor>>Tools>Create Bookmark.

This menu choice is only available if the system file can be changed.

View Menu

The View menu includes the following menu choices (menu choices within parenthesis are not available in short menu mode):

Expand

This menu choice expands the symbol structure tree one level down for the selected document. If any symbols one level down are hidden, they are still hidden after this operation. (Use the menu choice Show Sub Symbols to show hidden symbols.)

The menu choice is dimmed if:

Expand Substructure

This menu choice expands the symbol structure tree the whole way down for the selected document. This also expands sub symbols that are hidden, but those sub symbols are still hidden after this operation. (Use the menu choice Show Sub Symbols to show hidden symbols.)

The menu choice is dimmed if:

If no document is selected, all icons will be expanded.

Collapse

This menu choice collapses the selected document, i.e. the sub symbols are not shown after this operation. A collapsed document has a small triangle drawn below the icon to indicate that it is collapsed.

The menu choice is dimmed if:

If no document is selected, all icons will be collapsed. A collapsed document does not affect a corresponding document file opened in an editor, i.e. it does not have to be closed or saved.

Show Sub Symbols

This menu choice is used to specify which sub symbols of the selected document that should be shown or hidden. The sub symbols can be documents, instance diagrams, pages, or associations. If a More symbol is selected, the operation applies to the parent document, which becomes selected instead.

Only the sub symbols one level down from the selected document is affected, not the complete symbol substructure. The menu choice is dimmed if there is no selection or the selected symbol has no sub symbols.

Note:

This menu choice does not expand or collapse the document.

The following dialog is opened:

Figure 32 : The Show Sub Symbols dialog

Hide

This menu choice hides the selected non-root document and its substructure. The document and its substructure is replaced by a More symbol, which is always placed last of the symbols on that level. If such a symbol already existed in the parent document, the document is hidden under the same More symbol. The symbol's count of hidden documents is updated.

The menu choice is dimmed if there is no selection, or the selected document is a root document.

By double-clicking on the More symbol, the Show Sub Symbols dialog is opened.

View Options

This menu choice sets options for controlling the appearance of the Organizer window, as well as options for which icon attributes to show.

The options are set in a modeless dialog, i.e. the Organizer can continue working without waiting for the dialog to be closed. The options are saved in the system file.

The following dialog is opened:

Figure 33 : The View Options dialog

The figure above shows the default settings. The settings made in the dialog are preserved as default values the next time the dialog is invoked.

Tree mode

The Tree mode section contains options for the two different tree presentation modes available in the chapters (see "Presentation Modes" on page 46).

Menu bar

The Menu bar section contains options for which menu choices that are available (see "Long and Short Menus" on page 58).

Show

The Show section contains options for which window parts, documents and file attributes to show. The options are available as items in a multiple selection list, which can be selected or deselected. Options already turned on are pre-selected when the dialog is opened.

Figure 34 : Separators between SDL diagrams

Chapter Options

This menu choice is used to set chapter properties.

The following dialog appears:

Figure 35 : The Chapter Options dialog

The first chapter number is defined in the text field. This number defines the chapter number to use for the first chapter symbol of type Chapter 1, Chapter 1.1, Chapter 1.1.1 or Chapter 1.1.1.1 in the Organizer View area. For example, if the first chapter number is specified as "3.2", then an initial chapter symbol of type Chapter 1 will get chapter number 3. If the initial chapter symbol instead is of type Chapter 1.1.1.1, it will get a chapter number of 3.2.1.1.

The maximum TOC chapter level decides which chapter symbols that will be visible in the table of contents when a print is done from the Organizer. A maximum TOC chapter level of zero will only show chapter symbols of type Chapter, while a chapter level of 4 will show all chapter symbol types in the table of contents.

Set Scale

Sets the scale (20%-800%) used in the Organizer window. The setting is saved in the system file.

Show High-Level View

Sets the current view of all diagrams in the SDL Editor to the high-level view, showing only symbols which are marked as "important".

Show Detailed View

Sets the current view of all diagrams in the SDL Editor to the detailed view, showing all symbols.

Generate Menu

The Generate menu contains the following menu choices (menu choices within parenthesis are not available in short menu mode):

Analyze

This menu choice analyzes the selected SDL or TTCN system. If there is no SDL or TTCN system selected, the Organizer operates on the first SDL system found in the Organizer. The menu choice is dimmed if:

The Analyze SDL variant of this menu choice is described below, followed by the Analyze TTCN variant.

Analyze SDL

This menu choice starts the Analyzer for one or several related SDL diagrams. If modified information exists in the current system structure, the user should first save it. See "The Save Before Dialog" on page 65 for more information.

Any SDL diagram can be selected for analysis, but in practice at least the parent block diagram will be the source of the analysis. If no SDL diagram is selected, the first SDL diagram found in the Organizer view will be used. The diagram will be analyzed in its context and together with its substructure.

Options for the Analyzer are specified in the modal dialog below. The settings are saved in the system file and persist until the next time the dialog is invoked for the same system.

Figure 36 : The Analyze dialog

The Analyze SDL Settings

Note: Normal versus full analyze (make)

In the Analyze and the Make dialog, the user can choose between the normal Analyze/Make and the Full Analyze/Make buttons. The last used button (normal or full) will be the default when any of these two dialogs is used the next time. The last used button will also determine if normal or full analyze/make will be used when invoking operations via the quick buttons Analyze, Make, Simulate and Explore. It is possible to toggle between normal or full analyze/make by pressing <Ctrl+T>.

The options above are forwarded to the Analyzer when the analysis process starts.

The Analyze SDL Buttons

Analyze TTCN

This menu choice is used to analyze a TTCN system and/or to generate a Flat View for a TTCN system.

Options for the Analyze process are specified in the modal dialog below. A selectable Generate Flat View phase is executed in the analyze process. The settings are saved in the system file and persist until the next time this dialog is invoked for the same TTCN system.

Figure 37 : The Analyze TTCN dialog

The Analyze TTCN Settings
The Analyze TTCN Buttons

For more information about this dialog, see "The TTCN Analyzer" on page 1194 in chapter 26, Analyzing TTCN Documents (on UNIX).

See also chapter 31, Analyzing TTCN Documents (in Windows).

Make

This menu choice makes the selected SDL or TTCN system, or the selected SDL block or process diagram (see "Partitioning" on page 2643 in chapter 56, The Cadvanced/Cbasic SDL to C Compiler). If a Build Script containing commands to the SDL to C Compiler is selected, that file will be used as input to the SDL to C Compiler, without opening the Make dialog (see "Build Scripts" on page 2644 in chapter 56, The Cadvanced/Cbasic SDL to C Compiler.

If no document or file of the above mentioned type is selected, the Organizer operates on the first SDL system found in the Organizer. The menu choice is dimmed if:

If modified information exists in the current system structure, the user should first save it; see "The Save Before Dialog" on page 65.

The SDL Make variant of this menu choice is described below, followed by the TTCN Make variant.

SDL Make

Options for the Make process are specified in the modal dialog below. An analysis phase is executed as part of the Make process. The existing Analyzer options as set in the Analyze dialog are used.

Figure 38 : The Make dialog

Code Generation Options
Makefile Options

Example 2 : Contents of a UNIX Make Template File

USERTARGET = sctenv$(sctOEXTENSION)
USERLIBRARIES = -lm -lsocket

# Dependencies and actions
sctenv$(sctOEXTENSION): sctenv.c
        $(sctCC) $(sctCPPFLAGS) $(sctCCFLAGS) \
        $(TARGETDIRECTORY) sctenv.c \
        $(sctIFDEF) -o sctenv$(sctOEXTENSION)

Compile & Link Options
Miscellaneous Options
Dialog Buttons

Note:

For information about how Make/Full Make relates to Analyze/Full Analyze and quick buttons, see "Normal versus full analyze (make)" on page 114.

TTCN Make

This menu choice is used to make (generate code, compile and link) a TTCN system.

For more information about this operation, see chapter 27, The TTCN to C Compiler (on UNIX) or chapter 32, The TTCN to C Compiler (in Windows).

Stop Analyze/Make (UNIX only)

This menu choice stops an ongoing analyze/make operation. The Analyzer tool is also stopped. (The Analyzer tool normally remains resident in memory for the rest of the SDL Suite session once the first analyze/make is performed, and this menu choice is then renamed to Stop Analyzer. Using this menu choice is one way to free memory if needed.) Several commands, such as Analyze, Make, Convert to PR/MP and Convert to GR, are not available when the Analyzer is processing data. Stopping the Analyzer enables these commands again.

A message with the essence "Analyzer could not be stopped" may be issued as a response to this command; in this case, repeat the menu choice until the message "Analyze/make stopped" is issued in the message area.

Targeting Expert

This menu choice starts the Targeting Expert tool. See chapter 59, The Targeting Expert for more information.

SDL Overview

This menu choice generates an SDL overview diagram for the selected SDL diagram as the top diagram. The menu choice is dimmed if:

If modified information exists in the current system structure, the user should first save it; see "The Save Before Dialog" on page 65.

Any SDL diagram can be selected for generation. If no SDL diagram is selected, the first SDL diagram found in the Organizer view will be used.

Figure 39 : The Generate SDL Overview dialog

State Overview

This menu choice is used to generate a state overview information file from an SDL system or a group of state charts. The state overview can be viewed either as state matrices in the Text Editor or as state charts in the State Chart Editor.

Before selecting this menu choice, make sure that the information source (an SDL system or one or more state charts) is selected directly or indirectly. For instance, you can select a group of state charts by selecting the chapter symbol that contains the state charts.

When you select this menu choice, a dialog is displayed where you can:

CPP2SDL Options

This menu choice is available if a C or C++ Import Specification is selected. For more information, see "The CPP2SDL Tool" on page 765 in chapter 14, The CPP2SDL Tool.

Figure 40

Convert to PR/MP

This menu choice converts the selected diagram/document to textual form. SDL/GR is converted to SDL/PR and TTCN-GR is converted to TTCN-MP. If no diagram/document is selected, the Organizer operates on the first SDL system found in the Organizer. The menu choice is dimmed if a job using the Analyzer is already running.

The Convert to PR (SDL) variant of the menu choice is described below, followed by the Convert to MP (TTCN) variant.

Convert to PR (SDL)

The SDL variant of the Convert to PR/MP menu choice generates a formatted (pretty printed) SDL/PR file. Input is either an SDL/PR file or an SDL/GR diagram structure.

If modified information exists in the current system structure, the user should first save it; see "The Save Before Dialog" on page 65.

Figure 41 : The Convert to PR dialog

Convert to MP (TTCN)

This TTCN variant of the Convert to PR/MP menu choice converts a TTCN-GR document to a TTCN-MP text file.

For more information about Convert to MP, see "Exporting a TTCN Document to TTCN-MP" on page 1156 in chapter 24, The TTCN Browser (on UNIX) or "Converting to TTCN-MP" on page 1297 in chapter 30, Editing TTCN Documents (in Windows)

Convert to GR

This menu choice converts a textual file to one or more graphical diagrams. A TTCN-MP file is converted to TTCN-GR diagrams, and an SDL/PR file is converted to SDL/GR diagrams. The menu choice is dimmed if a job using the Analyzer is already running.

The Convert to GR (SDL) variant is described below, followed by the Convert to GR (TTCN) variant.

Convert to GR (SDL)

The Convert to GR dialog is in SDL mode when the radio button Convert SDL/PR to SDL/GR is on (see Figure 42).

Figure 42 : The Convert to GR dialog in SDL mode

The Convert to GR command can be used to import SDL systems created using Object Geode. However, Object Geode allowed some extended SDL syntax that is not accepted by the SDL Suite Analyzer.

Note:

In Object Geode, strings can be surrounded by double quotes. This is not accepted by the SDL Suite, only single quotes are allowed. E.g. the statement

Writeln("Take your card")

must be changed to

Writeln('Take your card')

In Object Geode it is allowed to have an Operator call with an empty string. E.g. the statement

j := tstOperator() 

must be changed to

j := tstOperator

to be accepted by the SDL Suite.

In Object Geode you can split the system into many CIF files, where a special #REF directive is used in a comment for the reference symbol. This construct can cause a loop forever during import. A possible workaround is to change the following constructs:

PROCESS P1 REFERENCED
COMMENT '#REF <some_path>\<some_file>.cif.pr';

into:

PROCESS P1 REFERENCED;

Convert to GR (TTCN)

The Convert to GR dialog is in TTCN mode when the radio button Convert TTCN-MP to TTCN-GR is on (see Figure 42).

For more information about the Convert to GR dialog in TTCN mode, see "Importing a TTCN-MP Document" on page 1161 in chapter 24, The TTCN Browser (on UNIX) or "Converting to TTCN-MP" on page 1297 in chapter 30, Editing TTCN Documents (in Windows).

Convert GR to CIF

This menu choice converts SDL/GR diagrams to the Common Interchange Format (CIF).

On UNIX, the Convert GR to CIF dialog is opened. For more information, see "Convert GR to CIF Dialog (UNIX only)" on page 908 in chapter 16, CIF Converter Tools.

In Windows, the SDT2CIF converter tool is started. For more information, see "Graphical User Interface (Windows only)" on page 910 in chapter 16, CIF Converter Tools.

Convert GR to Tau/Developer CIF

This menu choice generates a CIF file for an SDL system that should be imported into IBM Rational Tau. The command is a shortcut for the Convert GR to CIF command where it is only needed to specify the system file and the resulting CIF file. The functionality is the same as running Convert GR to CIF with the following options:

Convert CIF to GR

This menu choice converts diagrams in Common Interchange Format (CIF) to SDL/GR diagrams.

On UNIX, the Convert CIF to GR dialog is opened. For more information, see "Convert CIF to GR Dialog (UNIX only)" on page 893 in chapter 16, CIF Converter Tools.

In Windows, the CIF2SDT converter tool is started. For more information, see "Graphical User Interface (Windows only)" on page 894 in chapter 16, CIF Converter Tools.

Convert State Chart to SDL

This menu choice transforms the selected State Chart to an SDL process diagram. For more information, see "Converting State Charts to SDL" on page 1706 in chapter 39, Using Diagram Editors.

Edit Separation

This menu choice inserts or edits a separation on the selected SDL diagram. It is dimmed if the selected diagram type is not one of system, system type, block, block type, process, process type, procedure, and package. This menu choice is only available if the system file can be changed.

Diagram separation symbols are used during code generation and controls both the splitting of the target into separate modules and the naming of these modules. For more information, see "Selecting File Structure for Generated Code - Directive #SEPARATE" on page 2723 in chapter 56, The Cadvanced/Cbasic SDL to C Compiler. Separations can be shown in the diagram structure of the Organizer; see "Separator symbols" on page 109. Information about separations are stored in the system file.

Figure 43 : The Edit Separation dialog

Dependencies

This menu choice introduces or removes dependencies between a selected document and other documents. A dependency symbol below a document indicates that the document is depending on another document. For instance, if an SDL system is depending on an ASN.1 document, then the SDL system must be re-analyzed each time the ASN.1 document is updated. A related symbol is the association symbol, see "Associate" on page 98.

This menu choice is only available if the system file can be changed.

Note:

Dependency links between SDL systems and C header files or ASN.1 documents are not required, but serve mainly as comments. The SDL Analyzer will re-analyze the SDL system automatically for such dependencies.

If a dependency icon is selected, this menu choice operates on the document the dependency icon is referring to, not the icon itself. Any document may depend on any other document, and a document may have be depending on more than one document.

The following dialog is opened:

Figure 44 : The Dependencies dialog

Merge ASN.1

This menu choice controls whether the ASN.1 files in an Organizer module should be merged (joined) into a single SDL package or not. For more information, see "Using the ASN.1 Utilities" on page 703 in chapter 13, The ASN.1 Utilities.

Figure 45 : The Merge ASN.1 dialog

Tools Menu

The Tools menu contains the following menu choices:

Organizer Log

This menu choice raises the Organizer Log window. The Organizer Log window can be raised automatically when the user performs an analysis or other forms of generation. There is only one Organizer Log window.

The Organizer Log window is described in "Organizer Log Window" on page 184.

Link > Create Endpoint

This menu choice creates an endpoint for the selected document. A document with an endpoint is recognized by a small triangle in the upper left corner of the document symbol. See "Link > Create Endpoint" on page 446 in chapter 9, Implinks and Endpoints.

This menu choice is only available if the system file can be changed.

Link > Traverse

This menu choice traverses a link for the selected document. A document with at least one link is recognized by a small black triangle in the upper left corner of the document symbol. See "Link > Traverse" on page 446 in chapter 9, Implinks and Endpoints.

Link > Link Manager

This menu choice opens the Link Manager's main window. For more information about the Link Manager, see "The Link Manager" on page 464 in chapter 9, Implinks and Endpoints.

Link > Clear Endpoint

This menu choice removes an existing endpoint for the selected document. See "Link > Clear Endpoint" on page 449 in chapter 9, Implinks and Endpoints.

This menu choice is only available if the system file can be changed.

Search

This menu choice searches for text in SDL, MSC, HMSC, Object Model, and State Chart diagrams. Textual documents (C Header, Text ASN.1, and Text Plain) are also searched if the Text Editor is used. (The Text Editor is used if the preference variable SDT*TextEditor is set to "SDT.") It is not possible to search in TTCN, Word, Tau/Rhapsody or Generic documents with this menu choice. To search in TTCN documents, use TTCN > Find Table.

The document scope of the search depends on the selection:

The menu choice is dimmed if the selected document is not a root document, not connected, or marked invalid.

The search will only take place in diagrams that are connected and do not have an invalid status. The search will start in the selected diagram and continue in top-down order for the rest of the diagrams (the order is left-right in a tree view).

The search function will go through the list of diagrams and stop each time the search criteria, as set in the dialog below, matches. If a search/replace string or any option is changed when the search is stopped (a match is found or the user pressed Abort), these values become the basis when the search is continued.

The search process will open an editor window, if necessary, and select the matched search text.

The searching is based on ASCII character matching. All text fragments in symbols are searched, with a few restrictions (see below).

When all diagrams have been searched, a beep is issued and the message Search completed appears.

Dialog Fields and Options

The Search dialog contains the following fields and options.

Note:

Only the textual elements that are visible in an MSC will be searched. See "Diagram Options" on page 1680.

Dialog Buttons

When the dialog is first opened, all buttons except Replace&Search and Replace All are enabled. When Search, Replace&Search or Replace All is pressed all fields and buttons are disabled except the Close button. (The Close button changes name during the search to Abort.) If a search string is found in an editor, it is selected and all buttons and fields are enabled.

When the first search or replace operation has been applied and control returns to the Search dialog, it is possible to perform a new search on the same diagram(s).

Search Restrictions

All data in the editors that affects the diagram structure maintained by the Organizer (primarily reference symbols and kernel headings in the SDL Editor) is regarded as read only during the search operation. That is, they are not affected by the search.

Externally editing (i.e. through means other than using replace) of a diagram during a search operation completely resets the search, i.e. the next search starts from the first diagram.

The search may fail if dialogs are opened in the editor during the search. In this case the editor blocks the continuation of the search process. To continue the search process, the editor dialog must be closed.

The Organizer's data is locked during the search process. This is normally not noticed since the Search dialog is modal, but the SDL Editor needs to access that data to perform operations affecting the diagram structure. The Organizer will deny the editor's requests to modify the data structure. The duration of the search process is the period of time during which the Search dialog is visible in the Organizer.

Fast Search

Fast search is invoked by pressing Ctrl+F on the keyboard.

Fast search behaves like normal search, except that:

When Fast search is invoked, the message area displays the text that will be searched for. Initially, the text is Search for:. When you type on the keyboard with the mouse pointer over the drawing area, the characters will turn up in the message area. When you have typed the text pattern to search for, press enter or return to start the search operation.

The same search operation as for normal Search is used. If the search operation finds a match, you can search for another match by pressing enter or return once more in the Organizer window.

To finish the Fast search operation, click in the drawing area or select another operation.

The next time Fast search is invoked with Ctrl+F, the search text that was used the last time is proposed as a search text once more. To use it, press enter or return. To use another search text, press Ctrl+F once more or the delete key several times, to erase the search text.

Spelling > Comments

Check the spelling of comments in selected diagrams. Comments can be either comment symbols or /* C-style comments */

.

Note:

This command only works if the spelling checker aspell or ispell has been installed on your computer, and the preference SDT*ISpellCommand correctly identifies the ispell/aspell executable. ispell/aspell can be found on the internet and uses the same kind of license as the emacs text editor.

For spelling errors, the Spelling dialog appears, with the following possibilities:

Spelling > All Text

Works in the same way as Spelling > Comments, but all text is checked instead of just comment texts.

Change Bars

This menu choice is used to control the usage of change bars in SDL diagrams. A dialog with two options is opened:

Compare > SDL Diagrams

This menu choice compares the contents of SDL diagram file pairs. A diagram file pair is constructed by matching an SDL diagram file loaded into the Organizer with an SDL diagram file with the same name, but in a different directory.

Note:

There is a similar operation in the SDL Editor for comparing one SDL diagram pair at a time. See "Compare Diagrams" on page 2030 in chapter 43, Using the SDL Editor.

The menu choice is dimmed if there are no SDL diagrams in the Organizer.

In the same way as for the Search menu choice, the compare operation is limited by the selection in the Organizer. Only SDL diagrams within the scope of the selection will be considered for the compare operation.

When the Compare SDL Diagrams menu choice is invoked, the compare SDL diagrams setup dialog appears.

Figure 46 : The Compare SDL Diagrams Setup dialog

In the compare SDL diagrams setup dialog, the following input parameters to the compare operation can be specified:

When the OK button in the dialog is pressed, the Organizer checks if a matching diagram can be found for all SDL diagrams in the operation. If that is not the case, a dialog appears to inform about this fact.

Figure 47 : The Compare SDL Diagram missing files dialog

Finally, the real compare operation starts in the SDL Editor. Read more about this in "Compare Diagrams" on page 2030 in chapter 43, Using the SDL Editor.

Compare > MSC Diagrams

This menu choice compares the contents of MSC diagram file pairs in the same way as "Compare > SDL Diagrams" on page 149 does. Read more about this in "Compare Diagrams" on page 1694 in chapter 39, Using Diagram Editors.

Compare > HMSC Diagrams

This menu choice compares the contents of HMSC diagram file pairs in the same way as "Compare > SDL Diagrams" on page 149 does. Read more about this in "Compare Diagrams" on page 1694 in chapter 39, Using Diagram Editors.

Merge > SDL Diagrams

This menu choice compares the contents of SDL diagram file pairs in the same way as "Compare > SDL Diagrams" on page 149 does. The main difference is that this menu choice gives the possibility to merge differences: For each diagram pair, a new merge result diagram is created. Read more about how the actual merge is performed in "Merge Diagrams" on page 2031 in chapter 43, Using the SDL Editor.

Merge > MSC Diagrams

This menu choice compares the contents of MSC diagram file pairs in the same way as "Compare > MSC Diagrams" on page 152 does. The main difference is that this menu choice gives the possibility to merge differences: For each diagram pair, a new merge result diagram is created. Read more about how the actual merge is performed in "Merge Diagrams" on page 1694 in chapter 39, Using Diagram Editors.

Merge > HMSC Diagrams

This menu choice compares the contents of SDL diagram file pairs in the same way as "Compare > HMSC Diagrams" on page 152 does. The main difference is that this menu choice gives the possibility to merge differences: For each diagram pair, a new merge result diagram is created. Read more about how the actual merge is performed in "Merge Diagrams" on page 1694 in chapter 39, Using Diagram Editors.

Split

This menu choice is used to split one SDL diagram into two SDL diagrams. This menu choice can be applied several times to split one SDL diagram into several parts. This menu choice is, together with the menu choice Join, useful in situations where several people have to work simultaneously on one SDL diagram. The SDL diagram file is partitioned into several SDL diagram files and each person is given one part to work on.

To split an SDL diagram consisting of several pages, select the diagram symbol in the Organizer and select the Split menu choice. (It is also possible to select a page symbol associated with the diagram that should be split.)

A dialog appears with a list of all pages but the first one in the diagram, see Figure 48. Select a page to define how the SDL diagram should be split. All pages before the selected page will end up in the first SDL diagram part. The selected page and all pages after the selected page will end up in the second SDL diagram part.

Figure 48 : The first Split dialog

The Split button in the first Split dialog closes the dialog and brings up the second Split dialog, as shown in Figure 49. The second Split dialog is used to specify the files that the two resulting SDL diagram parts should be saved in.

Figure 49 : The second Split dialog

When the second Split dialog is closed with the Save button, the split operation is performed: The SDL Editor is loaded with the SDL diagram that should be split. Two new smaller SDL diagrams are created in the SDL Editor and saved under the file names specified in the second Split dialog.

The visible result of the Split operation is that the SDL Editor contains at least the diagram that was split and the resulting SDL diagram parts. Note that no additional symbols are created in the Organizer. The SDL diagram parts are accessed by opening the SDL diagram part files in the SDL Editor with the Open menu choice. It is of course possible to manually add symbols for the SDL diagram parts in the Organizer with for instance the Add Existing menu choice.

Join

This menu choice is used to join two SDL diagrams of the same type into one SDL diagram. This menu choice is, together with the Split menu choice, useful when several people have to work on the same SDL diagram at the same time.

Note that it is not necessary to do a Split before doing a Join. One way to work in parallel on the same diagram is to let one designer work on the existing SDL diagram, while another designer creates new pages destined for the same SDL diagram, in a new SDL diagram with the same type as the existing SDL diagram. A join operation when the parallel work is finished puts the new SDL pages in the correct SDL diagram.

The resulting SDL diagram is produced by copying the complete first diagram part and merging/joining pages from the second diagram part by copy and paste. This means that information that is common for all pages in an SDL diagram is taken from the first diagram part. This includes:

Another consequence of this way of working is that duplicate page names and reference symbol names emerging from the second diagram part are changed by the join operation to make them unique. Auto-numbered pages from the second diagram part will also have their names changed.

When the Join menu choice is invoked, the Join dialog appears, see Figure 50.

Figure 50 : The Join dialog

In the dialog, specify the names of the two SDL diagram files that should be merged. Pressing the Join button will close the dialog and start the Join operation.

The result of the Join operation is that three diagrams will be loaded in the SDL Editor; the two SDL diagram parts that act as input to the Join operation and a new and unsaved SDL diagram that contains all the pages from both the input diagrams. The first thing that you will normally do after a Join operation is to save the new SDL diagram in a file. After that, it might be appropriate to check the new SDL diagram in the context of the SDL system with the Analyzer.

Compare State Machines

This menu choice is used to compare state machines with other state machines. This menu choice makes it possible to keep state machines expressed as a group of state charts consistent with state machines expressed as processes in an SDL system.

Before selecting this menu choice, make sure that the information sources (SDL systems and/or state charts) are selected directly or indirectly. For instance, to compare the only SDL system in the Organizer with all state charts in the Organizer, make sure that there is no selection in the Organizer by clicking in the background. The Organizer will interpret this as "everything is selected".

When you select this menu choice, a dialog is displayed where you can:

When the dialog is closed, two state overview information files are generated. A state overview describes a state machine in a normalized form:

The compare operation compares the two generated state overview information files in the following way:

.

Note:

The compare operation does not compare all the details for a transition. For instance, the conditional expression in an SDL decision symbol is not compared with the guard condition in a state chart transition.

If the compare operation finds anything that does not match, this is reported in the Organizer Log. You use the Organizer Log quick button Show Error to navigate to the SDL diagram or state chart with an entity that did not match anything in the other group of state machines.

Simulator Test > New Simulator

This menu choice is used to execute test cases in the simulator for an SDL system. Test cases can be described either as MSCs or as simulator UI input scripts (*.cui). A description of how to express MSCs in this context can be found in Using MSCs as test cases.

When this menu choice is invoked, a dialog appears with a list of all MSCs and input scripts. In the dialog, it is possible to select test cases that should be executed. The selection in the Organizer decides:

When the dialog is closed, an SDL simulator is generated and each selected test case is run. When all test cases have been executed, the Organizer Log will contain a one-line summary for each test case, with information about if the test case passed or failed. For test case failures, the MSC editor will pop up, showing the symbol in the MSC that failed (this happens only if the test case was expressed as an MSC). To be able to examine test case failures in detail, run each test case that fails separately, because then the MSC editor will show the place of the MSC test case failure and the textual output from the simulator will contain information about the test case failure.

Using MSCs as test cases

MSC test cases are MSCs written in a special way. MSC test cases are high-level test cases that are auto-converted to low-level simulator UI input script test cases before they are executed.

When MSCs are used as test cases, you can:

Figure 51 illustrates MSC test case building blocks that are described in the text below.

Figure 51 MSC test case building blocks

MSC instance symbols are used in the following way in MSC test cases:

To send a signal into the system, draw an MSC signal from the environment instance to one of the instances representing the SDL system. Specify the signal name and any parameters that you know about.

To check that a signal is sent out from the system, draw an MSC signal from an instance representing the SDL system to the environment instance. Also here, you should specify the signal name and any parameters. The check is done by matching a text string created from the MSC with the actual textual output from the simulator. You can use the * character (matching any characters) if you for instance do not want to specify all parameters in the MSC.

MSC test scripts can check for unexpected signals sent to the environment. If unexpected (unchecked) signals are detected before the currently checked signal the test case will fail and a message will be displayed:

Unexpected signal(s) to environment arrived before 
currently checked signal:
* OUTPUT of DSignal to env:1
* OUTPUT of ASignal to env:1

If unexpected (unchecked) signals are detected after the last checked signal in the script the test case will fail and a message will be displayed:

Unexpected signal(s) to environment arrived after 
last checked signal:
* OUTPUT of CSignal to env:1 

Make sure that the script will run sufficiently long after the last checked signal, for the unexpected signals to arrive at the environment and be detected. This can for example be achieved with a finite number of "next-state" commands at the end of the test script. The statistics displayed after the test script has executed have been updated to show unexpected signals as follows:

Command statistics:
	 checked: 2
	 failed: 0
	 updated: 0
	 unexpected: 2

There are several overlapping ways of specifying the process instance a signal should be sent to or from. Two of them involves a mapping table in an MSC text symbol. The text should look something like this (one line with a `=' for each mapping rule):

process id mappings:
instance accesscontrol = panel
signal display = panel

It is possible to include any simulator command in an MSC test script by attaching an MSC action symbol to the environment instance, and typing the simulator commands in it. One line for each command.

This can for instance be used to declare macros representing parameter values. If you have done add-macro myMacroName 5 in an action symbol, you can type $myMacroName instead of 5 as the value of a parameter. Macros can be defined in a separate MSC and used in normal MSC test cases. Just make sure that the macro MSC is executed before the normal MSC test cases when you do a simulator test.

There are three textual shortcuts that can be used in an action symbol:

The MSC reference symbol can be attached to the environment instance. Type in a name of a sub MSC test script that should be executed. This is a way to avoid repeating the same information in many places. It can for instance be used in the beginning of a test script to perform common initialization of the system.

Simulator Test > Existing Simulator

Same as "Simulator Test > New Simulator" on page 157, except that an already created simulator is used. Before the normal simulator test dialog (used to specify test cases to execute), a file selection dialog appears, where a simulator executable can be specified.

Editors > Deployment Editor

Adds a Deployment diagram symbol to the Organizer view, and starts the Deployment Editor. The symbol is added at the same place as when using the Add New command.

Editors > HMSC Editor

Adds a HMSC diagram symbol to the Organizer view, and starts the HMSC Editor. The symbol is added at the same place as when using the Add New command.

Editors > MSC Editor

Adds an MSC diagram symbol to the Organizer view, and starts the MSC Editor. The symbol is added at the same place as when using the Add New command.

Editors > OM Editor

Adds an Object Model diagram symbol to the Organizer view, and starts the OM Editor. The symbol is added at the same place as when using the Add New command.

Editors > SDL Editor

Adds an SDL System diagram symbol to the Organizer view, and starts the SDL Editor. The symbol is added at the same place as when using the Add New command.

Editors > State Chart Editor

Adds a State Chart diagram symbol to the Organizer view, and starts the State Chart Editor. The symbol is added at the same place as when using the Add New command.

Editors > Text Editor

Adds a Plain Text document symbol to the Organizer view, and starts the Text Editor. The symbol is added at the same place as when using the Add New command.

Editors > TTCN Browser

Adds a TTCN module symbol to the Organizer view, and starts the TTCN Browser. The symbol is added at the same place as when using the Add New command.

SDL > Type Viewer

This menu choice starts the Type Viewer. It is dimmed if there is no SDL diagram in the Organizer, or if the preference SDT*StartInformationServer is set to false. Only one instance of the Type Viewer exists. If the Type Viewer has already been started, its window is raised.

If a Referenced Diagram Type icon, an Instance Diagram icon or a Dashed diagram icon is selected in the Organizer, the Type Viewer selects the corresponding symbol when this menu choice is used.

The Type Viewer is described in chapter 45, The SDL Type Viewer.

SDL > Coverage Viewer

This menu choice starts a Coverage Viewer. A new instance of the Coverage Viewer is started each time this command is selected.

The Coverage Viewer is described in chapter 47, The SDL Coverage Viewer.

SDL > Index Viewer

This menu choice starts an Index Viewer. A new instance of the Index Viewer is started each time this command is selected.

The Index Viewer is described in chapter 46, The SDL Index Viewer.

SDL > Simulator UI

This menu choice starts a new, empty Simulator UI. Several Simulator UI's may exist at the same time.

The Simulator UI is described in "Graphical User Interface" on page 2201 in chapter 49, The SDL Simulator.

SDL > Explorer UI

This menu choice starts a new, empty Explorer UI. Several Explorer UI's may exist at the same time.

The Explorer UI is described in "Graphical User Interface" on page 2351 in chapter 52, The SDL Explorer.

SDL > Target Tester UI

This menu choice starts a new, empty SDL Target Tester UI. The SDL Target Tester UI is described in "Graphical User Interface" on page 3658 in chapter 67, The SDL Target Tester.

TTCN > Find Table

This menu choice invokes the find table operation on a selected TTCN system. In Windows, this functionality is not available and the menu choice is dimmed.

For more information about the find table operation on UNIX, see "TTCN Suite Preprocessor" on page 1209 in chapter 26, Analyzing TTCN Documents (on UNIX). For more information about finding tables in Windows, see "Finding and Sorting Tables" on page 1286 in chapter 30, Editing TTCN Documents (in Windows).

TTCN > Access

This menu choice starts a TTCN Access application for a selected TTCN document/system.

For more information, see chapter 21, TTCN Access.

TTCN > Simulator UI

This menu choice starts a TTCN simulator UI.

For more information about this, see chapter 28, The SDL and TTCN Integrated Simulator (U) or chapter 33, The SDL and TTCN Integrated Simulator (W).

Preference Manager

This menu choice starts the Preference Manager. Only one instance of the Preference Manager exists. If the Preference Manager has already been started, its window is raised.

The Preference Manager is described in chapter 3, The Preference Manager.

Bookmarks Menu

The Bookmarks menu contains the following menu choices:

Add Bookmark

This menu choice opens a dialog where a new bookmark can be created. The information needed is the location (a URL or a SDTREF), and a name for the bookmark. If desired, a systemfile can be specified that will be loaded together with the SDTREF.

Edit Bookmarks

Edit Bookmarks will open a dialog with a list with all bookmarks. After selecting a bookmark the buttons will have the following effect:

More Bookmarks

This choice will appear if more than 25 bookmarks are present. The dialog appearing is the same as in the Edit Bookmark menu choice. Selecting the desired bookmark and clicking on the Open button will open the bookmark.

Help Menu

For more information about Help menus, see "Help Menu" on page 15 in chapter 1, User Interface and Basic Operations. Two of the Organizer Help menu choices are described in more detail below.

About All

This menu choice starts an operation that presents version information about the individual tools in your SDL Suite configuration. The information is presented in the Organizer Log window. The produced information might look like this:

About All. Version information:
Help Tool             Version 6.3.0
Link Manager          Version 6.3.0
MSC Editor            Version 6.3.0
OM InfoServer         Version 6.3.0
OM/SC/HMSC/DP Editor  Version 6.3.0
Organizer             Version 6.3.0
Preference Manager    Version 6.3.0
SDL Coverage Viewer   Version 6.3.0
SDL Editor            Version 6.3.0
SDL Index Viewer      Version 6.3.0
SDL Type Viewer       Version 6.3.0
SDT Welcome Window    Version 6.3.0
Text Editor           Version 6.3.0

About All. Additional version and kernel 
information:
Information Server version 6.3.0
SDT Analyzer
SDT Analyzer 6.3.0
SDT CPP2SDL 6.3.0 
ASN.1 Analyzer 6.3.0 
SDL Targeting Expert: Version 6.3.0  

Simulation kernel:
  2 lrwxrwxrwx 1 nnn  sdl  66 May 5 16:05 sctworld.o
RealTimeSimulation kernel:
  2 lrwxrwxrwx 1 nnn  sdl  68 May 5 16:05 sctworld.o
...

License Information

Opens a dialog with license information for all SDL Suite and TTCN Suite tools.

Figure 52 : The License Information dialog

The dialog contains the following:

Abbreviation Tool(s)

Telelogic

Organizer

SDT-Base

SDL Editor, SDL Analyzer and SDL Viewers.

SDT-OME

Object Model Editor and State Chart Editor

SDT-MSCE

Message Sequence Chart Editor and High-Level Message Sequence Chart Editor

SDT-Cbasic

Cbasic SDL to C Compiler

SDT-Cadvanced

Cadvanced SDL to C Compiler

SDT-Cmicro

Cmicro SDL to C Compiler

SDT-Cmicro-Bodybuilder

Cmicro BodyBuilder

SDT-Cmicro-Tester

SDL Target Tester UI

SDT-X1 (UNIX only)

<Configuration dependent>

SDT-Explorer

Explorer Library

SDT-Simulator

Simulator Library

SDT-Application

Application Library

SDT-Performance

Performance Simulation Library

SDT-TTCN-Link

Interactive link to TTCN Suite

ITEX-Base

TTCN Browser, TTCN Table Editor and TTCN Analyzer

ITEX-Access

TTCN Suite Access API Library

ITEX-Simulator

TTCN Suite Simulator

ITEX-C-Code-Generator

TTCN Suite C Code Generator

SDT-Author

Package licenses, see "Description of packages" on page 43 in chapter 5, Licensing Management

SDT-ModelBuilder

SDT-CodeBuilderCMicro

SDT-CodeBuilderCAdvanced

1

The SDT-X is a generic name that allows to introduce new code generators that are under development. In "normal" installations, it has no meaning.

1

X is reserved for future extensions in the SDL Suite applied to code generation.

2

The TTCN-Link kernel is described in the TTCN Suite manuals.


http://www.ibm.com/rational
Contents Index Previous Next