The Organizer

The Organizer is the main tool in Telelogic Tau. When you invoke a Telelogic Tau tool, the Organizer is started and displayed on the screen.

This chapter contains a reference manual for the Organizer; the functionality it provides, its menus, windows and symbols.

Table of Contents 

• Overview
• Terminology
• Organizer User Interface
• Drawing Area
• Presentation Modes
• Chapters
• Structure Icons
• Document Icons
• Icon Names and Types
• Double Clicks
• Menu Bar
• Available Menu Choices
• File Menu
• Edit Menu
• View Menu
• Generate Menu
• Tools Menu
• Help Menu
• Shortcuts
• Pop-Up Menus
• Keyboard Accelerators
• Quick Buttons
• Organizer Log Window
• Quick Buttons
• File Menu
• Edit Menu
• Tools Menu
• System File
• Contents of the System File
• Format of the System File
• The Drives Section
• Options in the System File
• System Window State File
• Control Unit File
• General
• An Example
• Format and Structure of the Control Unit File
• SDT Batch Facilities
• SDT Batch Syntax
• Print Multiple Files
• Print One File
• Compare Two Files
• Analyze
• Make
• SDT Batch Options
• Windows and UNIX File Compatibility

Overview

Terminology

The following basic terminology is used throughout this chapter:

• Document

A document is a file containing information that can be edited in an editor available through the use Telelogic Tau. Examples of documents in the Organizer are SDL diagrams, MSC diagrams, TTCN documents, and text documents.

• Generic Document

Files containing document types that the Organizer does not normally handle can be included in the Organizer by using a generic document symbol and connecting that symbol to the file. The Organizer uses the file extension and the preference variable Organizer* GenericCommand to determine a command to perform when the user tries to edit a generic document.

• Diagram

A diagram is a graphical document that only can be edited in a graphical editor. Diagrams are either SDL diagrams, MSC diagrams, HMSC diagrams, Object Model (OM) diagrams, or State Chart (SC) diagrams.

• TTCN Document

A TTCN Document signifies a document of type Test Suite, Modular Test Suite, TTCN Module, or TTCN Package.

• SDL System

An SDL system in Telelogic Tau signifies the topmost SDL diagram with all its sub diagrams, and all used SDL packages with their sub diagrams. In the normal case, the topmost diagram is an SDL system diagram, but the Organizer allows all types of SDL diagrams to be the topmost diagram, as long as the standard hierarchical rules of SDL diagrams are respected.

• TTCN System

A TTCN system in Telelogic Tau signifies the topmost TTCN document with all its sub TTCN documents.

• System

Not to confuse with an SDL or TTCN system, a system in Telelogic Tau is a set of documents that, according to your view, are related and thus managed by the Organizer. You decide which documents make up a system and how they are related and grouped together in the Organizer.

A system can contain documents for analysis, design and testing of one or more SDL and/or TTCN systems. The documents can be textual requirements, analysis and design diagrams, test specifications, source code in different forms, and other types of related documentation.

In the normal case, one system in SDT contains one SDL system. But for special purposes it is possible to have more than one SDL system in the system context. Such a purpose could be when working with communicating simulators on UNIX where the source diagrams of each system are required to show and trace the graphical source symbols.

• Root Document

The topmost document in a document structure, or a stand-alone document, or a top-level document in a module. For an SDL system, the topmost diagram in the system, usually an SDL system diagram.

SDL package diagrams and macro diagrams are special in the sense that they are used by an SDL system diagram. Therefore, they are also placed at the root level and are considered root diagrams.

• Association

An association is a link between two documents. Any document can be associated with any other document; a typical example is to associate an MSC diagram with a related SDL diagram. In the document structure, an association symbol is included to the associated document. This symbol is handled like a document, even though it simply represents a document residing somewhere else.

• Chapter

The drawing area of the Organizer is divided into several chapters. You may freely add, remove, and rename chapters, as well as rearrange the order of the chapters. Each chapter has an associated chapter level. It is possible to set the start chapter number.

• Module

A concept specific to the Organizer, used for freely grouping root documents together into a document structure. The user can use modules as a kind of scope unit. Modules have no corresponding concept in SDL, MSC or TTCN terminology. Note, however, that a TTCN Module is not the same concept as a module in the Organizer.

