List of Available Properties

The customization files propdefs.propdefs and proplocs.proplocs define the available properties. The customization files stereodefs.stereodefs and stereolocs.stereolocs define the available stereotypes. These files can be edited and saved on any level in the repository.

This section briefly describes the properties and stereotypes provided with the UML suite. For information about defining your own properties and stereotypes, see Chapter 8, Customizing Properties, and Chapter 9, Customizing Stereotypes in The UML Suite Customization Guide.

AD properties

The following table lists the properties available in the activity diagram (AD). Unless otherwise indicated, the properties are available during the Analysis, System Design, and Object Design phases. Unless otherwise indicated, they are item properties, which are saved when you edit them.

CD properties

Property	Object Type	Description
Doc	Diagram and all objects	Unrestricted text about the diagram or object; for example, comments, implementation notes, or revision data.

The following table lists the properties available in the class diagram (CD). Unless otherwise indicated, the properties are available during the Analysis, System Design, and Object Design phases. Unless otherwise indicated, they are item properties, which are saved when you edit them.

Depending on the code generator that you are using, additional properties can be available during the Object Design phases. See The UML Suite Code Generation Guide for the your code generator.


Property	Object Type	Value	Description
Applicability	Design Pattern		Text descibing the situations in which the design pattern can be applied. Contains examples of poor designs that the pattern can address. Note: This is a component property. It is saved when you save the diagram.
Attribute Changeability	Attribute	None (default) Frozen Add Only	Object Design phase only. Specifies whether the attribute value can be changed. Optionally, the UML suite displays this property value in the diagram as a string enclosed in curly braces following the attribute specification. See Showing Property Values. Note: This is a component property. It is saved when you save the diagram.
Collaborations	Design Pattern		Text describing how the participants collaborate to carry out their responsibilities. Note: This is a component property. It is saved when you save the diagram.
Consequences	Design Pattern		Text describing how the pattern supports its objectives and the trade-offs and results of using the pattern. Note: This is a component property. It is saved when you save the diagram.
Constraint Changeability at Start Constraint Changeability at End	Association Aggregation Composition Qualified association Qualified aggregation Qualified composition	None (default) Frozen Add Only	Object Design phase only. Specifies whether the multiplicity of the association can be changed. Optionally, the UML suite displays this property value in the diagram as a string enclosed in curly braces following the multiplicity specification. See Showing Property Values. Note: This is a component property. It is saved when you save the diagram.
Data Type	Qualifier on qualified association, aggregation, or composition		Data type of the qualifier. Optionally, the UML suite displays this property value in the diagram using the standard attribute syntax, attr:type. See Showing Property Values.
Default value	Parameter		Object Design phase only. Specifies the default value of the parameter. Optionally, the UML suite displays this property value in the diagram as: operation-name(param:type=default). See Showing Property Values. Note: This is a component property. It is saved when you save the diagram.
Doc	All objects Diagram (cad)		Unrestricted text about the diagram or object; for example, comments, implementation notes, or revision data.
Implementation	Design Pattern		Text describing the pitfalls, hints and techniques you should be aware of when implementing the pattern. Also describes any language specific issues. Note: This is a component property. It is saved when you save the diagram.
Intent	Design Pattern		Text describing what the design pattern does and what particular design issues or problems are addressed. Note: This is a component property. It is saved when you save the diagram.
Is Abstract	Class Package OMT module: Container	Check box	Object Design phase only. If set, specifies that the object is abstract; that is, subclassing or another mechanism provides implementation.
Is Leaf	Class Package OMT module: Container	Check box	Object Design phase only. If set, specifies that the object has no child objects.
Is Polymorphic	Operation	Check box	Object Design phase only. If set, indicates that the operation is polymorphic (dynamically bound in previous releases). Note: This is a component property. It is saved when you save the diagram.
Is Query	Operation	Check box	Object Design phase only. If set, indicates that the operation only queries the attributes of the class; it does not modify them. Optionally, when this property is set, the UML suite displays it in the diagram as {query} following the operation specification. See Showing Property Values. Note: This is a component property. It is saved when you save the diagram.
Is Root	Class Package OMT module: Container	Check box	Object Design phase only. If set, specifies that the object has child objects.
Known As	Design Pattern		Brief text listing other well known names for the pattern, if any. Note: This is a component property. It is saved when you save the diagram.
Known Uses	Design Pattern		Text listing examples of the pattern found in real systems. Note: This is a component property. It is saved when you save the diagram.
Motivation	Design Pattern		Text describing a scenario that illustrates a design problem and how the design pattern solves the problem. Note: This is a component property. It is saved when you save the diagram.
Navigability	Association Aggregation Composition Qualified association Qualified aggregation Qualified composition	Default (default) No-Way Forward Backward Two-Way	Indicates the directions in which you can navigate the association. Default indicates that this information should be derived from the presence of role names. Optionally, the UML suite displays this property in the diagram as an arrow at one or both ends of an association. See Showing Property Values. Note: This is a component property. It is saved when you save the diagram.
Parameter Kind	Parameter	" " (default) In Out InOut	Object Design phase only. Specifies the kind of parameter. Optionally, the UML suite displays this property value in the diagram as: operation-name(kind param:type). See Showing Property Values. Note: This is a component property. It is saved when you save the diagram.
Participants	Design Pattern		Text listing the classes and/or objects participating in the design pattern and their responsibilities. Note: This is a component property. It is saved when you save the diagram.
Persistence	Class OMT module: Container	Persistent Transitory	System Design and Object Design phases only. Specifies whether the object persists beyond the life of the application (persistent) or exists only for the duration of the application (transitory). Persistent objects are generally stored in databases.
Related Patterns	Design Pattern		Text describing other patterns closely related to this one. Note: This is a component property. It is saved when you save the diagram.
Responsibility	Class Operation OMT module: Container		Object Design phase only. Unrestricted text that provides a high-level description of the purpose of the object.
Sample Code	Design Pattern		Code fragments suggesting how the pattern is implemented. Note: This is a component property. It is saved when you save the diagram.
Semantics	Class OMT module: Container		Object Design phase only. Unrestricted text that provides a highlevel description of the meaning of the object.
Show Association Directions	All links Diagram	Yes No Default (default)	Controls the display of association direction indicators. An indicator is a small black arrow, following an association name, that shows the direction of the association. See Showing Property Values.
Show Association Navigation	All links Diagram	Yes No Default (default) Suppress Two-Way	Controls the display of the Navigability property. Note: This is a component property. It is saved when you save the diagram.
Show Changeability	All links Class Diagram OMT module: Container	Yes No Default (default)	For Class and Container objects, Object Design phase only. Controls the display of the Attribute Changeability, Changeability at Start, and Changeability at End properties. Note: This is a component property. It is saved when you save the diagram.
Show Parameter Kinds	Class Diagram OMT module: Container	Yes No Default (default)	For Class and Container objects, Object Design phase only. Controls the display of the Parameter Kind property. Note: This is a component property. It is saved when you save the diagram.
Show Qualifier Types	All links Diagram	Yes No Default (default)	Controls the display of the Data Type property. Note: This is a component property. It is saved when you save the diagram.
Show Query Operation	Class Diagram OMT module: Container	Yes No Default (default)	For Class and Container objects, Object Design phase only. Controls the display of the Is Query property. Note: This is a component property. It is saved when you save the diagram.
Show Visibility	Class Diagram OMT module: Container	Yes No Default (default)	For Class and Container objects, Object Design phase only. Controls the display of the Visibility property. Note: This is a component property. It is saved when you save the diagram.
Stereotype	Class	Enumeration Interface Type Typedef Utility	Refines the type of the class.
	Dependency	Bind Call Derived Friend Import Refine Trace	Refines the type of the dependency. Note: This is a component property. It is saved when you save the diagram.
