[Previous] [Next] [Contents] [Index]


   The Organizer

Shortcuts

There are several ways to invoke an operation in the Organizer. An operation is usually available in the menu bar and in at least one pop-up menu. Menus can be operated via the keyboard (keyboard navigation). Several operations are also available in the tool bar or via keyboard accelerators. For instance, the Print operation can be invoked by:

The sections below are Pop-Up Menus, Keyboard Accelerators and Quick Buttons.

Pop-Up Menus

This section describes pop-up menus for different types of icons. The operations available depend on the type of file that icon represents.

The following tables lists the menu choices in the pop-up menus and a reference to the corresponding menu choice in the menu bar.

On SDL Diagrams (but Not SDL Overview Diagrams)

Print

Print

Set Directories

Set Directories

Edit > Edit

Edit

Edit > Remove

Remove

Edit > Connect

Connect

Edit > Disconnect

Disconnect

Edit > CM Group

CM Group

Edit > Associate

Associate

Edit > Update Headings

Update Headings

View > Expand

Expand

View > Expand Substructure

Expand Substructure

View > Collapse

Collapse

View > Show Sub Symbols

Show Sub Symbols

View > Hide

Hide

Generate > Analyze

Analyze

Generate > Make

Make

Generate > Stop Analyze/Make

Stop Analyze/Make

Generate > Generate SDL Overview

SDL Overview

Generate > Convert to PR

Convert to PR/MP

Generate > Convert to GR

Convert to GR

Generate > Edit Separation

Edit Separation

Generate > Dependencies

Dependencies

Search

Search

Diff

Diff

Create Endpoint

Link > Create Endpoint

Traverse Link

Link > Traverse

Clear Endpoint

Link > Clear Endpoint

Type Viewer

(On SDL type diagrams only)
SDL > Type Viewer. Opens the Type Viewer with the type diagram selected.

On MSC and SDL Overview Diagrams

Print

Print

Set Directories

Set Directories

Edit > Edit

Edit

Edit > Remove

Remove

Edit > Connect

Connect

Edit > Disconnect

Disconnect

Edit > CM Group

CM Group

Edit > Associate

Associate

Hide

Hide

Dependencies

Dependencies

Search

Search

Create Endpoint

Link > Create Endpoint

Traverse Link

Link > Traverse

Clear Endpoint

Link > Clear Endpoint

On Instance and Dashed Diagrams

Edit

Edit.

Type Viewer

SDL > Type Viewer. Opens the Type Viewer with the diagram selected.

Hide

Hide

On Pages

Print

Print

Edit

Edit.

Hide

Hide

On Associations

Associations have the same pop-up menu as the associated document. All menu choices operate on the associated document, except Hide and Remove that operate on the association symbol itself.

On HMSC, Object Model and State Chart Diagrams

Print

Print

Set Directories

Set Directories

Edit > Edit

Edit

Edit > Remove

Remove

Edit > Connect

Connect

Edit > Disconnect

Disconnect

Edit > CM Group

CM Group

Edit > Associate

Associate

Edit > Update Headings

Update Headings

View > Expand

Expand

View > Expand Substructure

Expand Substructure

View > Collapse

Collapse

View > Show Sub Symbols

Show Sub Symbols

View > Hide

Hide

Dependencies

Dependencies

Search

Search

Create Endpoint

Link > Create Endpoint

Traverse Link

Link > Traverse

Clear Endpoint

Link > Clear Endpoint

On Modules

Print

Print

Edit

Edit

Remove

Remove

CM Group

CM Group

View > Expand

Expand

View > Expand Substructure

Expand Substructure

View > Collapse

Collapse

View > Show Sub Symbols

Show Sub Symbols

Search

Search

Diff

Diff

On Chapters

Print

Print

Edit

Edit

Remove

Remove

CM Group

CM Group

Search

Search

Diff

Diff

On More Symbols

Show Sub Symbols

Show Sub Symbols

On System File

CM Group

CM Group

On Link File

                        

Link Manager

Link > Link Manager

On Source and Target Directories

Set Directories

Set Directories

On the Background

Expand Substructure

Expand Substructure

Collapse

Collapse

View Options

View Options

Set Scale

Set Scale

File > New

New

File > Open

Open

File > Save

Save

File > Save As

Save As

File > Print

Print

File > Set Directories