• Logical Diagram Name

The Organizer can identify diagrams in the system by their logical diagram names. The logical diagram name may contain the entire qualified name of the diagram in a specific format. The connection between logical diagram names and physical file names is explicit and under user control.

• System File

A file containing information about the structure and state information of a system as seen by one Telelogic Tau user. Organizer user settings and viewing options are also stored in this file. The system file is described further in System File.

• Control Unit File

A file that contains a control unit, i.e. structure information for a part of a system, common to all users that work with the system. The purpose is to provide workgroup support and a means to put a system under revision control. The user has full control of what parts of a system should be managed as control units. The control unit file is described further in Control Unit File.

• Link File

A file that contains the endpoint and link information, which is managed by the Link Manager. The link file is described further in The Link File.

• Source Directory
• Target Directory

The source directory in Telelogic Tau specifies where new documents that you have created, are saved by default, and where to read from when opening and converting documents. On UNIX, the source directory is also the directory normally shown when you click Current in a standard file selection dialog or a standard directory selection dialog. For more information, see File Selection Dialog and Directory Selection Dialog.

The target directory specifies where to put generated files.

These directories are set in the Organizer, see Set Directories. They are also saved in the system file.

• Footer File
• Header File

Footer and header files are used to define how footers and headers should look like when pages are printed. The footer and header file symbols makes it easy to edit the appearance of the footer or header using a text editor. The footer and header file format is described in Footer and Header Files.

Organizer User Interface

The Organizer consists of two windows: a main window and a log window. For a general description of the user interface, see User Interface and Basic Operations.

The main window of the Organizer is also the main window of the Telelogic Tau environment. It manages the current system structure and is responsible for invocation and termination of other tools in Telelogic Tau.

Figure 14  : The Organizer main window

The main window exists in one instance only. If more than one Organizer is required, another Telelogic Tau tool must be started. For special purposes, the Organizer can handle more than one TTCN or SDL system simultaneously.

The log window is a text window used for displaying output during analysis and code generation and for displaying general logs. The window is described in Organizer Log Window.

Drawing Area

In the Organizer's drawing area, the files in the system and their structure are presented graphically using icons.

Presentation Modes

The Organizer can present the system information in two different ways graphically:

• As an indented list, i.e. a compact, line-oriented list of icons using indentation to suggest the structure (see Figure 15).
• As a vertical tree, which is depth- or level-oriented and requires a larger amount of space (see Figure 16).

The user can change the amount of information and the way it is presented in the drawing area with the menu choice View Options in the View menu. See View Options for more information.

Figure 15 : Indented list mode

Figure 16 : Vertical tree mode

Chapters

The chapter concept can be used to define a collection of documents. There are no restrictions on what kind of documents that may be placed in a certain chapter, or on the order of documents in a chapter; this is for the user to decide. Chapters can further be used to structure a print-out of the system included in the Organizer view. More information about this can be found in Advanced Print Facilities.

A chapter has a name, and possibly a number. A chapter is shown as a thick horizontal line in the drawing area, together with its number and name. A chapter symbol can be placed inside a Module, as well as inside an SDL diagram structure and a TTCN Module structure.

In addition to the line icon, it is possible to have the Organizer show the text "Chapter" ahead of the number and name; see Icon Names and Types.

Chapter Levels

A chapter has an associated chapter level, ranging from 0 to 4, which is reflected in the numbering of the chapter:

• Level 0: a chapter without a number (only a name)
• Level 1: a chapter with a single number: 1, 2, 3, etc.
• Level 2: a chapter with two numbers: 1.1, 1.2, 1.3, etc.
• Level 3: a chapter with three numbers: 1.1.1, 1.1.2, 1.1.3, etc.
• Level 4: a chapter with four numbers: 1.1.1.1, 1.1.1.2, 1.1.1.3, etc.

Numbered chapters are auto-numbered by the Organizer. The initial number for the first chapter in the drawing area can be specified. The initial level of a chapter is specified when the chapter is created, but can later be changed.

Chapter Introduction Text

A chapter can be associated with a text, which can be regarded as an introduction text to the chapter. When the chapter is included in a print-out, this text will be inserted on a separate page corresponding to the position of the chapter symbol.