Structure	Design Pattern		Text listing the class and collaboration diagrams that describe the structure of the pattern. It can describe where to find these diagrams. Note: This is a component property. It is saved when you save the diagram.
Type	Design Pattern	Class_Creational Class_Structural Class_Behavioral Object_Creational Object_Structural Object_Behavioral Architectural Analysis Design (Default) Idiom Conceptual Programming	Classifies the Design Pattern. Note: This is a component property. It is saved when you save the diagram.
Visibility	Attribute Role start Role end	Private Protected Public	Object Design phase only. Specifies the visibility of the attribute or relationship. Optionally, the UML suite displays this property value in the diagram using these indicators: - (private), # (protected), and + (public). See Showing Property Values.

COD properties

The following table lists the properties available in the collaboration diagram (COD). Unless otherwise indicated, the properties are available during the Analysis, System Design, and Object Design phases. Unless otherwise indicated, they are item properties, which are saved when you edit them.


Property	Object Type	Value	Description
Applicability	Design Pattern		Text descibing the situations in which the design pattern can be applied. Contains examples of poor designs that the pattern can address. Note: This is a component property. It is saved when you save the diagram.
Collaborations	Design Pattern		Text describing how the participants collaborate to carry out their responsibilities. Note: This is a component property. It is saved when you save the diagram.
Consequences	Design Pattern		Text describing how the pattern supports its objectives and the trade-offs and results of using the pattern. Note: This is a component property. It is saved when you save the diagram.
Doc	All objects Diagram		Unrestricted text about the diagram or object; for example, comments, implementation notes, or revision data.
Implementation	Design Pattern		Text describing the pitfalls, hints and techniques you should be aware of when implementing the pattern. Also describes any language specific issues. Note: This is a component property. It is saved when you save the diagram.
Intent	Design Pattern		A short statement describing what the design pattern does and what particular design issues or problems are addressed. Note: This is a component property. It is saved when you save the diagram.
Known As	Design Pattern		Brief text listing other well known names for the pattern, if any. Note: This is a component property. It is saved when you save the diagram.
Known Uses	Design Pattern		Text listing examples of the pattern found in real systems. Note: This is a component property. It is saved when you save the diagram.
Motivation	Design Pattern		Text describing a scenario that illustrates a design problem and how the design pattern solves the problem. Note: This is a component property. It is saved when you save the diagram.
Navigability	All links	Default (default) No-Way Forward Backward Two-Way	Indicates the directions in which you can navigate the association. Default indicates that this information should be derived from the presence of role names. Optionally, the UML suite displays this property in the diagram as an arrow at one or both ends of an association. See Showing Property Values. Note: This is a component property. It is saved when you save the diagram.
Participants	Design Pattern		Text listing the classes and/or objects participating in the design pattern and their responsibilities. Note: This is a component property. It is saved when you save the diagram.
Related Patterns	Design Pattern		Text describing other patterns closely related to this one. Note: This is a component property. It is saved when you save the diagram.
Sample Code	Design Pattern		Code fragments suggesting how the pattern is implemented. Note: This is a component property. It is saved when you save the diagram.
Show Association Navigation	All links Diagram	Yes No Default (default) Suppress Two-Way	Controls the display of the Navigability property. Note: This is a component property. It is saved when you save the diagram.
Stereotype	Role start Role end	Association Global Local Parameter Self	Refines the type of the link.
Structure	Design Pattern		Text listing the class and collaboration diagrams that describe the structure of the pattern. It can describe where to find these diagrams. Note: This is a component property. It is saved when you save the diagram.
Type	Design Pattern	Class_Creational Class_Structural Class_Behavioral Object_Creational Object_Structural Object_Behavioral Architectural Analysis Design (Default) Idiom Conceptual Programming	Classifies the Design Pattern. Note: This is a component property. It is saved when you save the diagram.