Set Directories

File > PC Drives

PC Drives

File > Compare System

Compare System

File > Import SDL

Import SDL

File > Exit

Exit

Edit > Add New

Add New

Edit > Add Existing

Add Existing

Edit > Paste As

Paste As

Edit > Go to Source

Go To Source

Convert to GR

Convert to GR

Tools > Organizer Log

Organizer Log

Tools > Link Manager

Link > Link Manager

Tools > Search

Search

Tools > Diff

Diff

Tools > Type Viewer

SDL > Type Viewer

Tools > Coverage Viewer

SDL > Coverage Viewer

Tools > Index Viewer

SDL > Index Viewer

Tools > Simulator UI

SDL > Simulator UI

Tools > Validator UI

SDL > Validator UI

Tools > Cmicro Tester UI

SDL > Cmicro Tester UI

Tools > Preference Manager

Preference Manager

Editors > MSC Editor

Editors > MSC Editor

Editors > HMSC Editor

Editors > HMSC Editor

Editors > OM Editor

Editors > OM Editor

Editors > State Chart Editor

Editors > State Chart Editor

Editors > SDL Editor

Editors > SDL Editor

Editors > Text Editor

Editors > Text Editor

Editors > TTCN Browser

Editors > TTCN Browser

Help > On ORCA and SDT

Help > On ITEX

Help > On Organizer

Help > On ORCA and SDT News

Help > On ITEX News

Help > On Shortcuts

Help > Index

Help > Search

Help > Telelogic Home Page

Help > Help Desk

Help > About Organizer

For more information about Help menu choices, see Help Menu.

Help > License Information

License Information

Keyboard Accelerators

Apart from the general keyboard accelerators, as described in Keyboard Accelerators, the following accelerators can be used in the Organizer:

Accelerator Reference to corresponding command or quick button

Ctrl+A

Add New

Ctrl+B

Connect

Ctrl+E

Edit

Ctrl+I

Import SDL

Ctrl+K

Stop Analyze/Make

Ctrl+M

Make

Ctrl+R

Disconnect

Ctrl+T

Toggles between Analyze/Make (default) and Full Analyze/Full Make. A text is presented in the message area to confirm that <Ctrl+T> has been pressed: Either "Organizer will now use full analyze/make" or "Organizer will now use normal analyze/make". For more information, see Normal versus full analyze (make).

Ctrl+0 (zero)

Set Directories

Ctrl+1

Organizer Log

Ctrl+2

Add Existing

Ctrl+3

Associate

Ctrl+4

Analyze

Ctrl+5

SDL Overview

Ctrl+6

SDL > Type Viewer

Ctrl+7

SDL > Coverage Viewer

Ctrl+8

SDL > Index Viewer

Ctrl+9

Preference Manager

Del

Remove. For documents that can not be removed (non-root SDL diagrams), see Disconnect.

arrow up

Select the symbol one step up (move the selection)

Shift+arrow down

Move Up.

Ctrl+Shift+
arrow up

Place the selected symbol first in the Organizer structure.

arrow down

Select the symbol one step down (move the selection)

Shift+arrow down

Move Down

Ctrl+Shift+
arrow down

Place the selected symbol last in the Organizer structure.

Quick Buttons

The following quick buttons are special to the Organizer's Main window. The general quick buttons are described in General Quick-Buttons. Each quick button in the Organizer has a preference parameter that specifies if the button is shown or hidden; see Organizer Preferences. As default, all quick buttons except New and Add Existing are shown.


Extracted pic [1]
New

Creates a new system; see New.


Extracted pic [2]
Save

Performs a silent Save All of all diagrams including the system file. Does not bring up the Save dialog, except if diagrams are modified and unconnected, or no system file exists. Corresponds to the Save All button in the Save dialog; see Save.


Extracted pic [3]
Print

Brings up the Print dialog, see Printing Documents and Diagrams.


Extracted pic [4]
Analyze

Analyzes the part of the system defined by the selected diagram or the whole system. Brings up a Save Before dialog if any diagram is modified and not saved. Does not bring up the Analyze dialog. Corresponds to the Analyze button in the Analyze dialog. The current Analyze options are used. The same restrictions and checks apply as described in Analyze.


Extracted pic [5]
Make