The text is saved in a text file, which the chapter symbol is connected to.

Default Chapters

There is a default set of unnumbered chapters, known as the basic Organizer view, intended for different kinds of documents. This view appears when creating a new system file and contains the following chapters:

• Chapter Analysis Model
• Chapter Used Files
• Chapter SDL System Structure
• Chapter TTCN Test Specification
• Chapter Other Documents.

The intended use of these default chapters is described below. The default set of chapters can be changed by editing the preference Organizer* Areas.

Chapter Analysis Model

The Analysis Model chapter is intended for documents used in a system's analysis, such as Object Model and State Chart diagrams, text requirement documents, MSC, HMSC and SDL requirement diagrams, etc.

Chapter Used Files

The Used Files chapter is intended for documents that are not generated by Telelogic Tau and that are used, included, or imported by other documents in other chapters. Such documents may be C/C++ header files, IDL text documents, etc.

Chapter SDL System Structure

The SDL System Structure chapter is intended for the SDL diagram structure that normally is the primary information managed by the Organizer. The diagram structure contains a strictly hierarchical view of one or more root diagrams and their substructures. Most often only one diagram structure is used (a system) with one or more package or macro structures present as separate roots in the system. A characteristic of these diagrams is that they are directly involved in the analysis/code generation process. Multiple system roots are allowed, mainly to support the possibility of running communicating simulators with graphical trace.

Chapter TTCN Test Specification

The TTCN Test Specification chapter is intended for TTCN documents used for test specifications.

Chapter Other Documents

The Other Documents chapter is intended for documents that do not fit into any of the other chapters. It may contain SDL, MSC, and HMSC diagrams, text documents, etc. that are not directly part of an SDL system and that are not related to the other document structures in the Organizer.

Structure Icons

A few special icons in the Organizer are used for showing how document icons are structured, and for specifying where they are stored in the file system by default.

In addition to the icon, it is possible to have the Organizer show the type of the structure icon textually; see Icon Names and Types.

Different operations are applicable to different types of icons. Double-clicking an icon is described in Double Clicks, and associated popup menus are described in Pop-Up Menus.

	System File The name of the system file. This system file could be managed as a control unit (CM group) to allow revision control of the system file in a multiuser environment.
	Link File The name of the link file.
	Control Unit File This icon designates a control unit whose contents have not yet been resolved.
	Source Directory The name of the source directory.
	Target Directory The name of the target directory.
	Header File The name of the header definition file. Note that it is possible to connect a text file to this symbol, i.e. the symbol can act as a plain text symbol.
	Footer File The name of the footer definition file. Note that it is possible to connect a text file to this symbol, i.e. the symbol can act as a plain text symbol.
	Chapter A chapter in the drawing area. A chapter can have a number and a name and may be connected to a text file.
	Module Another way to define a collection of documents, within a chapter. A module has a name but no associated file name.
	More Indicates that a number of documents are hidden in the document structure (see Hide). The text associated with the icon indicates the number of hidden (additional) documents, e.g. "5 More".

Document Icons

To visualize the different types of documents that are present in the user's system, a large number of graphical icons are used. A unique icon is provided for every document type that is commonly used in a system. In particular, each SDL diagram type (except packages, systems, macro definitions and operators) already have a given icon (the reference symbol specified in the Z.100 recommendation).

In addition to the icon, it is possible to have the Organizer show the type of the document textually; see Icon Names and Types.

Different operations are applicable to different types of icons. Double clicking an icon is described in Double Clicks, and associated popup menus are described in Pop-Up Menus.

Icon Types

The list below shows the icons that may be part of a system display in the Organizer:

	Object Model Diagram icons
	Object Model
	State Chart
	SDL Diagram icons
	Package
	System
	Block
	Substructure
	Process
	Service
	Procedure
	Macro
	System type
	Block type
	Process type
	Service type
	Operator
	SDL Overview
	MSC Diagram icons
	MSC
	HMSC
	Text Document icons
	ASN.1 Text
	Build Script (see Build Scripts)
	C Header
	IDL Text
	Plain Text
	Word Text
	TTCN Document icons
	Modular Test Suite
	Module
	Package
	Test Suite
	Flat View
	SDL Instance icons
	System instance
	Block instance
	Process instance
	Service instance
	SDL Dashed icons
	Block
	Process
	Service
	Other icons
	The icon for an association or a dependency is a dashed version of the icon of the referenced document. The example to the left shows an association referencing an MSC icon.
	Generic Document
	Index icon, representing a generated cross reference file that can be viewed in the Index Viewer.
	Page (used for SDL, HMSC, State Chart, and OM diagrams)

