Overview
Terminology
The following basic terminology is used throughout this chapter:
- Document
- A document is a file containing information that can be edited in a particular editor available through SDL Suite and TTCN Suite. 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.
- Tau Workspace / Tau Project
- (Windows only) Files of types .ttw or .ttp that contains a Workspace or a Project handled by the IBM Rational Tau tool. When editing such a document the Organizer will launch the IBM Rational Tau tool.
- Rhapsody Project
- (Windows only) Files of types .rpy that contains a Project handled by the IBM Rational Rhapsody tool. When editing such a document the Organizer will launch the IBM Rational Rhapsody tool.
- 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 SDL Suite 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 TTCN Suite signifies the topmost TTCN document with all its sub TTCN documents.
- System
- Not to confuse with an SDL or TTCN system, a system in the Organizer refers to 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 the SDL Suite 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 user. Organizer user settings and viewing options are also stored in this file. The system file is described further in "System File" on page 190.
- 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" on page 201.
- 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" on page 487.
- Source Directory
- Target Directory
- The source directory 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" on page 30 and "Directory Selection Dialog" on page 31 in chapter 1, User Interface and Basic Operations.
- The target directory specifies where to put generated files.
- These directories are set in the Organizer, see "Set Directories" on page 71. 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" on page 344 in chapter 5, Printing Documents and Diagrams.