Makes the part of the system defined by the selected diagram or the whole system, i.e. generates code, compiles and links it. Does not bring up the Make dialog. Corresponds to the Make button in the Make dialog. The current Analyze and Make options are used. The same restrictions and checks apply as described in Make.


Extracted pic [6]
Generate SDL Overview

Generates an SDL overview diagram for the selected diagram or the whole system. Does not bring up the SDL Overview dialog. Corresponds to the Generate button in the Generate SDL Overview dialog. The current Generate SDL Overview options are used. The same restrictions and checks apply as described in SDL Overview.


Extracted pic [7]
Simulate

Generates a simulator for the part of the system defined by the selected diagram or the whole system, and starts a Simulator UI (see Simulator/Validator UI Started from Quick Buttons). Does not bring up the Make dialog if the simulator needs to be regenerated. If a simulation kernel has not been selected in this dialog, the default simulation kernel is used. The default simulation kernel is determined by the preference Organizer* DefaultSimulator. The default value is "SCTADEBCOM" which is the same as using the standard kernel Simulation in the Make dialog. The same restrictions and checks apply as described in Make.


Extracted pic [8]
Validate

Generates a validator for the part of the system defined by the selected diagram or the whole system, and starts a Validator UI (see Simulator/Validator UI Started from Quick Buttons). Does not bring up the Make dialog if the validator needs to be regenerated. If a validation kernel has not been selected in this dialog, the default validation kernel is used. The default validation kernel is determined by the preference Organizer* DefaultValidator. The default value is "SCTAVALIDATOR" which is the same as using the standard kernel Validation in the Make dialog. The same restrictions and checks apply as described in Make.


Extracted pic [9]
Generate Cross References

Generates a cross reference file for the current system and presents the information in the Index Viewer. An index symbol is added in the Organizer view. Does not bring up the Analyze dialog. Corresponds to setting the Generate a cross reference file option in this dialog. The same restrictions and checks apply as described in Analyze and Semantic analysis.


Extracted pic [10]
Add New

Adds a new document as root; see Add New.


Extracted pic [11]
Add Existing

Adds an existing document as root; see Add Existing.


Extracted pic [12]
Move Down

Moves the selected symbol one step down in the Organizer structure. For more information about moving symbols, see Ordering.


Extracted pic [13]
Move Up

Moves the selected symbol one step up in the Organizer structure. For more information about moving symbols, see Ordering.


Extracted pic [14]
Organizer Log

Opens the Organizer Log window; see Organizer Log.

Simulator/Validator UI Started from Quick Buttons

When the Simulate quick button is used and if the generated simulator already was loaded in a Simulator UI, the same Simulator UI will be reused for the newly generated simulator. If no Simulator UI is active, a new Simulator UI will be started. However, if there already are other started Simulator UI's, the user has the choice of selecting one of these to load the generated simulator in.

The following dialog is opened:

Figure 63 : The Simulator/Validator dialog

Extracted pic [15]

The same applies also for a validator and the Validator UI.

Organizer Log Window

The Organizer log window is a sub window to the main window. It works as a console for the Telelogic Tau tools. The window can be visible (raised or iconified) or not visible on the screen. All log information is output to this window independently of whether the window is visible or not.

The window is used in the following situations:

The window is opened or raised when the menu choice Organizer Log is selected from the Tools menu, or when something is written to the log. The preference ShowLogLevel controls which output to the window should cause a raise of the window (see The Preference Manager).

There is only one Organizer Log window. The Organizer main window is not locked for user input when the Organizer Log window is visible.

Figure 64 : The Organizer Log window

Extracted pic [16]

Quick Buttons

The following quick buttons are special to the Organizer Log window. The general quick buttons are described in General Quick-Buttons. Each quick button in the Organizer Log window has a preference parameter that specifies if the button is shown or hidden; see Organizer Preferences. All quick buttons in the Organizer Log are shown by default.


Extracted pic [17]
Close

Exactly the same as Close in the File menu.


Extracted pic [18]
Clear Log

Exactly the same as Clear Log in the Edit menu; see Clear Log.


Extracted pic [19]
Show Error

Exactly the same as Show Error in the View menu; see Show Error.


Extracted pic [20]
Help on Error

Exactly the same as Help on Error in the View menu; see Help on Error.


Extracted pic [21]
Analyze

Exactly the same as the Analyze quick button in the Organizer Main window; see Analyze.