CPD properties

The following table lists the properties available in the component diagram (CPD). Unless otherwise indicated, the properties are available during the Analysis, System Design, and Object Design phases. Unless otherwise indicated, they are item properties, which are saved when you edit them.

DFD properties

Property	Object Type	Value	Description
Doc	Diagram and all objects		Unrestricted text about the diagram or object; for example, comments, implementation notes, or revision data.
Stereotype	Component	Document Executable File Library Table	Refines the type of the object. Note: This is a component property. It is saved when you save the diagram.
	Dependency	Becomes Call Copy Derived Friend Import Instance Metaclass Powertype Send	Refines the type of the dependency. Note: This is a component property. It is saved when you save the diagram.

OMT module. The following table lists the properties available in the data flow diagram (DFD). Unless otherwise indicated, the properties are available during the Analysis, System Design, and Object Design phases. Unless otherwise indicated, they are item properties, which are saved when you edit them.

DPD properties

Property	Object Type	Description
Doc	Diagram and all objects	Unrestricted text about the diagram or object; for example, comments, implementation notes, or revision data.
Data type	Data store Data flow Update flow	Data type of the information in the data store or on the flow.

The following table lists the properties available in the deployment diagram (DPD). Unless otherwise indicated, the properties are available during the Analysis, System Design, and Object Design phases. Unless otherwise indicated, they are item properties, which are saved when you edit them.

SD properties

Property	Object Type	Value	Description
Doc	Diagram and all objects		Unrestricted text about the diagram or object; for example, comments, implementation notes, or revision data.
Stereotype	Component Component Instance	Document Executable File Library Table	Refines the type of the object. Note: This is a component property. It is saved when you save the diagram.
	Dependency	Becomes Call Copy Derived Friend Import Instance Metaclass Powertype Send	Refines the type of the dependency. Note: This is a component property. It is saved when you save the diagram.

The following table lists the properties available in the sequence diagram (SD). Unless otherwise indicated, the properties are available during the Analysis, System Design, and Object Design phases. Unless otherwise indicated, they are item properties, which are saved when you edit them.

STD properties