Diagram and Document Icon States

The diagram and document icons can have different background colors indicating the state of the information entity associated with the icon. If the icon state is anything else than normal, additional information about the corresponding file is provided in the Status Bar when the icon is selected.

	Normal The normal state of the icon. Information is not modified. All diagram and document icon types can be normal. This is also the background color used by all non-diagram/document icons.
	Invalid The connected file does not exist or is not a diagram file of the correct type. This state is only possible when connected to a file. All diagram and document icons can be invalid. For more information on invalid icons, see Open and Drives Section.
	Mismatch The SDL diagram is not referenced in the diagram file where this diagram is referenced in the Organizer, i.e. there is a SDL diagram structure mismatch between the system file and the diagram files. This state is only possible when connected to a file. Mismatched diagrams that are unconnected are removed from the diagram structure in the Organizer. SDL diagram icons that are not root diagrams can be mismatched. The reason for a mismatch is that the reference symbol in the parent diagram states a diagram name different than the kernel heading in the mismatched SDL diagram. For more information on mismatches, see Open and No Save.
	Dirty The associated information entity is modified, but not yet saved. This state is only possible when connected to a file. All diagram and document icons can be dirty.

Ordering

The order of root documents in a chapter is not fixed and can be changed by the user; see Move Down and Move Up. Moving documents in the Organizer is also used for two other purposes:

• Grouping root documents in a module. Trying to move a root document "over" a non-collapsed module, will result in that the root document becomes a child symbol to the module. A document is also moved out of a module by moving the document up (or down) one or several times.
• Grouping TTCN documents to form a TTCN system. Trying to move a root TTCN document with no children over another (non-collapsed) root TTCN document (possibly with children), will result in that the moved TTCN document will become a child symbol below the other root TTCN document. A non-root TTCN document is moved out of a TTCN system by moving the TTCN document up (or down) one or several times.

However, the order in which "child" icon types to a "parent" icon appear is fixed according to the following:

1. Page icons
2. Association icons
3. Dependency icons
4. SDL Instance icons
5. SDL Dashed icons
6. Child diagram and document icons

The ordering of page icons is specified in the appropriate editor for the diagram/document type (see SDL Page Order, or Diagrams and Pages). The ordering of association icons, dependency icons, SDL instance icons and SDL dashed icons is fixed and cannot be changed by the user. The ordering of child diagram and document icons can also be changed.

Icon Names and Types

The names of chapters, modules and documents in the Organizer are always shown to the right of the icon.

It is possible to show the type of each icon, i.e. a text of the form "System file", "Chapter", "Module", "Object Model", "Block", etc., directly to the right of the icon (ahead of the name). For SDL diagrams, it is also possible to show the virtuality of the diagram. Both these options are available from the menu choice View Options in the View menu. See View Options for more information.

If the document is not opened in an editor, the icon text is presented in a normal, plain type face. If the document is opened in an editor, the text is presented in bold face.

Double Clicks

To double click on an icon invokes a default action on the information type that the icon represents.

The menu choices and operations corresponding to the double clicks are:

Type of icon	Menu choice / operation
Diagram and document icons	Edit on the selected diagram/document itself
Page icons	Edit on the selected page in the associated diagram/document
Association and Dependency icons	Edit on the diagram the link points to
SDL Instance icons and SDL Dashed icons	SDL > Type Viewer The corresponding symbol becomes selected in the Type Viewer. A double-click on the symbol in the type viewer shows and selects the symbol in the parent SDL diagram.
Source Directory and Target Directory icons	Set Directories
System File icon	CM Group
Link File icon	Link > Link Manager
Header File and Footer File icons	Edit on the connected text file
Chapter icon	Edit on the chapter, i.e. brings up the Edit Chapter dialog for that symbol
Module icon	Edit on the module, i.e. brings up the Edit dialog for that symbol
More icon	Show Sub Symbols