Extracted pic [22]
Show Organizer

Exactly the same as Show Organizer in the Tools menu; see Show Organizer.

File Menu

See File Menu.

Edit Menu

The following menu choices are available in the Organizer log window Edit menu:

Copy

This menu choice copies the selected text to the clipboard buffer.

Select All

This menu choice selects all text in the Organizer Log window.

Clear Log

This menu choice clears all text in the Organizer Log window.

Tools Menu

The following menu choices are available in the Tools menu of the Organizer log window:

Show Organizer

This menu choice raises the Organizer's Main window.

Show Error

This menu choice opens an editor and shows an object/text that corresponds to a selected error/warning. If no text in the log is selected, the menu choice operates on the first error/warning in the log, which becomes selected. If this menu choice is invoked several times without changing the selection manually, the selection is updated automatically to point to the next error/warning before opening the editor and selecting the corresponding object/text.

Help on Error

This menu choice activates the Help tool on the selected error/warning or the next found error/warning. The selection is not updated automatically when selecting this command repeated times (as opposed to Show Error, above).

System File

The Organizer maintains a system file that contains a description of all files that are included in the system, together with all settings the user has made to this particular system. The default file suffix for a system file is .sdt.

In addition, a system window state file contains information about window positions and sizes, and it uses the suffix .sdt.state.

Contents of the System File

The contents of the system file summarizes the information that the Organizer manages:

The system file may contain a mapping of directory paths on Windows and UNIX to allow the system to be accessed on both platforms. See Windows and UNIX File Compatibility for more information.

A number of options are also stored in the system file, but only if they differ from the values in the preference file or if the preference Organizer* AllPreferences is on. The options are:

In addition, information about collapsed, hidden and selected documents are saved to enable the Organizer to open with the same appearance as when the system file was saved. However, simply changing which documents are collapsed, hidden and selected will not mark the system file as "dirty" in the Organizer.

Format of the System File

The system file is a line-oriented, human-readable text file. The system file is divided into sections. Each section contains lines formatted in the same way. Any lines before the first section are ignored, but saved for the next system file save. This means that it is possible to have user defined comments in the beginning of the file.

Caution! 

The sections that describe the diagram and document structure should not be modified by the user unless absolutely necessary. Modifying these sections in a way that errors or inconsistencies are introduced may corrupt the system file.

The file has the following format:

If a section is missing entirely from the system file, a warning will be logged. If no recognizable sections could be found, the file is not a valid system file.

When loading system files, warnings will be registered in the Organizer Log window if any non-recognized option is encountered, but not if an option never was initialized.

The   Drives Section

The purpose of the DRIVES section in the system file is to achieve file compatibility between UNIX and Windows systems. It specifies the drive table; a mapping between Windows and UNIX directory paths. See Windows and UNIX File Compatibility for more information.