Property	Object Type	Value	Description
Doc	Diagram and all objects		Unrestricted text about the diagram or object; for example, comments, implementation notes, or revision data.
Stereotype	Object Active Object Initiator	Boundary Control Entity	Refines the type of the object. Boundary -- an object with external I/O Entity -- a persistent object that survives the program execution Control -- any other type of object Note: This is a component property. It is saved when you save the diagram.

The following table lists the properties available in the statechart diagram (STD). Unless otherwise indicated, the properties are available during the Analysis, System Design, and Object Design phases. Unless otherwise indicated, they are item properties, which are saved when you edit them.

UCD properties

Property	Object Type	Description
Doc	Diagram and all objects	Unrestricted text about the diagram or object; for example, comments, implementation notes, or revision data.

The following table lists the properties available in the UCD. Unless otherwise indicated, the properties are available during the Analysis, System Design, and Object Design phases. Unless otherwise indicated, they are item properties, which are saved when you edit them.

Other Design Pattern Properties

Property	Object Type	value	Description
Actor type	Actor	System User (default)	Indicates that this actor represents another system or an end user.
Alternative course of action	Use case		Unrestricted text that describes variants on the basic course of action for the use case; for example, the sequence of transactions in case of an error.
Basic course of action	Use case		Unrestricted text that describes the most common or important sequence of transactions for the use case.
Classification	Use case	Primary (default) Secondary	Indicates whether this use case represents the basic course of action (primary) or an alternative course of action (secondary).
Doc	Diagram and all objects		Unrestricted text about the diagram or object; for example, comments, implementation notes, or revision data.
Initiator	Actor	True False (default)	Indicates whether this actor initiates the use case (true), or not (false). Note: This is a component property. It is saved when you save the diagram.
Precondition	Use case		Unrestricted text that describes the conditions that must be met before the use case can be performed.
Postcondition	Use case		Unrestricted text that describes the state of the system after the use case is performed.
Stereotype	Use case generalization	Extends Uses	Refines the type generalization. Note: This is a component property. It is saved when you save the diagram.

The following table lists the properties available on Design Patterns when the Essential Properties for Design Patterns customization module is active. These properties replace the current Design Pattern properties..


Property	Object Type	Value	Description
Context/ Preconditions	Design Pattern		Text describing the preconditions under which the problem and its solution seem to recur, and for which the solution is desirable. Note: This is a component property. It is saved when you save the diagram.
Examples	Design Pattern		One or more sample sets of code for the pattern which illustrate a specific intial context, how the pattern is applied to the context, and the resulting context left in its wake. Note: This is a component property. It is saved when you save the diagram.
Forces	Design Pattern		Text describing the relevant forces and constraints and how they interact/conflict with one another and with the goals you wish to achieve. Forces reveal the intricacies of a problem and define the kinds of trade-offs that must be considered. Note: This is a component property. It is saved when you save the diagram.
Justification	Design Pattern		Text justifiying the steps or rules in the pattern and of the pattern as a whole in terms of how and why it resolves its forces in a particular way. Note: This is a component property. It is saved when you save the diagram.
Known Uses	Design Pattern		Examples of the pattern found in real systems. Note: This is a component property. It is saved when you save the diagram.
Overview	Design Pattern		Brief text describing what the design pattern does and what particular design issues or problems it addresses. Note: This is a component property. It is saved when you save the diagram.
Problem Statement	Design Pattern		A statement of the problem which describes its intent: the goals and objectives it wants to reach within the given context and forces. Note: This is a component property. It is saved when you save the diagram.
Reference Source	Design Pattern	GoF (default)	Text listing the source of the pattern, such as a particular book. Note: This is a component property. It is saved when you save the diagram.
Related Patterns	Design Pattern		Text describing other patterns closely related to this one. Note: This is a component property. It is saved when you save the diagram.
Resulting Context/Resolution	Design Pattern		Text describing the state or configuration of the system after the pattern has been applied. It also describes postconditions and side-effects of the pattern. Note: This is a component property. It is saved when you save the diagram.
Solution	Design Pattern		Static relationships and dyamic rules describing how to realize the desired outcome. References to Class, Sequence, or Collaboration Diagrams can be helpful. Note: This is a component property. It is saved when you save the diagram.
Type	Design Pattern	Architectural Analysis Design (Default) Idiom Conceptual Programming	Classifies the Design Pattern. Note: This is a component property. It is saved when you save the diagram.

Object properties

The following table lists the properties available on objects other than diagrams, items, and components.

Property	Description	Object Type
Doc	Unrestricted text about the object; for example, comments, implementation notes, or revision data.	Corporate Project Configuration version Phase version System version Customization file version External file version External link Diagram (graph) file version CDM version (matrix) System file reference
File System Path Part	Destination directory for generated files.	Corporate Project Configuration version Phase version System version External file version