The path format of the current platform is used for directory paths stored in the system file: UNIX path names on UNIX systems (i.e. starting with a slash `/' and directories separated by slashes), and Windows path names on Windows systems (i.e. starting with a drive letter "x:" and directories separated by backslashes `\', or using the UNC format "\\<host>\file").

Diagrams with file specifications in an incorrect format are marked as Invalid in the Organizer.

When reading the system file on Windows systems, file specifications in UNIX format are converted to Windows format using the mapping in the DRIVES section, if possible, including converting slashes to backslashes. When the system file is saved, the file specifications are saved in Windows format, i.e. they are not converted back to UNIX format.

On UNIX systems, file specifications in Windows format are converted to UNIX format using the mapping in the DRIVES section, if possible, including converting backslashes to slashes. When the system file is saved, the file specifications are saved in UNIX format, i.e. they are not converted back to Windows format.


Example 3       

The DRIVES section of the system file looks like this:

The file specification /tmp/a.ssy in the system file is converted to C:\TEMP\a.ssy.

The file specification /home/user/mydir/a.ssy is converted to
\\MYHOST\STORAGE\mydir\a.ssy
.

The file specification /usr/local/dir/a.ssy is converted to \usr\local\dir\a.ssy. Since no drive or host name could be matched, the file will not be found and the diagram will be marked as Invalid in the Organizer.


Options in the System File

A number of sections contain options for the Organizer, representing values that can be set in the Organizer dialogs. If an option in the file is not recognized by the Organizer, it will be ignored, and if an option is not included in the file, a default preference value will be used. A few of the options have no corresponding preference parameters.

The following tables list the Organizer options that are saved in the system file. The user should not normally need to know or change these options in the system file. However, when running SDT in batch mode on UNIX, it may be useful to change some options by editing a system file to be submitted as input to sdtbatch. See SDT Batch Facilities for more information.

The options must appear in the correct section of the system file, but the ordering of options within a section is not important. The options are stored in the system file according to the format:

The option names and option values are case insensitive.

Possible and allowed values are not specified; the user should run the Preference Manager in order to obtain a reference to the permitted values.

SOURCE-TARGET-DIRECTORY Section

Option Default Corresponding Preference

AbsolutePath

false

Organizer* AbsolutePath

SourceDirectory

""

Organizer* SourceDirectory

TargetDirectory

""

Organizer* TargetDirectory

VIEWOPTIONS Section

Option Default Corresponding Preference

Scale

100

SDT* Scale

ShowDashed

true

Organizer* ShowDashed

ShowDependencies

true

Organizer* ShowDependencies

ShowDirectories

true

Organizer* ShowDirectories

ShowFileNames

true

Organizer* ShowFileName

ShowGroups

true

Organizer* ShowGroups

ShowInstances

true

Organizer* ShowInstances

ShowLinkFile

false

Organizer* ShowLinkFile

ShowLinks

true

Organizer* ShowLinks

ShowLongMenus

true

Organizer* ShowLongMenus

ShowPages

false

Organizer* ShowPages

ShowPermissions

true

Organizer* ShowPermissions

ShowSeparators

true

Organizer* ShowSeparators

ShowStatusBar

true

Organizer* Statusbar

ShowSystemFile

true

Organizer* ShowSystemFile

ShowToolBar

true

Organizer* Toolbar

ShowTypeName

false

Organizer* ShowTypeName

ShowVirtuality

true

Organizer* ShowVirtuality

TreeRepresentation

List

Organizer* TreeRepresentation

ANALYSEROPTIONS Section

Option Default Corresponding Preference

AllowImplicitTypeConv

off

Organizer* AllowImplicitTypeConv

EchoAnalyzerCommands

off

Organizer* EchoAnalyzerCommands

ErrorLimit

30

Organizer* ErrorLimit

ExpandPR

false

Organizer* ExpandPR

ExpressionLimit

0

Organizer* ExpressionLimit

Filter

false

Organizer* FilterCommand

FilterCommand

""

Organizer* FilterCommand

H2SDLOptions

""

Not available

MacroExpansion

false

Organizer* MacroExpansion

OptionalParamControl

true

Organizer* OptionalParamControl

OutputControl

true

Organizer* OutputControl

ReferenceControl

true

Organizer* ReferenceControl

SemanticControl

true

Organizer* SemanticControl

SyntaxControl

true

Organizer* SyntaxControl

TerminateAnalyzer

off

Organizer* TerminateAnalyzer

TrailingParamControl

true

Organizer* TrailingParamControl

UpperCase

false

Organizer* UpperCase

UsageControl

true

Organizer* UsageControl

XRef

true

Organizer* XRef

MAKEOPTIONS Section

Option Default Corresponding Preference

Capitalization

AsDefined

Organizer* Capitalisation

CCompilerDriver

false

Not available

CompileAndLink

true

Organizer* CompileAndLink

GenerateCode

true

Organizer* GenerateCode

GenerateEnvFunctions

false

Organizer* GenerateEnvFunctions

GenerateEnvHeader

false

Organizer* GenerateEnvHeader

GenerateSignalNumbers

false

Organizer* GenerateSignalNumbers

Kernel

"SCTADEBCOM"

Organizer* Kernel

MakefileMode

Generate

Organizer* MakefileMode

PrefixType

Full

Organizer* PrefixType

Separation

No

Organizer* Separation

StandardKernel

true

Organizer* StandardKernel

TargetLanguage

Cbasic

Organizer* TargetLanguage

UserKernel

""

Organizer* UserKernel

UserMakefile

""

Organizer* UserMakefile

UserTemplate

""

Organizer* UserTemplate

XCodeGenerator

X

Organizer* XCodeGenerator

PRINTOPTIONS Section

Option Default Corresponding Preference

DestinationFormat

PSFile

Print* DestinationFormat

FirstPageNo

1

Not available

FrameMakerCommand

"imaker"

Print* FrameMakerCommand

MarginLeft

100

Print* MarginLeft

MarginLower

250

Print* MarginLower

MarginRight

100

Print* MarginRight

MarginUpper

420

Print* MarginUpper

PageMarkers

false

Print* PageMarkers

PaperFormat

A4

Print* PaperFormat

PrinterCommand

"lpr -h -r"

Print* PrinterCommand

PrinterFile

""

Not available

PrintFrom


Not available

PrintTo


Not available

PrintToFile

true

Not available

System Window State File

When the system file is saved, a second file is saved as well; the system window state file. This file contains information about window positions and sizes. If an editor window is not open when the system file is saved, the last known position and size of that window is saved instead. While the system file uses the .sdt extension, the system window state file uses the .sdt.state extension.

If the Organizer finds a system window state file when opening a system file, the positions and sizes of the Organizer and editor windows are restored to the positions they had when the system file was saved. Note that the editor windows are not restored until they are opened from the Organizer.

Control Unit File

In addition to the System file (see System File), the Organizer also manages Control Unit files, .scu files. These control units are introduced to facilitate the workgroup (multiuser) support when working with an SDL system managed by Telelogic Tau, and merging the individual results to a common system file.

General

The multiuser support in Telelogic Tau is based on, from a revision control point of view, letting the user split the system file into several files. Information that is updated often should be split and stored in control unit files.

When and where to split the SDL structure is an active action taken by the user.

The multiuser mode is effective when control unit files are used. The use of the control unit files is optional, whereas the system file is mandatory. The Organizer thus always requires a system file and can manage multiple control unit files. By not taking advantage of control units simply means using the Organizer and system files as was done before, i.e. in previous versions of Telelogic Tau (3.0X/3.1X/3.2).

Definitions

A definition for a system file (.sdt file) from a revision control point of view: a file that contains structure and state information for a document system as seen by one Telelogic Tau user. This file is normally not considered as an essential part of the system and is not suitable for revision control as it is private to one user.

A similar definition for a control unit file (.scu file): a file that contains structure information for a subset of a document system and which is common to all users that work with the document system. Control unit files are part of the document system and are suitable for revision control.

The control unit files can be inserted and made visible in the Organizer's file structure view. The control unit files contain information that is specific to the Organizer file structure for diagrams, modules and chapters.

Splitting the System File

The users control what parts of the file structure managed by the Organizer need a separate control unit file. When several users work on a system, the management of the system file may be difficult to synchronize. This problem is solved if every user or group have control over their own part of the system file.

The Organizer structure information is hence split into several files -- control unit files. The decision of where and how many control unit files are needed is left to the users; the idea being to partition the diagram system according to the user's work responsibilities and assign control unit files to these partitions. An example can be a large SDL diagram system where there are several blocks on the system level developed in parallel by different developers. Each block could then be associated with a control unit file. Now, the blocks can be updated independently and the changes are shaping the local control unit files. There is no need to manually merge changes into the system file when the work is done -- the management of control unit files performed by the Organizer also includes the merge.

The user decides how control unit files and the system file cooperate to produce the Organizer view of the document system. Two scenarios are possible here. In one scenario the user decides that the system file is valid and the diagram structure is read from it. This is done when the user opens the system file and loads the document system into the Organizer. In the other scenario the control unit files are used to load the Organizer view and automatically update it accordingly to a specific revision for the document system -- the system file is used only to fill in document state information (if any is available). This is done with a menu command when control unit files are used to explicitly update the document system or some part of it.

An Example

To illustrate the use and contents of control unit files and facilitate the understanding, let us discuss the topic with a simple example as input.


Example 4        

Say we have the following system managed by the Organizer:

Figure 65 : A simple system, managed by the Organizer

Extracted pic [23]

Let us say that we create control units (using the CM Group command) for the following items:

We would now have a system that looks like this:

Figure 66 : The same system, now with control units
The control units are depicted in bold face.

Extracted pic [24]

The [DIAGRAMS] section of the demongame.sdt file will contain:

The files system.scu, diagrams.scu, demongame.scu and gameblock.scu will contain the following information:


Format and Structure of the Control Unit File

Format

The format of the control unit file complies with the syntax of the [DIAGRAMS] section in the system file (see Format of the System File). There are however some exceptions:


Example 5        

Structure

Associations between Control Units and Document Structures

A control unit file is associated with a document structure in the Organizer. The control unit file holds information about the top node of the structure and information about lower level documents under the top node and/or other lower level control unit files.

Levels (Indents)

Document nodes in a control unit file have a relative level (i.e. <indent>) starting from 0. (Exceptions: a chapter node and an control unit file node associated with a chapter have always level -1). This gives the flexibility that the control unit file can be associated with a node on different levels in the system structure of documents. To get the actual level for a document node from an control unit, the control unit file node level should be added to the document's relative node level.


Example 6 : For the control unit level 1 from Example 4       

Hierarchy

The control unit files are hierarchical. The top control unit file is for the whole system of documents in the Organizer. We give this control unit file level (-2). If this file has an information line in the system file this means that the top of the whole system structure is found in that file. Other structure information about diagrams mentioned in the system file is then only a mirror of the structure information found in the control unit hierarchy.


Example 7 :      

Modularity

The user can choose to use a control unit file only for a specific chapter, module or diagram structure (without a top level control unit system file). This means that not all information in the system file is a mirror for structure information from control unit files. Some of the information can be actual structure information that is not controlled by control unit files. When the Organizer expands structure information from control unit files it tries to match that information against the contents in the system file. This matching is necessary because only the system file holds state information about documents. The structure information from control unit files takes precedence over structure information found in the system file. If there is an inconsistency between the control unit file structure information and the system file, the control unit information takes precedence and the SDT contents are treated as an error situation. Say, for instance, that according to a control unit file there are three blocks in an SDL system but there are four blocks in the system file. The extra block is probably old information.


Example 8 : A control unit file for a chapter      

Order of Appearance

A control unit information line in the system file is followed by a mirror information line of the top node that the control unit file is associated with. If the Organizer cannot open the control unit hierarchy the mirror information will function as a back-up document structure information.


Example 9       

SDT Batch Facilities

SDT supports operations in batch mode, such as printing the documentation, analyzing an SDL structure and generating code. These operations are managed by the Organizer in a batch, windowless mode.

SDT Batch Syntax

The syntax for an SDT batch command is:

Where <systemfile> and <options> are described in SDT Batch Options.

When the sdtbatch command is issued, the Organizer interprets the command line arguments, performs the requested operation and then terminates. Error logging is performed by the Organizer.

Information concerning the batch job is directed the standard output device.

Note: 

When executing an SDT Batch command, external service management via the PostMaster interface is disabled.

Print Multiple Files

Syntax:

Prints the contents in the system file. Corresponds to clicking the Print quick button.

Print One File

Syntax:

Prints one file.

Compare Two Files

Syntax:

Compares two SDL document files. By default, a summary of how many differences that were found is printed. When using the -b option (verbose), information about every differing object is presented, including an SDT reference to the object in question. When using the -n option, moved symbols are not detected, but are presented as removed and added symbols instead.

Analyze

Syntax:

Analyzes the contents in the system file. Corresponds to the Analyze quick button.

Make

Syntax:

Makes a target as specified by the system file. Corresponds to the Make quick button.

SDT Batch Options

Windows and UNIX File Compatibility

Systems can be created with Telelogic Tau on both the UNIX and Windows platforms. To allow systems to be accessed on both platforms, Telelogic Tau provides a file compatibility concept.

The drive table contains a mapping between Windows and UNIX directory paths. This mapping is included in the system file to allow file specifications in the system file to be translated to the correct format on both platforms. See Drives Section for more information.

The menu choice PC Drives is available in the Organizer's File menu, and allows editing the drive table that is stored in the system file. See PC Drives for more information.

The drive table takes care of translating absolute paths between the two different file name formats (UNIX and Windows). On a UNIX system, some restrictions apply to file names to be compatible with Windows. These restrictions are checked whenever the user changes a file specification that is stored in the system file; if they are not followed, an error dialog is shown and the user is returned to the dialog where the file was specified. See Filename Error Dialogs (UNIX only) for more information.

File specifications are always stored in the correct format according to the current platform.

In general, diagrams with file specifications that are of incorrect format or that cannot be translated to the correct format, are marked as Invalid in the Organizer.


[Previous] [Next] [Contents] [Index]