About the Entity Relationship Diagrammer

Related Topics

The Entity Relationship Diagrammer is a modeling tool used for defining the information needs of a business as an entity relationship model.

Entity relationship modeling involves identifying the things of importance in an organization (entities), the properties of those things (attributes) and how they are related to one another (relationships).  The resulting information model is independent of any data storage or access method.

Large Entity Relationship Diagrams can be drawn for entire complex systems, or smaller diagrams drawn for subsets of systems. One entity can appear in numerous diagrams, enabling many detailed subset models to be defined.

The Entity Relationship Diagrammer provides:

•	a diagramming tool for creating Entity Relationship Diagrams, including support for the logical design of data warehouses

•	access to a multi-user repository for creating and maintaining definitions of entities and relationships

•	access to the Database Design Transformer, which automates some of the tasks of system development by deriving a default database design from Entity Relationship Diagrams

•	autolayout facilities for automating the improvement of the diagram layout

•	access to other related Oracle Designer tools, including the Repository Reports tool, which provides reports for validating Entity Relationship Diagrams, and the Matrix Diagrammer, which can be used for cross-referencing repository elements to verify your model


When to use the Entity Relationship Diagrammer
Modeling entities: a quick guide

Related Topics

Any application that you develop will store and manipulate information, so an essential part of developing a system is constructing an accurate model of the information needs of an organization. The Entity Relationship Diagrammer enables you to create an information model in the form of a diagram showing the elements of information and the way they are logically related. The information model will act as a framework for the development of new or enhanced systems.

For wide-scale developments, an information model can be drawn showing the data used throughout a business. An "enterprise-wide data model" such as this is commonly used by large organizations to help them establish strategic plans for their information systems.

An information model is displayed as an Entity Relationship Diagram containing entities (for example, for a video rental enterprise, RENTAL and COPY) and relationships (the lines joining the entities). It is also possible to show attributes (for example, Rental Period) and other features.

You can use the Entity Relationship Diagrammer to define logical data warehouse models. Each entity must be identified as either a fact or a dimension.

A function model can be developed at the same time as an information model, but it is advisable to wait until both are nearly complete before trying to relate functions to data.

Information modeling involves the following stages, which can be performed iteratively until you are satisfied with the description of your data:

Identifying entities

Establishing relationships

Entering attributes

Defining domains

Establishing unique identifiers

Performing quality checks

The Entity Relationship Diagram that results from the above operations can be translated into a relational database design during the design stage of your systems development. The Database Design Transformer, accessed from the Entity Relationship Diagrammer, creates table mappings and detailed mappings to automate the mapping of your analysis definitions.


Identifying entities

Related Topics

Entities are things of significance to a business about which the system you are developing will need to hold information.

Identifying the entities in an information model requires a thorough understanding of the business needs, which may come from interviewing potential users of the system, from studying reports, or from experience of the existing operation.

Which tools to use

An Entity Relationship Diagram and its integral entities can be created using the Entity Relationship Diagrammer. A prerequisite for creating a diagram is that a container exists in the repository. If a container does not exist, a container can be created to represent it using the Repository Object Navigator. In addition to the Entity Relationship Diagrammer, entities can also be defined using either the Repository Object Navigator or the Matrix Diagrammer.

What you do

Identifying possible entities entails reading through any available notes and sketches and looking for the names of things of significance (nouns).

Each entity must be given a meaningful name, as well as a short name to enable easy identification. If you do not specify a short name, the Entity Relationship Diagrammer will generate one by abbreviating the entity name.

You can either enter all the entities into your diagram and then establish relationships between them, or work on groups of entities, establishing their relationships as you progress. Establishing Relationships includes information on how to establish relationships between entities.

Some entities may have sub-types. For example, the entity COMPANY might have a sub-type of SUPPLIER. All suppliers are companies, but not all companies are suppliers; and anything that we know about companies (for example, the telephone number), we know about all suppliers. For completeness, you should normally have at least two sub-types in each super-type. In this example, any COMPANY that wasn't a SUPPLIER would be an OTHER COMPANY sub-type.

To make sure that the information model is complete, you should ensure that, for each entity, you enter the complete details of:

•	the initial number of occurrences of this entity

•	the maximum number of occurrences of this entity

•	the average number of occurrences of this entity

•	the growth rate

•	alternative names for the entity: synonyms

Attention can be drawn to specific entities or sections of a diagram by using different colors or fonts, and several diagrams can be created to cover the information model. For example, you could have one diagram showing all the entities, and additional diagrams for each area of data.

The layout of the whole diagram or of selected elements can be changed using the autolayout utility. Each time the autolayout utility is run, a different layout of elements is displayed. The process can be repeated as many times as you require.

The Database Design Transformer uses entities as the basis for table definitions in your database design. The Server Generator can then use these definitions to create the actual tables in your physical database.

When you have created entities, it is necessary to establish the relationships that exist between them, and the attributes that qualify them.


Establishing entity relationships

Related Topics

Relationships are named significant associations between two entities, and can be established for existing entities only.  About

Relationships can be identified by considering how entities are associated. For example, it may be that "we can obtain the same title from different suppliers". This indicates that there is a relationship between the entity TITLE and the entity SUPPLIER. The logic of the statement also indicates that it is a many-to-many relationship.

Which tools to use

Relationships can be defined or updated using the Repository Object Navigator, but the easier and recommended tool is the Entity Relationship Diagrammer.

What you do

Relationships can be of many types, but the majority will be one-to-many. The optionality and degree of each relationship end also need to be identified.

If there are relationships between an entity and itself, this is indicated on the Entity Relationship Diagram by a recursive relationship (pig's ear).

Arcs can be created to signify that relationship ends are mutually exclusive, implying that only one of those relationships can refer to a particular instance of the entity.

To make sure that the information model is complete, you should ensure that, for each relationship end, you specify:

•	whether it is transferable

•	a logical name

•	the maximum, minimum and average number of occurrences of the entity that is involved

•	for 'many' relationship ends, what the maximum and minimum occurrences of the entity in any one relationship are

The layout of the relationships can be changed using the autolayout utility.

When you have established relationships, the Entity Relationship Diagram will show how the significant data elements are logically associated. These relationships will affect the design of the system and of the database.

The Database Design Transformer uses relationships as the basis for defining foreign key columns in the database design.


Entering entity attributes

Related Topics

Attributes can be identified by considering the details that describe entities. For instance, it may be that "we give every supplier a unique number". This indicates that there is an attribute ("unique number") for the entity SUPPLIER and tells us that the attribute is mandatory, because every supplier has one.  About

Which tools to use

Attributes can be created in either the Entity Relationship Diagrammer or the Repository Object Navigator.

What you do

Attributes are the lowest level of data definition included in the information model, and they need a lot of detail about them, such as name, type, length, and default values. Comprehensive information is important for later tasks in the development of your system.

Each attribute must be given a name, which must be unique for that entity. The optionality of the attribute should also be specified. It is recommended that each entity has at least two attributes.

For Oracle Designer, attributes should not be created as a pointer to another entity: a relationship should be defined instead. An attribute should also not be created for something that can take multiple values, because this should be represented as an entity and a relationship.

To make sure that the information model is complete, you should examine each entity to make sure that you have all the attributes, and ensure that, for each attribute, you specify:

•	details of any domain that you could use

•	the correct optionality

•	for optional attributes, the number of occurrences that have values, initially and on average

•	both maximum and average length

•	a default (initial) value, if none is provided on creation (important for mandatory attributes)

•	allowable values

The Database Design Transformer uses attributes as the basis for column definitions in creating a default database design from an information model. The Server Generator then uses these definitions to create the actual columns in the physical database.


Defining domains

Related Topics

A domain is a set of business validation rules, format constraints, and other properties that apply to a group of attributes. For example, a list of values, a range, a qualified list or range, or any combination of these. Attributes and columns in the same domain are subject to a common set of validation checks. Useful domains are those things that never or rarely change, such as days of the week, currency values and yes/no values.

Domains can be defined before entities and attributes are created.

Which tools to use

Domains can be defined or updated using either the Entity Relationship Diagrammer or the Repository Object Navigator.

You may find it useful, at the same time as you are drawing a diagram in the Entity Relationship Diagrammer, to have a Repository Object Navigator window open, showing the Properties Palette for domains.

What you do

To make sure that the information model is complete, you should ensure that, for each domain, you specify:

•	name

•	format

•	datatype

•	length

•	valid values

•	null value

•	default initial value

When a domain has been created, values of attributes can be specified quickly by selecting from the domain. A domain can also be used as a "short-cut" when creating column definitions in the database design.

The Oracle Designer Generators use domain values when generating applications.


Establishing unique identifiers

Related Topics

A unique identifier is a combination of attributes and/or relationships that uniquely identifies an occurrence of an entity. One of the unique identifiers for each entity must be specified as that entity's primary unique identifier.

Which tools to use

Unique identifiers can be defined in either the Entity Relationship Diagrammer or the Repository Object Navigator.

It is recommended that the Entity Relationship Diagrammer is used for defining new unique identifiers, and the Repository Object Navigator for adding the finer details when refining a system.

What you do

The unique identifiers for each entity in an information model can come from a number of different sources:

•	one or more attributes

•	one or more relationships

•	a combination of attributes and relationships

One entity can have several unique identifiers, but one must be specified as the primary unique identifier. It is advisable to keep the primary unique identifier short because this will be used frequently when developing your system.

The Database Design Transformer uses each primary unique identifier as the basis for creating a primary key for a table definition.


Performing quality checks

Related Topics

When you have fully defined your information model, quality checks should be carried out to check the quality and validity of your information.

You may also want to "resolve" each many-to-many relationship into two one-to-many relationships with a new intersection entity. Alternatively you could leave them as many-to-many relationships and allow the Database Design Transformer to create intersection tables.

Which tools to use

Quality checks can be carried out using the reports available in Repository Reports.

Inconsistent or incorrect details on the Entity Relationship Diagram can then be modified using either the Entity Relationship Diagrammer or the Repository Object Navigator.

What you do

When performing quality checks, you may want to check the following in the information model.

For each entity:

•	Does the name accurately describe the data?

•	Are there any synonyms for this entity?

•	How many occurrences are there?

•	What is the growth rate?

•	Are there any sub-types?

•	Are there any other unique identifiers for this entity?

•	Which unique identifier is the primary identifier?

For each relationship:

•	Can you read the relationship from one entity to the other?

•	Is the relationship transferable?

•	Are you really sure of the optionality of the relationship end?

•	Have you resolved many-to-many relationships wherever feasible?

For each attribute:

•	Does it have a logical name?

•	Is there a domain that you can use?

•	Is the attribute really optional?

For the Entity Relationship Diagram:

•	Is it presentable, with legible elements and few crossing lines?

•	Can you argue that the diagram reflects the business area accurately?

•	Could you use it to describe the data to a user?


Autolayout on Entity Relationship Diagrams

Related Topics

Autolayout is a utility that allows you to change the layout of the elements on a diagram without having to move them manually.

How does Autolayout work?

All the elements on a diagram do not have to be automatically laid out each time the utility is run. If elements are selected on a diagram, only those elements are automatically laid out.

Each time the utility is run on a diagram or on selected elements on a diagram (by selecting Layout→Autolayout) a different layout of elements is displayed. The process can be repeated as many times as you require.

Elements on a diagram can also be automatically laid out into a specified area. This area is displayed by selecting Options→Customize and then checking the Show Layout Area checkbox on the Customize dialog box.

For example:

If you display several layouts consecutively using the Autolayout utility, you can redisplay your preferred layout by selecting Layout→Previous Layout until the required layout is restored on the diagram.

Both Autolayout and Previous Layout are also available on the standard toolbar.

 Autolayout toolbar button

 Previous Layout toolbar button

Note:	Previous layouts cannot be restored using Edit→Undo.

When should I use Autolayout?

If a diagram is constructed of elements included from the repository, the default positions of these elements may not be satisfactory. The Autolayout utility allows you to rearrange these elements into a more suitable layout with the minimum of effort.

For example:

A number of elements are included from the repository.

•

Autolayout is used to rearrange the elements.

•


Entity Relationship Diagram elements and notation

Related Topics

The appearance of the elements on a diagram can be altered by changing the graphical preferences for either selected elements, or all elements of a specified element type. You can also define whether you want to show or hide the properties of elements on a diagram.

The following information can be represented on Entity Relationship Diagrams:

Entities

Attributes

Relationships (including recursive relationships and arcs)

Domains


Entities

Related Topics

An entity is a thing of significance, whether real or conceptual, about which the business or system being modeled needs to hold information.

Entities are displayed as boxes on a diagram, and can display details such as attributes.

Entities can be described as being in a hierarchy, with children inheriting properties from their parents. Parent entities are called super-types, and child entities are called sub-types.

Super-types

A super-type is a means of classifying an entity that has sub-types. Super-types surround sub-types on a diagram. A super-type can also be a sub-type if it is, in turn, surrounded by another entity.

Sub-types

An entity can be split into two or more sub-types, each of which has common attributes and/or relationships that are explicitly defined once only at the higher level. Sub-types can have attributes, relationships and/or sub-types of their own.


Entity attributes

Related Topics

An attribute is any detail that serves to qualify, identify, classify, quantify or express the state of an entity.

Note:	Each occurrence of an entity can have only one value for each attribute at any one time.

The types of the attributes that are displayed on an entity are indicated by the symbol displayed to the left of the attribute name.

Symbol	Description
#	Unique Identifier (UID) A combination of attributes and/or relationships that serves to identify uniquely an occurrence of an entity.
*	Mandatory Attribute
o	Optional Attribute

Domains are sets of business validation rules, format constraints and other properties that apply to a group of attributes.

Example:	A list of values, a range, a qualified list or range, or any combination of these are all domains. Attributes and columns in the same domain are subject to a common set of validation checks.


Entity relationships

Related Topics

The properties of a relationship determine the optionality and cardinality of both ends of the relationship and also the names of those relationship ends. The "many" end of a many-to-one relationship is normally shown at the upper or left side of a relationship. A relationship that goes to and from the same entity is called a recursive relationship (pig's ear).

Relationships on an Entity Relationship Diagram display graphical indications of the optionality and cardinality of the relationship ends.

Optionality

Defines whether this end of the relationship is optional or mandatory:

	Optional: for example, "Each PRICE LIST ITEM may be on a PRICE LIST"
	Mandatory: for example, "Each PRICE LIST ITEM must be on a PRICE LIST"
Cardinality

Defines whether the other end of the relationship is single or multiple:

	Single: for example, "Each PRICE LIST must be comprised of one and only one PRICE LIST ITEM"
	Multiple: for example, "Each PRICE LIST must be comprised of one or more PRICE LIST ITEMS"
Note:	The cardinality of both ends of the relationship are also known as, and defined in the Repository Object Navigator as, the Minimum and Maximum Cardinality. The Minimum and Maximum Cardinality express the number of entities possible at the other end (destination) of the relationship. A zero indicates that the source end of the relationship is optional.

Dog-legs

On an Entity Relationship Diagram, an angled joint in a relationship is known as a dog-leg. Dog-legs are often found on large diagrams where relationships must be routed around other items.

Example:

Transferable relationship

The transferability symbol on a relationship end defines whether that relationship end can be disconnected from the current entity and reconnected to another entity. A relationship end is created as transferable by default.

If a relationship end is non-transferable it cannot be disconnected from the current entity and reconnected to another entity. Non-transferable relationship ends are marked with a diamond ( [image]).

The transferability of a relationship end is defined in the Edit Relationship dialog box.

UID relationship

To show that a relationship is (part of) the UID, a "crossbar" may be drawn across the relationship close to the entity for which the UID is established.

The "crossbar" indicates that the UID of the entity at the 'single' end of the relationship is being used to uniquely identify the entity at the 'multiple' end of the relationship.

Entity relationship arcs

On an Entity Relationship Diagram, an arc is a curved line used to identify two or more mutually exclusive relationship ends.

No relationship end can be a member of more than one arc. A circle indicates the intersection between the arc and the relationship end.

An arc should contain at least two relationship ends. All relationship ends must be from the same entity, and of the same optionality.

Note:	To remove a relationship from an Entity Relationship Diagram you must select both the relationship and the arc.


Domains

Related Topics

A domain is a set of validation rules, format constraints and other properties that applies to a group of attributes, columns, program data constructs, parameters or datastructures. For example, before entering attribute details, it is useful to define any domains that have been identified, such as Name and Address. When an attribute has been defined, a domain can be specified that will apply to it.


Recursive Relationship (Pig's Ears)
Recursive relationships (Pig's Ears)

Related Topics

When a relationship represents a link that goes to and from the same entity, it is represented as a recursive relationship or 'pig's ear'.

The only recursive relationships that can logically exist on an Entity Relationship Diagram are:

•	many-to-many (optional to optional) relationships

•	many-to-one (optional to optional) relationships

•	one-to-one (optional to optional) relationships

Other types of recursive relationships would not be logical because they would either represent an infinite loop or a combination of relationship conditions that would never be found in the real world.


File - New
   New (File Menu)

Related Topics

Creates a new untitled Entity Relationship Diagram in a chosen container. The container you specify determines both the container in which the diagram will be created and the initial container within which individual elements created on the diagram will be placed.

Dialog box options

Container list

Lists the containers visible to the workarea, in which you can create the new Entity Relationship Diagram.

The dropdown list shows a record of the containers you have most recently used. If this list is empty, click the button to the right of the dropdown list to choose a container. Alternatively, create a new container.  How


Edit - Include Entity
Include→Entity (Edit Menu)

Related Topics

Includes on the diagram any entities, and optionally the relationships between them, which exist in the repository, but which are not displayed on the active diagram. Entities are automatically laid out on the diagram according to one of the autolayout options specified in the Include Entity dialog box.

When you include entities, the attributes that describe them will also be included. Whether or not these attributes are displayed on the diagram is determined by the view options in the Customize dialog box.

Dialog box options

List box

Displays the entities and their supertypes that are visible to the workarea. The entities are grouped by owning container.

Note, an icon is displayed next to each entity in the list. The icon is dimmed for entities that are already displayed on the diagram.

Select All

Selects all the entities shown in the list box for inclusion on the diagram.

With Relationships

Determines whether or not relationships are included with the included entities.

Autolayout to

Contains options for automatically laying out elements on a diagram.

Whole diagram

Positions the selected elements within the whole diagram area. This is the default option.

This operation can also be performed by selecting Layout→Autolayout.

New area

Places the selected elements within a new autolayout area which you define on the diagram. The autolayout area must be large enough to contain all the elements.

This operation can also be performed by selecting Layout→Autolayout to New Area.

The Show Layout Area preference, which is set in the Customize dialog box, determines whether or not the current autolayout area is displayed.

Same area

Places the selected elements within an existing autolayout area on the diagram.

This operation can also be performed by selecting Layout→Autolayout to Same Area.

The Show Layout Area preference, which is set in the Customize dialog box, determines whether or not the current autolayout area is displayed.


Include Related Entities dialog box

Related Topics

Lists the related entities that can be included on the active diagram for the currently selected entity.

Dialog box options

List box

Displays the entities that have a relationship with the entity currently selected on the diagram and which are not currently displayed on the diagram.

Select All

Selects all the elements shown in the list box for inclusion on the diagram.


Edit - Include - Relationship
Include→Relationship (Edit Menu)

Related Topics

Includes relationships which link between entities displayed on the diagram.

This option displays the Include Relationship dialog box listing all those relationships which link entities on the diagram, but which are not themselves currently displayed. The entities at both ends of a relationship must be displayed on the diagram for the relationship to be listed.

Relationships can also be included on a diagram when you include entities by checking the With Relationships checkbox in the Include Entity dialog box.

Dialog box options

List box

Displays the relationships which can be included between entities on the diagram.

Select All

Selects all the relationships shown in the list box for inclusion on the diagram.


Edit - Domains
Domains (Edit Menu)

Related Topics

Allows you to view and maintain the details of any domain visible to the workarea. The Edit Domains dialog box is displayed when you choose this menu option.


Customize dialog box

Related Topics

Enables you to change diagrammer preferences.

Elements

This group of fields defines the details of how elements are displayed on the diagram.

Type

Specifies the type of diagram item to which these details apply.

If no items are already selected when you display this dialog box, any changes you make apply to all future items of the specified type.

If one or more diagram items are already selected when you display this dialog box, this field displays "Selected Objects". In this case, any changes you make apply only to the selected items, which may be of different types (except changes to the display of attributes, which apply to all attributes on the diagram).

Font

Specifies the font used to display text on entities and relationships. Selecting this field displays the Font dialog box to specify the font details.

Secondary Font

Specifies the font used to display attribute text. Selecting this field displays the Font dialog box to specify the font details.

Color

Controls the colors of diagram elements.

Fill

Controls the fill color. Selecting this field displays the Color dialog box to specify a fill color.

Line

Controls the line color. Selecting this field displays the Color dialog box to specify a line color.

Line Width

Controls the line thickness of elements. You can either specify a number from 1 (thinnest) to 10 (thickest) in the first field, or you can select the second field to display the Line Width dialog box displaying a choice of ten different line widths. Changes to the line width of relationships on Entity Relationship Diagrams do not show under Windows 95.

Requery On Open checkbox

Defines whether or not the elements on the diagram are automatically consolidated with those held in the repository when the diagram is opened. Check this box if you want diagrams to be automatically consolidated when they are opened.

View

Controls the display of element details on the diagram.

Relationship Names checkbox

Defines whether or not any relationship names on the diagram are displayed.

Relationship Primary UID checkbox

Defines whether or not any primary unique identifiers on the diagram are displayed.

Relationship Transferability checkbox

Defines whether or not any transferability symbols on the diagram are displayed.

Attributes checkbox

Defines whether or not any attributes on the diagram are displayed.

Container Display

Specifies the level of detail to which container names are displayed on Entity Relationship Diagram elements. The available options are:

None	Container names are not shown on diagram elements.
Name	Displays the name of the container in which the element exists next to the element name.
Path	Displays the name of the container in which the element exists, and owning containers, next to the element name. This option is useful if your designs contain nested containers.
Autolayout

Controls the size of the elements on the diagram.

Minimum Entity Width (cells)

Defines, in grid cells, the default width for new entities, and the minimum width that an autolayout operation will resize entities to.

Minimum Entity Height (cells)

Defines, in grid cells, the default height for new entities, and the minimum height that an autolayout operation will resize entities to.

Show Layout Area checkbox

Determines whether or not the autolayout area is displayed.

Grid

Controls the display and definition of the grid.

Cell Size

Defines the size of the grid cells on the diagram.

The value that is specified in this field (in the range of 10 to 100) changes both the height and width of the grid cells. One unit is equal to 0.01 inches on a diagram displayed at its original size.

Snap

Defines whether or not elements are snapped to the lines of the grid.

Display

Defines whether or not the grid is displayed on the diagram.

Attributes

Determines which attributes are displayed on the diagram.

Note:	Attributes are displayed on the diagram only if the Attributes checkbox is checked.

All

All attributes are displayed on the diagram.

Primary UID

Only those attributes which are primary unique identifiers are displayed on the diagram.

Mandatory

Only those attributes which are mandatory are displayed on the diagram.

OK

If items are selected on the diagram, this button applies the changes in the dialog box to those items and closes the dialog box.

Note:	This button does not save the changes with the diagrammer. If you subsequently create a new diagram in a different invocation of the diagrammer, these changes do not apply; the system uses the last set of values to be saved. Changes can be saved using the Save button.

This button allows you to try out the effect of changes on a diagram without making those changes permanent.

Cancel

Discards any changes you make in the dialog box and returns you to the active diagram.

Restore

Changes all the settings in the dialog box back to the last set of saved values. These values are stored in the Registry.

Save

Saves any changes you make in the dialog box and returns you to the active diagram.

Help

Displays help information about the dialog box.


Utilities - Create Arc
   Create Arc (Utilities Menu)

Related Topics

Creates an arc to signify that the currently selected relationship ends are mutually exclusive.

An arc should contain at least two relationship ends. All the relationship ends must be from the same entity, and of the same optionality.

No relationship end can be in more than one arc.

A small circle on the arc indicates the intersection between the arc and relationship end.


Utilities - Add to Arc
   Add to Arc (Utilities Menu)

Related Topics

Adds the selected relationship end to the currently selected arc. You must select the arc to which you want to add a relationship before you can use this option.

An arc should contain at least two relationship ends. All the relationship ends must be from the same entity, and of the same optionality.

No relationship end can be in more than one arc.

A small circle on the arc indicates the intersection between the arc and relationship end.

Relationship ends can be removed from existing arcs using Utilities→Remove from Arc.


Utilities - Remove from Arc
   Remove from Arc (Utilities Menu)

Related Topics

Removes the selected relationship end from the currently selected arc. You must select the arc and the relationship that you want to remove before you can use this option.

Relationship ends can be added to existing arcs using Utilities→Add to Arc.


   Entity button

Related Topics

Creates a new entity on the active diagram. This button displays the Create Entity dialog box, enabling you to enter a name, short name and plural name for the entity. You can specify the container in which an entity is created using the Container list on the main toolbar.

The details for the entity can be changed in the Edit Entity dialog box, which is displayed either by double-clicking on the required entity, or by selecting the entity and then selecting Edit→Properties.


Create Entity dialog box

Related Topics

Specifies the name, short name and plural name of the new entity you are creating.

Note:	You can specify the container in which the entity is created using the Container list on the main toolbar.

Name

Mandatory, 40 characters

The name of the new entity.

Short Name

Optional, 10 characters

The short name of the new entity. If you do not enter a short name this field will default to a shortened version of the entity name.

Plural

Optional, 40 characters

The plural name of the new entity.


Create Relationship dialog box

Related Topics

Specifies the name for each end of the relationship.

From Name

Mandatory, 60 characters

The name of the first end of the relationship.

To Name

Mandatory, 60 characters

The name of the second end of the relationship.


   M:1 (Optional to Mandatory) Relationship button

Related Topics

Creates a Many-to-One (Optional to Mandatory) relationship between two entities. This button displays the Create Relationship dialog box, enabling you to enter the name of each end of the relationship.

The details for the relationship can be changed in the Edit Relationship dialog box, which is displayed either by double-clicking on the required relationship, or by selecting the relationship and then selecting Edit→Properties.

Note:	Dog-legs can be inserted into a relationship.


   M:1 (Optional to Optional) Relationship button

Related Topics

Creates a Many-to-One (Optional to Optional) relationship between two entities. This button displays the Create Relationship dialog box, enabling you to enter the name of each end of the relationship.

The details for the relationship can be changed in the Edit Relationship dialog box, which is displayed either by double-clicking on the required relationship, or by selecting the relationship and then selecting Edit→Properties.

Note:	Dog-legs can be inserted into a relationship.


   M:1 (Mandatory to Optional) Relationship button

Related Topics

Creates a Many-to-One (Mandatory to Optional) relationship between two entities. This button displays the Create Relationship dialog box, enabling you to enter the name of each end of the relationship.

The details for the relationship can be changed in the Edit Relationship dialog box, which is displayed either by double-clicking on the required relationship, or by selecting the relationship and then selecting Edit→Properties.

Note:	Dog-legs can be inserted into a relationship.

Example:	A diagram contains two entities PRICE LIST and PRICE LIST ITEM with a relationship between them such that a PRICE LIST ITEM must be on one PRICE LIST and a PRICE LIST may be comprised of many PRICE LIST ITEMS.


   M:1 (Mandatory to Mandatory) Relationship button

Related Topics

Creates a Many-to-One (Mandatory to Mandatory) relationship between two entities. This button displays the Create Relationship dialog box, enabling you to enter the name of each end of the relationship.

The details for the relationship can be changed in the Edit Relationship dialog box, which is displayed either by double-clicking on the required relationship, or by selecting the relationship and then selecting Edit→Properties.

Note:	Dog-legs can be inserted into a relationship.


   M:M (Optional to Optional) Relationship button

Related Topics

Creates a Many-to-Many (Optional to Optional) relationship between two entities. This button displays the Create Relationship dialog box, enabling you to enter the name of each end of the relationship.

The details for the relationship can be changed in the Edit Relationship dialog box, which is displayed either by double-clicking on the required relationship, or by selecting the relationship and then selecting Edit→Properties.

Note:	Dog-legs can be inserted into a relationship.


   M:M (Mandatory to Optional) Relationship button

Related Topics

Creates a Many-to-Many (Mandatory to Optional) relationship between two entities. This button displays the Create Relationship dialog box, enabling you to enter the name of each end of the relationship.

The details for the relationship can be changed in the Edit Relationship dialog box, which is displayed either by double-clicking on the required relationship, or by selecting the relationship and then selecting Edit→Properties.

Note:	Dog-legs can be inserted into a relationship.


   1:1 (Mandatory to Optional) Relationship button

Related Topics

Creates a One-to-One 'Mandatory to Optional' relationship between two entities. This toolbar button displays the Create Relationship dialog box, enabling you to enter the name of each end of the relationship.

The details for the relationship can be changed in the Edit Relationship dialog box, which is displayed either by double-clicking on the required relationship, or by selecting the relationship and then selecting Edit→Properties.

Note:	Dog-legs can be inserted into a relationship.


   1:1 (Optional to Optional) Relationship button

Related Topics

Creates a One-to-One (Optional to Optional) relationship between two entities. This button displays the Create Relationship dialog box, enabling you to enter the name of each end of the relationship.

The details for the relationship can be changed in the Edit Relationship dialog box, which is displayed either by double-clicking on the required relationship, or by selecting the relationship and then selecting Edit→Properties.


   1:1 (Mandatory to Mandatory) Relationship button

Related Topics

Creates a One-to-One (Mandatory to Mandatory) relationship between two entities. This button displays the Create Relationship dialog box, enabling you to enter the name of each end of the relationship.

The details for the relationship can be changed in the Edit Relationship dialog box, which is displayed either by double-clicking on the required relationship, or by selecting the relationship and then selecting Edit→Properties.


Edit Entity Dialog Box

Related Topics

Used to modify the details of an entity.

Initially this information may be incomplete because some attributes may not be known. Later, comprehensive definitions are established, and this dialog box is used to update the entities and attributes.

Definition

Synonyms

UIDs

Attributes

Att Detail

Att Values

Text


Edit Entity - Definition

Related Topics

Defines the mandatory and most frequently used details of the entity.

Short Name

10 characters
An abbreviation of the entity name, used when referencing the entity in other dialog boxes. If a short name is not defined when the entity is created, the system generates one.

Note:	Up to 10 characters can be entered in this field but it is advisable to keep the name as short as possible. A maximum of 7 characters is recommended.

The short name is also used when intersection tables are generated for "many-to-many" relationships during default database design. Where a table alias has not been defined for a table, the short name for the entity being implemented is used by default.

Name

40 characters
The full name of the entity; that is, the name that appears in the box on the Entity Relationship Diagram. This name is defined when the entity is created.

Any characters, including spaces, can be used to construct a meaningful name. The name should be in the singular form.

Note:	Editing the name of the entity does cause the Plural name to be automatically updated too.

Plural

40 characters
The plural form of the entity name. If a plural is not defined when the entity is created, the system generates one.

Type Of

Display only
The super-type entity of the current entity, if one exists.

Volume

This group of fields allows you to define details about the number of occurrences and the growth rate for the entity. This data will eventually be used in the algorithm for the sizing estimate.

Initial

Optional, 38 integers
The initial number of occurrences for the entity.

Maximum

Optional, 38 integers
The maximum number of occurrences expected for the entity.

Average

Optional, 38 integers
The average number of occurrences expected for the entity.

Growth Rate

Optional, 3 integers
The expected annual growth rate (percentage) for the entity.

Datawarehouse Type

Identifies whether the entity is used for datawarehousing purposes and, if it is, whether it is to be classified as a Dimension or a Fact.

Note:	This property is applicable only if the entity is within a data warehouse application system. Use the Datawarehouse property on the application system to see if datawarehousing is applicable.

OK

Saves any changes you may have made and closes the dialog box.

Cancel

Cancels the dialog box without saving any changes you may have made.

Apply

Saves any changes you may have made without closing the dialog box.

Help

Displays help information about the current tab in the dialog box.


Edit Entity - Synonyms

Related Topics

Allows you to define synonyms for the current entity. These synonyms will be treated as alternative names for the entity.

Synonyms spreadtable

This spreadtable shows all the synonyms defined for the current entity, and allows you to define new ones or delete existing ones.

Synonym Name

40 characters
An alternative name for the entity. A synonym cannot be the name of another entity within the same container; however, it can be used as an entity name in a different container.

Insert Row

Inserts a new blank row in the spreadtable immediately preceding the currently selected row. A new row can also be inserted at any position in the spreadtable by simply clicking on an empty row.

Delete Row

Deletes any currently selected rows from the spreadtable.

OK

Saves any changes you may have made and closes the dialog box.

Cancel

Cancels the dialog box without saving any changes you may have made.

Apply

Saves any changes you may have made without closing the dialog box.

Help

Displays help information about the current tab in the dialog box.


Edit Entity - UIDs

Related Topics

Used to enter or change details of the unique identifiers (UIDs) for the entity. An entity can be uniquely identified by one or more of its attributes, one or more of its relationships to other entities, or a combination of both.

The attributes and relationships used in this tab must already exist for the entity.

Unique Identifiers spreadtable

This spreadtable shows all the UIDs defined for the current entity, and allows you to define new ones or delete existing ones.

Name

The name of the UID you are creating or modifying. The name is initially generated automatically, but can be overtyped.

Primary?

When checked, indicates that the UID is the primary identifier.

Insert UID

Inserts a new blank row in the UID spreadtable immediately preceding the currently selected row. A new row can also be inserted at any position in the spreadtable by simply clicking on an empty row.

Delete UID

Deletes any currently selected rows from the UID spreadtable.

Reset Default

Sets the UID information according to the properties of the attributes on other tabs.

Candidate Attributes

Display only
Lists all attributes for the current entity. You can include one or more of these attributes in the UID by moving them to the Unique Identifier Contents field.

Candidate Relationships

Display only
Lists all relationships for the current entity. You can include one or more of these relationships in the UID by moving them to the Unique Identifier Contents field.

Unique Identifier Contents

Shows the current contents of the UID.

You can include attributes or relationships in the UID by highlighting them in the relevant Candidate field and clicking on the DOWN ARROW.

You can remove attributes or relationships from the UID by highlighting them in the Unique Identifier Contents field and clicking on the UP ARROW.

OK

Saves any changes you may have made and closes the dialog box.

Cancel

Cancels the dialog box without saving any changes you may have made.

Apply

Saves any changes you may have made without closing the dialog box.

Help

Displays help information about the current tab in the dialog box.


Edit Entity - Attributes

Related Topics

Used to define basic details about the attributes of the current entity. More detailed information about the attributes can be entered on the Attribute Detail tab.

You can use this Attributes tab to insert new attributes, delete those that are no longer needed, or modify the details of existing attributes.

Attributes spreadtable

This table allows you to define the basic details of attributes for the current entity.

Name

40 characters
The name of an attribute for the entity. The name must be a property of the entity (for example, if the entity is EMPLOYEE, an important attribute is NAME).

Seq

A number to indicate the ordering sequence for attributes displayed on the diagram. The attributes are listed in the dialog box in the order in which they will appear on the diagram. Any changes made to the sequence will not be reflected in the dialog box until the next time the dialog box is opened.

The default order of attributes is: unique identifier attributes, mandatory attributes, optional attributes. Any mandatory attributes and optional attributes are sequenced in alphabetical order.

Opt

Indicates whether or not the attribute is optional.

Format

The format for the attribute . Valid formats are: CHAR, DATE, IMAGE, INTEGER, MONEY, NUMBER, PHOTOGRAPH, SOUND, TEXT, TIME, TIMESTAMP, VARCHAR2 and VIDEO.

MaxLen

Optional, 3 integers
The length of the attribute format, where required. Some attribute formats need no further definition (for example, DATE, INTEGER); others require a length qualification.

Dec

Optional, 2 integers
The number of decimal places required for the attribute format.

Primary

Determines whether or not the attribute is part of the primary unique identifier (primary key). If a primary unique identifier exists, checking this checkbox adds the attribute to the primary unique identifier. If a primary unique identifier does not exist, checking this checkbox creates a new primary unique identifier using this attribute. The primary unique identifier can also be defined and modified in the UIDs tab.

Comment

Optional, 80 characters
Any notes or comments about the attribute.

Insert Row

Inserts a new blank row in the spreadtable immediately preceding the currently selected row. A new row can also be inserted at any position in the spreadtable by simply clicking on an empty row.

Delete Row

Deletes any currently selected rows from the spreadtable.

Reset Default

Resets the appearance of the spreadtable, e.g. column widths, to the default. For example, you may have increased the width of the Comment column (by placing the cursor on the line between two spreadtable headings and then dragging) to enter comments more easily. This button allows you to quickly return the column to its default width.

OK

Saves any changes you may have made and closes the dialog box.

Cancel

Cancels the dialog box without saving any changes you may have made.

Apply

Saves any changes you may have made without closing the dialog box.

Help

Displays help information about the current tab in the dialog box.


Edit Entity - Att Detail

Related Topics

Used to define detailed information about the attributes of the current entity. Basic information about the attributes can be entered on the Attributes tab.

Name

The name of the attribute. A drop-down list of all attributes for the current entity is available.

Primary UID checkbox

Indicates whether or not the attribute belongs to the primary key.

Optional ? checkbox

Indicates whether or not the attribute is mandatory or optional.

Percentage Used

This group of fields allows you to define details about the percentage of occurrences of the current entity that contain a value for this attribute.

Initial

3 integers
The percentage of occurrences of the entity that contain a value for this attribute when the data is initially loaded. (For optional attributes only.)

Average

3 integers
The average percentage of occurrences of the entity that contain a value for this attribute. (For optional attributes only.)

Format

This group of fields allows you to define details of the attribute format. Either choose a domain from the dropdown list or specify the format using the remaining properties in this group.

Domain

Identifies the domain that specifies the attribute format. You can choose from the list of existing domains visible to the workarea.

Note: If ****** is displayed, the domain that specifies  the attribute format is not visible to this workarea.

Type

10 characters
The format for the attribute. Valid formats are: CHAR, DATE, IMAGE, INTEGER, MONEY, NUMBER, PHOTOGRAPH, SOUND, TEXT, TIME, TIMESTAMP, VARCHAR2 and VIDEO.

Note:	Some attribute formats need no further definition (for example, DATE or INTEGER); others require a length qualification, which you can define in the following fields.

Max Length

Optional, 3 integers
The maximum length for this attribute.

Ave Length

Optional, 3 integers
The average length for this attribute, when it contains a value.

Decimal Places

Optional, 2 integers
The number of decimal places required.

Units

Optional, 10 characters
The unit of measure for this attribute (for example, meters, kilograms, pounds, cubic centimeters, dollars, hours).

Derivation

Optional, 240 characters
An algorithm or expression that describes how the value for a derived attribute is established (for example, 7 x DAILY TOTAL gives the WEEKLY TOTAL).

On Condition

Optional, 80 characters
Details of the conditions under which the attribute can be used. For example, the shipping date on a line item is only used when it has been established that stock is available. (For optional attributes only.)

Null Value

Optional, 40 characters
The value which indicates that the attribute is not present for an occurrence of the entity. Systems implemented on an Oracle database should not require this value, because no physical space is used for null values. Other implementations may record null values by means of spaces, high values, zeros, and so on. Since these values will not be available to the end user, it is recommended that the type of null value is agreed during the analysis stage.

Default

Optional, 40 characters
The most common value for this attribute when an instance of this element is created. This could be the value defaulted on a data entry screen to save keystrokes. It is usually only used for mandatory attributes (for example, TODAY for Date Order Raised).

Sequence in Sort

Determines how this attribute is used by generated code when sorting records retrieved from the database.

Sort Order drop-down list

Determines whether the records are sorted in ascending or descending order of values for this attribute.

OK

Saves any changes you may have made and closes the dialog box.

Cancel

Cancels the dialog box without saving any changes you may have made.

Apply

Saves any changes you may have made without closing the dialog box.

Help

Displays help information about the current tab in the dialog box.


Edit Entity - Att Values

Related Topics

Used to define the values that an attribute can take. This information is used for validation checks when the programs or modules are written. You can enter ranges of values, lists of values or code conversions.

Attribute Name

The name of the attribute for which you are defining the allowable values. The attribute name can be entered or selected from the drop-down list.

Sequence

Optional, 3 integers
The sequence number to be used when displaying the values of this attribute. This information may be used by the Generators (for example, for determining the order of values displayed in a radio group).

Value

40 characters
A valid value for this attribute. When defining a range of values, this field is used to define the low value.

High Value

Optional, 40 characters
A high value for the attribute, if a range of values is being defined. The Value property is used as the lower range value.

Abbreviation

Optional, 20 characters
An abbreviation, or short code, for the value.

Meaning

Optional, 60 characters
The full meaning for the abbreviation or code value, entered above, which describes the value or range specified.

Insert Row

Inserts a new blank row in the spreadtable immediately preceding the currently selected row. A new row can also be inserted at any position in the spreadtable by simply clicking on an empty row. This button is displayed only when one or more attributes exists for the entity.

Delete Row

Deletes any currently selected rows from the spreadtable. This button is displayed only when one or more attributes exists for the entity.

Reset Default

Resets the appearance of the spreadtable, e.g. column widths, to the default. For example, you may have increased the width of the Comment column (by placing the cursor on the line between two spreadtable headings and then dragging) to enter comments more easily. This button allows you to quickly return the column to its default width.

OK

Saves any changes you may have made and closes the dialog box.

Cancel

Cancels the dialog box without saving any changes you may have made.

Apply

Saves any changes you may have made without closing the dialog box.

Help

Displays help information about the current tab in the dialog box.


Edit Entity - Text

Related Topics

Used to enter free format multi-line text for the text types associated with the current element.

Element Type

Allows you to select the type of element for which you want to enter multi-line text. A list of valid element types is available.

Element Name

Allows you to specify the name of the attribute for which you want to enter multi-line text. A list of all attributes qualifying the current entity is available.

Note:	This field is only displayed if you have selected Attribute in the Element Type field.

Text Type

Defines which text type you want to enter multi-line text for, and enter the text. A list of currently defined text types is available. Additional text types can be defined using user extensibility.

Text Editor

Invokes a text editor for you to enter text.

HTML Editor

Invokes an HTML editor for you to enter text.

OK

Saves any changes you may have made and closes the dialog box.

Cancel

Cancels the dialog box without saving any changes you may have made.

Apply

Saves any changes you may have made without closing the dialog box.

Help

Displays help information about the current tab in the dialog box.


Edit Domains Dialog Box

Related Topics

Used to define a domain, or edit details of an existing one.

A domain is a set of validation rules, format constraints and other properties that applies to a group of attributes, columns, program data constructs, parameters or datastructures. For example, before entering attribute details, it is useful to define any domains that have been identified, such as Name and Address. When an attribute has been defined, a domain can be specified that will apply to it.

Definition

Detail

Values

Text


Edit Domains - Definition

Related Topics

Defines the mandatory and most frequently used details of domains defined for the current entity. More detailed information about domains can be entered on the Detail tab.

You can use this Definition tab to define new domains, delete domains that are no longer needed, or modify the details of existing domains.

Note:	This dialog box shows domains in the current container only, i.e., domains in the container identified in the Container list on the main toolbar.

Domains spreadtable

This table allows you to define the basic details of domains for the current entity.

Name

40 characters
The name of the domain.

Note:	You can specify the container in which a domain is created using the Container list on the main toolbar.

Format

Optional
The format for the attributes in this domain. Example valid formats are: CHAR, DATE, IMAGE, INTEGER, MONEY, NUMBER.

Max Att. Length

Optional, 5 integers
The maximum length for attributes in the domain.

Datatype

Optional
The format for columns, program data constructs, parameters or datastructures in this domain. Example valid formats are: BINARY INTEGER, CHAR, DATE, DECIMAL, DOUBLE.

Max Col. Length

Optional, 5 integers
The maximum length for columns, program data constructs, parameters or datastructures in the domain.

Comment

Optional, 240 characters
A brief description of the domain.

Example:	If the domain has been created by the system from attribute information, the entry will be as follows:

SYSTEM - CREATED FROM ATTRIBUTE <attribute-name> OF ENTITY <entity-name>

If the domain has been created by the system from column information, the entry will be as follows:

SYSTEM - CREATED FROM COLUMN <column-name> OF TABLE <table-name>

These descriptions can be overtyped, if required.

Insert Row

Inserts a new blank row in the spreadtable immediately preceding the currently selected row. A new row can also be inserted at any position in the spreadtable by simply clicking on an empty row.

Delete Row

Deletes any currently selected rows from the spreadtable.

Reset Default

Resets the appearance of the spreadtable, e.g. column widths, to the default. For example, you may have increased the width of the Comment column (by placing the cursor on the line between two spreadtable headings and then dragging) to enter comments more easily. This button allows you to quickly return the column to its default width.

OK

Saves any changes you may have made and closes the dialog box.

Cancel

Cancels the dialog box without saving any changes you may have made.

Apply

Saves any changes you may have made without closing the dialog box.

Help

Displays help information about the current tab in the dialog box.


Edit Domains - Detail

Related Topics

Defines detailed information about domains.

Domains can be created, and their basic details defined, on the Definition tab.

Domain

The name of the domain for which you want to edit the details. A drop-down list of valid domains is available.

Super-type

Optional
The name of the domain that is the immediate super-type, if one exists, for the domain you are defining.

This property is for documentation purposes only and is not used by any of the generator or transformer products.

Attribute

This group of fields allows you to specify format details for the attributes in a domain.

Format

Optional
The format for the attributes in the domain. Example valid formats are: CHAR, DATE, IMAGE, INTEGER.

Max Length

Optional, 5 integers
The maximum length for attributes in the domain.

Ave Length

Optional, 5 integers
The average length for attributes in the domain.

Decimal Places

Optional, 2 integers
The number of decimal places required for attributes in the domain.

Column

This group of fields allows you to specify format details for the columns, program data constructs, parameters or datastructures in a domain.

Datatype

Optional
The format for columns, program data constructs, parameters or datastructures in the domain. Example valid data types are: BINARY INTEGER, CHAR, DATE, DECIMAL.

Max Length

Optional, 5 integers
The maximum length for columns, program data constructs, parameters or datastructures in the domain.

Ave Length

Optional, 5 integers
The average length for columns, program data constructs, parameters or datastructures in the domain.

Decimal Places

Optional, 5 integers
The number of decimal places required for column, program data construct, parameter or datastructure formats in the domain.

Units

Optional, 10 characters
The unit of measure for attributes in this domain; for example, meters, kilograms, pounds, cubic centimeters, dollars and hours.

Null Value

Optional, 40 characters
The value that indicates that the attribute or column in the domain is not present for an occurrence of the entity or table. Systems implemented on an Oracle database should not require this value because no physical space is used for null values. Other implementations may record null values by means of spaces, high values, zeros, etc.

Default

Optional, 40 characters
The most common value for the attributes or columns in the domain. This will be the value defaulted on a data entry screen to save keystrokes.

Dynamic List? checkbox

Determines whether the resulting list is dynamic if the display datatype for a column usage is Poplist or Text List, i.e. based on a SELECT from CG_REF_CODES rather than hard coded values.

Derivation

Optional, 240 characters
The derivation of attributes within the domain.

OK

Saves any changes you may have made and closes the dialog box.

Cancel

Cancels the dialog box without saving any changes you may have made.

Apply

Saves any changes you may have made without closing the dialog box.

Help

Displays help information about the current tab in the dialog box.


Edit Domains - Values

Related Topics

Used to define the values that attributes, columns, program data constructs, parameters or datastructures in a domain can take. The information can be used for deriving validation modules to be applied to the attributes or columns in the domain. Range of values, lists of values or code conversions may be entered in this tab.

Domain

The name of the domain for which you want to define the valid values. A drop-down list of valid domains is available.

Allowable Domain Values spreadtable

This table allows you to define the valid values for the selected domain.

Sequence

Optional, 3 integers
The display sequence number for the domain value when displayed in an option group or list of values on a screen. This information can be used by the Generators (for example, for determining the order of values displayed in a radio group).

Value

40 characters
A valid value for the domain. This field is used to define the low value when defining a range of values.

High Value

Optional, 40 characters
A high value for the domain, if a range of values is being defined.

Abbreviation

Optional, 20 characters
An abbreviation, or short code, for the value.

Meaning

Optional, 60 characters
The full meaning for the abbreviation or code value, entered above, which describes the value or range specified.

Insert Row

Inserts a new blank row in the spreadtable immediately preceding the currently selected row. A new row can also be inserted at any position in the spreadtable by simply clicking on an empty row.

Delete Row

Deletes any currently selected rows from the spreadtable.

Reset Default

Resets the appearance of the spreadtable, e.g. column widths, to the default. For example, you may have increased the width of the Comment column (by placing the cursor on the line between two spreadtable headings and then dragging) to enter comments more easily. This button allows you to quickly return the column to its default width.

OK

Saves any changes you may have made and closes the dialog box.

Cancel

Cancels the dialog box without saving any changes you may have made.

Apply

Saves any changes you may have made without closing the dialog box.

Help

Displays help information about the current tab in the dialog box.


Edit Domains - Text

Related Topics

Used to enter free format multi-line text for the text types associated with the current domain.

Domain Name

Allows you to specify the name of the domain for which you want to enter multi-line text.

Text Type

Defines which text type you want to enter multi-line text for, and enter the text. A list of currently defined text types is available. Additional text types can be defined using user extensibility.

Text Editor

Invokes a text editor for you to enter text.

HTML Editor

Invokes an HTML editor for you to enter text.

OK

Saves any changes you may have made and closes the dialog box.

Cancel

Cancels the dialog box without saving any changes you may have made.

Apply

Saves any changes you may have made without closing the dialog box.

Help

Displays help information about the current tab in the dialog box.


Edit Relationship Dialog Box

Related Topics

Used to modify the details of a relationship.

Definition

Text


Edit Relationship - Definition

Related Topics

Defines the details of a relationship.

Relationship End

These two groups of fields define details of the source or destination of the relationship. The left-hand group defines the source details, while the right-hand group defines the destination details. The source is the entity from which the relationship was drawn when it was created.

Entity

Display only
The name of the entity at this end of the relationship.

From Name/To Name

60 characters
The name of the relationship at this end. For example, "on " and "comprised of" in the case of a relationship between entities named PRICE LIST ITEM and PRICE LIST.

The name of the relationship can be entered or changed in these fields.

Optionality

Defines whether this end of the relationship is optional or mandatory:

	Optional: for example, "Each PRICE LIST ITEM may be on a PRICE LIST"
	Mandatory: for example, "Each PRICE LIST ITEM must be on a PRICE LIST"
Degree

Defines whether the other end of the relationship is single or multiple:

	Single: for example, "Each PRICE LIST must be comprised of one and only one PRICE LIST ITEM"
	Multiple: for example, "Each PRICE LIST must be comprised of one or more PRICE LIST ITEMS"
Note:	The cardinality of both ends of the relationship are also known as, and are defined in the Repository Object Navigator as, the Minimum and Maximum Cardinality.

The Minimum Cardinality expresses the number of entities possible at the other end of the relationship for each entity at this end. This tells you both the degree at that end of the relationship and the optionality at this end. A zero indicates that a relationship is optional.

The Maximum Cardinality expresses the number of entities possible at the other end of the relationship for each entity at this end. Null indicates an infinite number.

Primary UID checkbox

Determines whether or not the relationship is part of the primary unique identifier (primary key). If a primary unique identifier exists, checking this checkbox adds the relationship to the primary unique identifier. If a primary unique identifier does not exist, checking this checkbox creates a new primary unique identifier using this relationship.

Transferable checkbox

Indicates whether or not this end of the relationship can be transferred to another instance of the current entity. Making a relationship end non-transferable might be useful, for example, if you wanted to maintain history details of relationships.

In Arc

Display only
Indicates whether or not this end of the relationship is included in an arc. Relationships in an arc are mutually exclusive and are identified by numbers.

OK

Saves any changes you may have made and closes the dialog box.

Cancel

Cancels the dialog box without saving any changes you may have made.

Apply

Saves any changes you may have made without closing the dialog box.

Help

Displays help information about the current tab in the dialog box.


Edit Relationship - Text

Related Topics

Used to enter free format multi-line text for the text types associated with the ends of the currently selected relationship.

Relationship End Name drop-down list

The name of the end of the currently selected relationship for which you want to enter free-format text.

Text Type drop-down list

The text type drop-down list allows you to select which text type you want to enter multi-line text for, and enter the text. A list of currently defined text types is available. Additional text types can be defined using user extensibility.

Text Editor

Invokes a text editor for you to enter text.

HTML Editor

Invokes an HTML editor for you to enter text.

OK

Saves any changes you may have made and closes the dialog box.

Cancel

Cancels the dialog box without saving any changes you may have made.

Apply

Saves any changes you may have made without closing the dialog box.

Help

Displays help information about the current tab in the dialog box.


Utilities - Update Attributes in Domains
Update Attributes in Domains (Utilities Menu)

Related Topics

Updates the domain details for all the attributes in specified domains. This option displays the Update All Attributes within Domains dialog box. Note that if you edit the details of an attribute, then it is automatically removed from the domain.

Dialog box options

List box

Displays the domains for the current container. You can specify the current container using the Container list on the main toolbar.

Select All

Selects all the domains shown in the list box.


Creating an entity model

Related Topics

Use the Entity Relationship Diagrammer to create a graphical representation of an entity model.  The diagram below illustrates the process. The following steps assume that you have analyzed the business requirements and user needs and know what information you want to put into the Entity Relationship Diagram.

If this is your first entity model, you may want to step through the tasks one at a time. To jump to a task, click on the appropriate step.

	Create a new diagram
	Include existing entities on the diagram
	Create new entities on the diagram
	Create relationships between entities
	Include relationships in arcs
	Create attributes to qualify entities
	Create domains for attributes
	Create unique identifiers or attributes
	Lay out the diagram automatically
	Save the diagram
Next step

When you have created an Entity Relationship Diagram you can refine the diagram, for example by creating additional elements, deleting unwanted elements or changing the layout.


Creating a New Diagram
Creating a new Entity Relationship Diagram

Related Topics

To create a new Entity Relationship Diagram:

1.	In the Entity Relationship Diagrammer, choose File→New.

2.	Choose the container in which the diagram will be created and saved.

Note:	Any diagram elements you create are created by default in the container you choose from this dialog box. You can change the container in which elements will be created using the Container List on the toolbar.

A new diagram is untitled when first created; it has no name assigned to it other than "ERD#". Diagrams can be named using File→Save Diagram As.


Creating entities on Entity Relationship Diagrams
Creating entities

Related Topics

When you use the Entity Relationship Diagrammer to create entities, the container in which the entities are created is displayed in the Container list on the main toolbar.  About

To create an entity:

1.	In the Entity Relationship Diagrammer, use the Container List on the main toolbar to specify the name of the container in which you want to create a new entity.  How

Note:	The container displayed initially is the diagram's owning container.

2.	Click [image].

3.	Move the mouse pointer to the area of the diagram in which you want to position your entity.

4.	To create the new entity at the default size, click the mouse button.

To create the new entity larger or smaller than the default size, drag the entity box to the desired size for the entity, and release the mouse button.

Note:	Sub-types and super-types can be created by positioning the entity box in the appropriate position.

To create a super-type, position and stretch the entity box over and around the entity or entities that will become its sub-types, and release the mouse button.

To create a sub-type, position the entity box inside the entity that will become its super-type, and release the mouse button.

5.	Enter the name of the entity.

6.	If required, enter a short name and plural name for the entity, then click OK.

Note:	If you do not enter a short name and plural name defaults are provided. Since the default short name is merely a shortened version of the full name you may want to specify your own short names to avoid the risk of any duplicate short names.

Data warehouse considerations

If you are creating a logical design for a data warehouse, you must specify which entities represent facts or dimensions in the data warehouse. To do this, double click on the entity diagram element and choose the required value from Data warehouse Type field on the Edit Entity dialog box.

The Database Design Transformer uses this property to create definitions of fact tables and dimension tables in the workarea.


Creating attributes on Entity Relationship Diagrams
Creating attributes on Entity Relationhip Diagrams

Related Topics

You should attributes to define the entities in your system as fully as possible.  About

To create an attribute:

1.	In the Entity Relationship Diagrammer, double-click on the entity for which you want to create attributes.

Note:	If the selected element is not consistent with the repository you will be asked whether you want to requery that element. Only elements that are consistent with the repository can be edited.

2.	Select the Attributes tab to display the attribute definition details. Detailed attribute information and attribute values are defined on the Att Detail and Att Values tabs respectively.

3.	Insert a new attribute row by doing one of the following:

•	to insert a new attribute in the current row, click on an empty attribute row.

•	to insert a new attribute row before the currently selected row, click on the Insert Row button.

4.	Enter the appropriate details for the attribute. You must enter at least a name and format. Use the scroll bars to scroll to properties of the attribute which are not currently displayed.

5.	To save the new attribute, click OK.


Creating unique identifiers on Entity Relationship Diagrams

Related Topics

Unique identifiers may consist of an attribute, a combination of attributes, a combination of relationships or a combination of attributes and relationships.

This procedure is primarily for creating alternate unique identifiers. You can create an initial primary unique identifier using the Attributes tab of the Edit Entity dialog box or the Definition tab of the Edit Relationship dialog box. On the Attributes tab of the Edit Entity dialog box, you check the box in the Primary column for each attribute that you want to be in the unique identifier. On the Definition tab of the Edit Relationship dialog box, you check the Primary UID checkbox.

To create a unique identifier:

1.	In the Entity Relationship Diagrammer, double-click on the entity for which you want to create a unique identifier.

Note:	If the selected element is not consistent with the repository you will be asked whether you want to requery that element. Only elements that are consistent with the repository can be edited.

2.	Select the UIDs tab to display the unique identifier details.

A UID will have been created if any of the attributes are marked as Primary on the Attributes tab. This UID will initially be given an automatically generated name, which you can change as described in the following step.

3.	Click on an existing unique identifier name or on an empty Name cell.

To insert a new row before the currently selected row, click on the Insert UID button.

4.	For each UID, say whether it is primary by checking the box in the Primary? column.

5.	Include the required attributes and relationships in the UID by highlighting them in the relevant Candidate field and clicking on the DOWN ARROW button.

6.	Remove any unwanted attributes and relationships in the UID by highlighting them in the Unique Identifier Contents field and clicking on the UP ARROW button.

7.	To create the UID, click OK.


Creating domains for entity attributes
Creating domains on Entity Relationship Diagrams

Related Topics

When you use the Entity Relationship Diagrammer to create domains, the container in which the domains are created is displayed in the Container list on the main toolbar.

To create a domain:

1.	In the Entity Relationship Diagrammer, choose Edit→Domains.

2.	Select the Definition tab to display the mandatory and most frequently used details of a domain.

3.	Insert a new attribute row by doing one of the following:

•	to insert a new attribute in the current row, click on an empty attribute row.

•	to insert a new attribute row before the currently selected row, click on the Insert Row button.

4.	To enter detailed information about the domain, such as the format details for the attributes in a domain, or the valid units of measurement, select the Detail tab and enter the required details.

5.	To enter information about the allowable values for elements in a domain, select the Values tab and enter the required details. Ranges of values, lists of values or code conversions may also be entered in this tab.

6.	To enter free format multi-line text for the text types associated with the domain, select the Text tab and enter the required text.

7.	To create the domain, click OK.


Creating relationships on Entity Relationship Diagrams

Related Topics

Entity relationships identify significant associations between two entities, and can be established for existing entities only.  About

To create a relationship between entities:

1.	In the Entity Relationship Diagrammer, click the button for the type of relationship you want to create.

	M:1 (Mandatory to Optional) Relationship button
	M:1 (Optional to Optional) Relationship button
	M:1 (Optional to Mandatory) Relationship button
	M:1 (Mandatory to Mandatory) Relationship button
	M:M (Mandatory to Optional) Relationship button
	M:M (Optional to Optional) Relationship button
	1:1 (Mandatory to Optional) Relationship button
	1:1 (Optional to Optional) Relationship button
	1:1 (Mandatory to Mandatory) Relationship button
2.	Click on the entity you want to be at the first end of the relationship.

Note:	To insert a dog-leg in the relationship, click the mouse button in free space on the diagram where you want to create the dog-leg.

3.	Click on the entity you want to be at the other end of the relationship.

4.	Enter a name for each end of the relationship.

Note:	The Relationship Names option, set in the Customize dialog box, determines whether or not relationship names are displayed on the diagram.


Creating arcs for entity relationships

Related Topics

To create an arc:

1.	In the Entity Relationship Diagrammer, select the relationships that you want to include in the arc.

Note:	If you select the relationship end names instead of the relationships, you do not have to select the entity to which the relationships are associated before creating an arc.

2.	Select one of the entities associated with the relationships to determine which end of the relationships should be included in the arc.

3.	Click [image].

Note:	An arc should contain two or more relationship ends. All the relationship ends must be from the same entity, and of the same optionality. No relationship end can be in more than one arc.


Including elements on Entity Relationship Diagrams
Including elements on an Entity Relationship Diagram

Related Topics

Entities and relationships can be included on a diagram from the workarea. Relationships can be included at any time for entities already on the diagram.

When you include entities on a diagram, you can choose to include all relationships between those entities at the same time. Alternatively you can choose to include the relationships separately using Edit→Include→Relationship.

To include elements on an Entity Relationship Diagram:

1.	In the Entity Relationship Diagrammer, choose Edit→Include→<element type>.

2.	Select one or more elements from the list box that you want to include.

When you include an element on a diagram, it is removed from the list to prevent more than one instance of that element being placed on the diagram.

3.	(Optional)  To also include any relationships between the included entities, check the With Relationships checkbox.

4.	(Optional)  Select the required option from the Autolayout to option buttons.

To automatically lay out the elements in the whole of the diagram area, click Whole Diagram.

To automatically lay out the elements within a new autolayout area of the diagram, click New Area.

To automatically lay out the elements within an existing autolayout area of the diagram, select Same Area. If the existing autolayout area is not displayed on the diagram, and you wish to view it, choose Options→Customize and check the Show Autolayout Area checkbox in the Customize dialog box.

5.	To include the elements on the diagram, click OK.

Note:	If you have selected the autolayout option New Area, the mouse pointer changes to a cross-hair, ready for you to define an autolayout area in which the elements are to be placed. If the autolayout area is too small, an alert box is displayed offering you the choice of trying again.


Laying out an Entity Relationship Diagram automatically

Related Topics

A diagram can be automatically laid out a number of times providing you with several alternative layouts. Any of these layouts can be retrieved if no other operation is performed between the autolayout operations.

Note:	After automatically laying out a diagram, the utility also minimizes the number of pages that the diagram covers. To improve the printed appearance of a diagram, you can move the elements on a diagram so that they cover the minimum number of pages.

To use the Autolayout utility more effectively:

•	Increase the default entity height and width in the Customize dialog box.

•	Reduce the size of the diagram, where possible.

•	Select all of the elements on the diagram before running the Autolayout utility again. This gives the utility the maximum flexibility when rearranging elements on a diagram.

There are four ways in which elements can be automatically laid out on a diagram.

To reposition all elements automatically on the active diagram:

1.	In the Entity Relationship Diagrammer, ensure that no elements are selected on the active diagram.

2.	Choose Layout→Autolayout.

To reposition selected elements automatically on the active diagram:

1.	In the Entity Relationship Diagrammer, select the elements to be automatically laid out.

2.	Choose Layout→Autolayout.

To reposition selected elements automatically within a new defined autolayout area on the active diagram:

1.	In the Entity Relationship Diagrammer, select the elements to be automatically laid out.

2.	Choose Layout→Autolayout to New Area.

3.	Position the mouse pointer at the point on the active diagram at which you want to start defining the autolayout area and hold the mouse button down.

4.	Drag the rubber-band box to the size required for the autolayout area and release the mouse button.

Note:	A better autolayout result can be achieved if the autolayout area you select contains a large amount of free space.

To reposition selected elements automatically within a previously defined autolayout area on the active diagram:

1.	Select the elements to be automatically laid out.

2.	Choose Layout→Autolayout to Same Area.

The selected elements are automatically laid out within the previously defined autolayout area.


Showing or hiding the AutoLayout area

Related Topics

To show or hide the autolayout area on the active diagram:

1.	In the Entity Relationship Diagrammer, choose Options→Customize.

2.	To show the autolayout area, check the Show Layout Area checkbox.

To hide the autolayout area, uncheck the Show Layout Area checkbox.

3.	To show or hide the autolayout area on the active diagram only, click OK.

To show or hide the autolayout area on the active diagram and any diagrams subsequently opened in either the current or future invocations of the diagrammer, click Save.


Deleting attributes
Deleting attributes from entities

Related Topics

To delete an attribute from an entity:

1.	In the Entity Relationship Diagrammer, select the entity whose attributes you want to delete and choose Edit→Properties.

Note:	If the selected element is not consistent with the workarea you will be asked whether you want to requery that element. Only elements that are consistent with the workarea can be edited.

2.	Select the Attributes tab to display the attribute definition details. Detailed attribute information and attribute values are defined on the Att Detail and Att Values tabs respectively.

3.	Select the row for the attribute you want to delete, and click Delete Row.

4.	To save the changes, click OK.


Deleting entity relationship elements from the repository

Related Topics

Elements that have become obsolete can be removed from the diagram and the repository simultaneously by deleting those elements from the active diagram.

Deleting an entity also deletes its attributes and any relationships linking it to other entities.

To delete an element from the diagram AND from the repository:

1.	In the Entity Relationship Diagrammer, select the element or elements you want to delete.

2.	Choose Edit→Delete From Repository.

Note:	Elements can be removed from the list of elements to be deleted.


Adding relationship ends to arcs

Related Topics

To add relationship ends to an arc:

1.	In the Entity Relationship Diagrammer, select the arc to which you want to add relationship ends.

2.	Select the relationships, or the relationship end names, that you want to add to the selected arc.

3.	Click [image].

Note:	All the relationship ends in an arc must be from the same entity, and of the same optionality. No relationship end can be in more than one arc.


Removing relationship ends from arcs

Related Topics

To remove relationship ends from an arc:

1.	In the Entity Relationship Diagrammer, select the arc from which you want to remove relationship ends.

2.	Select the relationships, or the relationship end names, that you want to remove from the selected arc.

Note:	Both the arc and the relationship that you want to remove must be selected before you can remove the relationship from the arc.

3.	Click [image].


Defining the default size of elements on Entity Relationship Diagrams

The default size of any new entities created can be defined in the Customize dialog box. The default size is also the minimum size to which entities will be resized by an autolayout operation.

To define the default width of entities:

1.	In the Entity Relationship Diagrammer, choose Options→Customize.

2.	Enter, in the Minimum Entity Width (cells) field, the width (in grid cells) for entities.

3.	To define the entity width on the active diagram only, click OK.

To define the entity width on the active diagram and any diagrams subsequently opened in either the current or future invocations of the diagrammer, click Save.

To define the default height of entities:

1.	In the Entity Relationship Diagrammer, choose Options→Customize.

2.	Enter, in the Minimum Entity Height (cells) field, the height (in grid cells) for entities.

3.	To define the entity height on the active diagram only, click OK.

To define the entity height on the active diagram and any diagrams subsequently opened in either the current or future invocations of the diagrammer, click Save.


Displaying attributes on Entity Relationship Diagrams

Related Topics

The Attributes preference determines which attributes are displayed on entities on the active diagram. The options are:

•	all

•	primary unique identifiers

•	mandatory

To specify which attributes are displayed on entities:

1.	In the Entity Relationship Diagrammer, choose Options→Customize.

2.	Select the Attributes option for the type of attribute you want to display.

3.	To display the specified type of attribute on all new entities on the active diagram only, click OK.

To display the specified type of attribute on all new entities on the active diagram and any diagrams subsequently opened in either the current or future invocations of the diagrammer, click Save.

Note:	To show the specified attributes on the diagram, check the View Attributes box in the Customize dialog box.


Showing or hiding items and properties on Entity Relationship Diagrams

Related Topics

You can choose to show or hide the following items and properties on a diagram:

•	hidden arcs

•	relationship names

•	primary UIDs

•	transferability symbols

•	attributes

To show or hide items and properties on a diagram:

1.	In the Entity Relationship Diagrammer, choose Options→Customize.

2.	To show an item or property, check the appropriate checkbox.

To hide an item or property, uncheck the appropriate checkbox.

3.	To show or hide the specified items and properties on the active diagram only, click OK.

To show or hide the specified items and properties on the active diagram and any diagrams subsequently opened in either the current or future invocations of the diagrammer, click Save.


Invoke the Entity Relationship Diagrammer

To invoke the Entity Relationship Diagrammer:

Do one of the following:

•	Click on the Entity Relationship Diagrammer icon in the Oracle Designer Window.

•	Choose Tools→ Entity Relationship Diagrammer from the Process Modeler, Dataflow Diagrammer, Function Hierarchy Diagrammer or Repository Object Navigator.


Updating entity attributes in domains
Updating attributes in domains

The 'Update attributes in domains' utility overwrites any properties in an entity's attribute that conflict with the same property in the attribute's domain. Null values in the domain replace non-null values in the attribute. The exception to this is the Default Values property which is not overwritten in the attribute when it has a null value in the domain.

This utility should be run after changing the details of a domain.

To update all attributes within domains:

1.	From the Entity Relationship Diagrammer, choose Utilities→Update Attributes in Domains.

2.	Select one or more domains from the list whose attributes you want to update using the changed details of those domains.

To select all domains in the list, click on the Select All button.


File - Save Diagram
   Save Diagram (File Menu)

Related Topics

Saves the active diagram under its current name. If the diagram is untitled a dialog box is displayed for you to enter a name.


File - Save Diagram As
Save Diagram As (File Menu)

Related Topics

Names and saves the active diagram under a new name.

Dialog box options

Diagram name

The name under which you want to save the active diagram. This field can be populated by selecting one of the diagrams in the list or by entering the diagram name using alphanumeric characters. The default for this field is the name of the active diagram.

Diagrams for container

A list of the existing named diagrams in the container.


File - Delete Diagram
Delete Diagram (File Menu)

Related Topics

Deletes an existing diagram from a chosen container. This option deletes a diagram, but not any of the elements stored in the repository that are represented on the diagram.

Dialog box options

Diagrams for workarea

Lists the existing diagrams, grouped by container, that are visible to your workarea. Choose the diagram you want to delete by expanding the appropriate container node and selecting the diagram name.


File - Close
Close (File Menu)

Closes the active window without quitting the tool. To quit the tool use File→Exit.


File - Summary Information
Summary Information (File Menu)

Related Topics

Displays information about the active window and enables you to record additional information about the window.

The database connection and the current workarea cannot be changed using this menu option, but can be changed using File→Change Connection and File→Change Workarea.

Dialog box options

When the active window is a diagram, the dialog box has the following tabs:

Summary Details

Text

Otherwise, the Summary Information (without tabs) dialog box is displayed.


Summary Information - Summary Details

The Show checkbox adjacent to each field determines whether or not the information in the field is displayed in the print legend on the active window.

Note:	Summary information cannot be saved against a diagram unless that diagram has already been saved in the repository.

When a diagram is copied, i.e., you open a read-only copy of a currently open diagram, the summary information about that diagram does not get copied.

Diagram

The name of the active diagram.

Title

The title of the active window. The title can be used for displaying additional information on the window.

Created

The date and time on which the contents of the active window was created.

Last Modified

The date and time on which the contents of the active window was last modified.

Author

The author of the contents of the window.

Container

The name of the container that you are currently using.

Username

The username for the Oracle database that you are currently using.

Connect String

The connect string for the Oracle database that you are currently using.

Workarea

The name of the workarea that you are currently using.


Summary Information - Text

Related Topics

Used to enter free format multi-line text for the text types associated with the active diagram, such as notes and description.

Note:	Multi-line text can be entered only for named diagrams.

Text Type field

Defines which text type you want to enter multi-line text for. A list of currently defined text is available.

Text Editor button

Opens the ASCII editor, which enables you to attach ASCII text to the selected multi-line text property.

HTML Editor button

Opens the HTML editor, which enables you to attach HTML text to the selected multi-line text property.


Summary Information dialog box

Related Topics

Displays information about the Navigator. The checkbox adjacent to each field determines whether or not the information in the field is displayed in the print legend.

Workarea

The name of the workarea that you are currently using.

Username

The username for the Oracle database that you are currently using.

Connect String

The connect string for the Oracle database that you are currently using.


File - Change Connection
Change Connection (File Menu)

Related Topics

Changes the Oracle database to which the current tool is connected.

Connect dialog box


Connect dialog box

Specifies or changes the Oracle database to which the current tool is connected.

Username

The name of the user that must be specified to gain access to the database account.

You can specify the full connect string in this field, in the format:

username/password@database_alias

For example, to connect to a database with the alias HQ8 using the username and password scott, you would enter:

scott/scott@HQ8

Note:	If you specify the full connect string here, you do not need to complete the Password and Connect fields.

Password

The password for the given username. The password is displayed as asterisks.

Connect String

The database alias required to access the database account. You must ensure that the database alias is specified in the TNSNAMES.ORA file in your Oracle home directory, usually d:\oracle_home\NET80\ADMIN.


File - Change Workarea
Change Workarea (File Menu)

Related Topics

Changes the workarea for the current tool and provides access to the Workarea Wizard which allows you to create new workareas.

Note, you must have the repository management privilege before you can create workareas.

Workarea dialog box


Workarea dialog box

Specifies or changes the workarea for the current tool, and enables you to create a new workarea.

Workarea list box

Lists the workareas that you can choose, together with various details about them. You can choose a workarea by selecting it and clicking OK.

Workarea

The names of the workareas that have been defined in the repository.

Owner

The username of the repository user who created the workarea.

Type

Indicates whether this is a private or shared workarea. Private workareas can be accessed only by the user who created them. Shared workareas can be accessed by any user to whom the owner grants access.

Check In Branch

(Versioned repositories only) The default branch, if any, to which versioned objects are checked in if they are updated via this workarea.

New

Enables you to create a new workarea. Clicking this button starts the Create Workarea Wizard, a predefined set of screen forms that takes you step by step through the process of creating a workarea.


Create Workarea Wizard: Options

The Create Workarea Wizard: Options screen provides the following four options for creating a workarea:

Option	Description
Create a default workarea	Simplest option - just enter the workarea name
Copy a workarea	Copies an existing workarea, but allows you to modify workarea details in the copy
Create a workarea based on a file-stored workarea specification	Uses rules and configurations stored in a file to create the workarea; you can modify these and other details
Create a custom workarea	Provides greatest choice - you can manually define all the details of the workarea
Note:	To edit an existing workarea, select the workarea and choose Edit→Edit Workarea.

Additional fields are displayed from each of the four available options. These allow you to name the workarea, provide a suitable description for the new workarea and, where appropriate, name a workarea to copy from.

Once you have made your selection, the wizard takes you step by step through the process of creating the workarea.

When you create a workarea, it is initially a private workarea, meaning that only you can access it. Subsequently you can, if you wish, grant one or more other users access to it, thus making it a shared workarea. If you later revoke access to the workarea from all other users, the workarea becomes private again.

For all except a default workarea, you can specify a default checkin branch if the automatic branching policy is enabled. You can also change the rules and configurations that make up the workarea specification.

A basic workarea specification, consisting merely of the rule LATEST (MAIN), is applied to all new workareas by default. This rule specifies that each time the workarea is refreshed it will display details of the latest version of all objects to which you have access on the MAIN branch. It is not necessary for a workarea to have any other rules or any configurations specified for it, but if you want to refine the workarea specification, you can do so using the wizard.


Application System dialog box

Specifies or changes the application system for the current tool.

Application System entry box

Identifies the name of the application system you want to use. If an application system is selected in the list box, then the name of that application system is displayed in this field.

Application System list box

Lists the names and owners of all the application system that you may use. If you select an application system from this list, its name is displayed in the application system entry box.


File - Print
   Print (File Menu)

Related Topics

Prints the contents of the active window. This option enables you to specify the range of pages to be printed, the print quality, the number of copies, the destination printer and other printing options.

Dialog box options

Printer

The name of the current printer. The current printer can be changed using the Setup button. If the current printer is the system (that is, the default) printer it is stated in this field.

Print Range

All

Prints all pages. All is the default print range value.

Pages

Prints a range of pages specified by the From and To fields. For example, entering 2 in the From field and 6 in the To field prints pages 2 to 6 inclusive.

Print Quality

Specifies the print density. The higher the print density, the better the print quality, but higher-quality copies may take longer to print.

Copies

The number of copies of the print job that you want to print.

Print to File

Determines whether or not the print job is printed to a specified file instead of being sent to the printer. When checked, the Print to File dialog box is displayed.

Page Numbers

Determines whether or not page numbers are printed at the bottom of each page of the print job.

Print to ASCII

Prints the textual content of the Navigator window to a text file. If this box is checked, a dialog box is displayed for you to specify the name and location of the text file. Note this option is available from the Repository Object Navigator only.

Page Title

Determines whether or not the title is printed at the top of each page of the print job.

Page Boundaries

Determines whether or not indicators are displayed showing the outermost edges of the printable area of the page.

Scale to Pages

X:

Determines the number of pages in the horizontal axis on which the data will be printed.

Y:

Determines the number of pages in the vertical axis on which the data will be printed.

Fit to Page

Determines whether or not the data is printed so that it fits onto one sheet of the currently selected paper size.

Setup button

Allows you to view or change the configuration of the current printer, or to choose a different printer if more than one is available. Selecting this button displays the Print Setup dialog box.


File - Print Preview
Print Preview (File Menu)

Related Topics

Displays the contents of the active window as it will appear when printed, and provides options for navigating through, and for changing the magnification of, the pages within the Print Preview window. The contents of the active window can also be printed directly from this preview window.

Print preview buttons

Print button

Displays the Print dialog box, allowing you to specify how and where the data is printed, and to initiate the print job. Selecting this button cancels the Print Preview window.

Next Page button

Shows how the next page of the data will appear when printed.

Prev Page button

Shows how the previous page of the data will appear when printed.

One Page/Two Page button

Specifies whether one or two pages are previewed at a time.

Zoom In button

Enlarges part of the page preview display.

Zoom Out button

Reduces the magnification of the page preview display.


File - Print Setup
Print Setup (File Menu)

Related Topics

Configures printer settings such as the destination printer, the paper size and the paper orientation. Advanced document properties set within an application can also be set. These settings will override the default settings made in Windows.

Dialog box options

Printer

Determines whether you want to use the default printer or one of the other currently connected printers. A dropdown list of currently connected printers is available. The default printer can be changed, and other printers connected, from the Settings option on the Windows Start menu.

Orientation

Determines whether the printout will appear in portrait or landscape format. Selecting the appropriate option button changes the image of the page accordingly in this field.

Size

Determines the paper size for the printer.

Source

Determines the source of the paper for the printer.

Options button

Displays the Options dialog box for the currently selected printer, allowing you to set some of the more advanced document printing options. Third party printer help is available for the Options dialog box.


File - Recent File
Recent file (File Menu)

Opens any of the four most recently opened files (diagrams or logic text) in the current workarea. Diagrams or logic files in other workareas which have been opened recently may also be listed, but cannot be opened using this option.


File - Exit
Exit (File Menu)

Exits from the tool.


Browse dialog box

Directories

The directory where the file that you want to embed or link to is located.

Drives

The drive where the file that you want to embed or link to is located.

Network... button

Locates a file on the network. For more information, select the Help button on the Connect Network Drive dialog box.


Print to File dialog box (Description not used by Designer in 2.1)

Related Topics

Allows you to specify the name of the file to which a print job is to be saved.

File Name

Specifies the name of the file (maximum of eight characters, plus a three-letter extension), including its path, to which you want to print the diagram.

Attention:	The filename must be different from the original filename, or the diagram must be saved to a different drive or directory.

Note:	If no file of this name currently exists, one will be created.

All the files of the specified type in the specified directory are listed below the File Name field.

Save File as Type

Specifies the file extension for the file. It also filters the File Name list so that only files of the specified type are listed.

Drives

Select the drive on which you want to store the file.

Directories

Select the directory where you want to store the file.

Network button

Opens the Connect Network Drive dialog box so that you can make a connection to a network drive. For more information, choose the Help button in that dialog box.


Edit - Undo/Redo
Undo/Redo (Edit Menu)

Related Topics

Undoes the last action performed on the active window. Only certain actions can be undone. If the last action was performed using Edit→Undo, and the action can be redone, the menu option changes to Edit→Redo.


Edit - Cut
Cut (Edit Menu)

Related Topics

Removes the selection and places it on the Clipboard. Any text and graphics that you place on the Clipboard remains there until you replace it with a new item. The contents of the Clipboard can be pasted back using Edit→Paste. This option does not remove data from the repository.

Note:	When working in the Property Palette, the changes you make are not immediately stored in the repository. The changes will only be committed to the repository when you change the focus (by making another window active in the application) or by saving recent property changes.


Edit - Copy
Copy (Edit Menu)

Related Topics

Copies the selection onto the Clipboard. Text or graphics that you copy to the Clipboard replaces the previous contents. The contents of the Clipboard can be pasted back using Edit→Paste.


Edit - Paste
Paste (Edit Menu)

Related Topics

Inserts the contents of the Clipboard at the insertion point, replacing any selection if the selected text or graphic can be replaced. To place items on the Clipboard use Edit→Copy or Edit→Cut.


Edit - Edit Workarea
Edit Workarea (Edit Menu)

Related Topics

This option enables you to perform various workarea operations. About

Note:	In the Repository Object Navigator, this option is available when you select the name of the workarea in the Navigator window, or when you select an object visible in that workarea.

You can:

•	edit the workarea properties (name, description)

•	edit the workarea specification (the rules and configurations that determine which objects appear in the workarea)

•	specify a default checkin branch for versioned objects in a particular workarea

In either case, the menu option starts the workarea wizard at the appropriate point.


Edit - Refresh Workarea
Refresh Workarea (Edit Menu)

Related Topics

Enables you to reapply the workarea specification rules, updating the display of the workarea contents as a result.

This option displays a dialog box from where you can:

•	synchronize the repository with a file system

•	preview the changes that will be made before refreshing

Refreshing re-evaluates the workarea contents according to the workarea rules specified. For example, if a rule specifies that the workarea is to include the latest object versions on a particular branch and a user has updated an object on that branch, refreshing the workarea will show the new version of the object.

Dialog box options

Synchronize

Synchronize mapped folders/files after refresh

Synchronizes the repository with a file system to which a container in the workarea is mapped. Selecting this box performs the synchronization when the workarea is refreshed.

Include (create) files new to the repository

If synchronization would normally result in the creation of new files in the repository, selecting this box causes this to happen. Clearing the box prevents creation of new repository files (i.e., only files that have been changed will be refreshed). This box is activated only if you select the previous one.

Preview

Preview changes before refreshing

Select this box if you want to see the effect on the workarea of the refresh operation before it is performed, otherwise leave the box clear. The preview lists which objects will be added to, updated in, and removed from, the workarea when it is refreshed.


Preview Changes in Workarea Before Refreshing dialog box

Related Topics

Dialog box options

Changes in repository

If you chose on the previous screen to preview changes in both the repository and the file system, you can choose between the two options here.

New

Lists the objects that will be added to the workarea when it is refreshed.

Changed

Lists the objects that will be updated in the workarea when it is refreshed.

Removed

Lists the objects that will be removed from the workarea when it is refreshed.


Edit - Requery All
   Requery All (Edit Menu)

Related Topics

Compares all the elements displayed in the active window with their repository elements and, if there are differences, makes the display consistent with the repository.


Edit - Requery Selection
   Requery Selection (Edit Menu)

Related Topics

Compares one or more selected elements in the active window with their repository elements and, if there are differences, makes the diagram consistent with the repository. This option is dimmed if no elements are selected in the active window.


Edit Workarea Wizard: Properties

Enables you to rename a workarea and change the workarea description.

The workarea you are currently working in is the one selected for editing.

Note: 	You cannot select an alternative workarea to edit using this window.

If you choose to rename your workarea, the new name must be unique in the repository.

Dialog box options

Name

The name of the workarea selected to edit. You can enter a new unique name to rename the workarea.

Description

The description of the workarea selected to edit. You can enter a new description.


Create / Edit Workarea Wizard: Rules Specification

Displays the rules, configurations or both that make up the current workarea specification.

Using this dialog you can:

•	load an existing workarea specification from a template file in your file system

•	edit the workarea specification

•	save the workarea specification to a file

If you are creating a new workarea by using a specification file or by copying an existing workarea, any included rules and configurations are displayed.

If you are creating a custom workarea and have not specified any other workarea or specification file as its basis, the default rule LATEST(MAIN) is displayed.

If you are editing an existing workarea, any rules and configurations associated with the workarea are displayed.

Dialog box options

Load from file

(Edit Workarea Wizard only) Enables you to load an existing specification from a file. Specification files are given the .CWS extension by default.

Edit

Displays the Edit Specification dialog box for you to edit the current specification by:

•	adding new rules and/or configurations to the specification

•	deleting rules and/or configurations from the specification

•	rearranging rules and/or configurations within the specification

Save to file

Allows you to save the specification to a template file in your file system. The file is assigned the .CWS extension unless you choose otherwise.


Edit Specification dialog box

A workarea specification or a configuration can be built from objects from a variety of sources. For example, you may base a configuration on the contents of a workarea and then include an existing configuration together with additional rules and specific versions of individual objects.

The Edit Specification dialog box allows you to do the following to the selected workarea specification or configuration:

•	add or remove rules

•	add or remove configurations

•	reorder the list of included rules and configurations

•	include or exclude specific objects

Dialog box options

For

Displays the name of the workarea or configuration whose specification you are editing

Rules tab

Enables you to select a rule to include in the list of member rules and configurations.

The fields displayed on the Rules tab depend on the selected rule. About

Configurations tab

Latest version

When checked, displays only the latest version of the configurations to which you have access. When clear, displays all versions of all configurations.

Configurations

Displays all configurations under version control that you have access rights to.

Filter

Allows you to enter search criteria to locate specific configurations. You can use wildcard characters, for example "%" to specify "any character".

	moves selected rule or configuration into the Member rules and configurations list
	moves selected rule or configuration out of the Member rules and configurations list
Member rules and configurations

Lists the rules and configurations currently associated with the workarea or configuration.

	moves the selected rule or configuration up one position in the member rules and configurations list
	moves the selected rule or configuration down one position in the member rules and configurations list
	includes objects in the workarea or configuration
	excludes objects from the workarea or configuration


Create / Edit Workarea Wizard: Default Checkin Branch

Displays all branches available to you, and enables you to set the default checkin branch.

The value <None> causes objects to be checked in by default on the branch from which they were checked out. In some cases, described below, the wizard sets this value automatically and you cannot change it.

If you want to use a branch other than those listed, create a new branch. How

If you are creating a default workarea or a workarea based on a specification file, the wizard selects the value <None>.

If you are creating a workarea based on an existing workarea, the default checkin branch for the workarea you are copying is selected.

If you are editing a selected workarea, the current default checkin branch for that workarea is selected.

Before setting the default checkin branch, the wizard checks the repository automatic branching policy. If the automatic branching policy is not enabled, the wizard selects the value <None>.

Dialog box options

Select the workarea default checkin branch

All available checkin branches for the repository are listed. Select the one you want to use as the default.

Remind me to merge objects to the new checkin branch

(Displayed for Edit Workarea only) Invokes the Merge Wizard at the end of an edit workarea operation. If you are changing the default checkin branch, you can use the wizard to merge changes from object versions on the old branch with versions on the branch to which you are changing.


Edit - Requery
Requery (Edit Menu)

Refreshes the version tree for the object currently displayed in the Version History Viewer, enabling you to see any recent changes that have been made.


Edit - Select All
Select All (Edit Menu)

Related Topics

Selects all items on the active diagram. All items are selected whether or not they were already selected.


Edit - Select Same Type
Select Same Type (Edit Menu)

Related Topics

Selects all items that are of the same element type as the current selection in the active diagram. This option is available only if you have selected a single diagram item.


Edit - Insert New Object
Insert New Object (Edit Menu)

Related Topics

Inserts an embedded object into the current diagram or creates a link between the current diagram and another file.

Dialog box options

The information displayed and requested in the dialog box will depend on you selecting one of the following options:

•	Create New

•	Create from File

Create New

Enables you to embed a new OLE object onto the diagram.

Object Type list box

Select the type of information you want to insert onto the diagram. The contents of the list box depend on which applications are installed on your computer support object linking and embedding.

Create from File

Enables you to embed or link to an existing OLE object onto the diagram.

File text box

The name of an existing file you want to insert as an embedded object onto the diagram. If you check the Link checkbox a link to this file will be created rather than embedding it.

Browse... button

Opens the Browse dialog box so that you can search for a particular source document.

Link checkbox

Indicates that a link to the specified file is to be created rather than embedding it.

Display As Icon checkbox

Indicates that the embedded object is displayed as an icon on the diagram.

Change Icon button

Changes the icon that represents an embedded object or linked information on a diagram. This button is only displayed when you check the Display As Icon checkbox. For more information, select the Help button on the Change Icon dialog box.

Result text box

Describes the result of the selected option.


Edit - Object
Object (Edit Menu)

Related Topics

This option is available only if an object has been created by selecting Edit→Insert New Object. The OLE menu options available from the Edit Menu is dependent on the type of object (embedded or linked) and the OLE capabilities of the application you used to create the object. The following menu options may be available:

Edit→<Object Name> Object→Edit

Edit→<Object Name> Object→Open

Edit→<Object Name> Object→Convert

Note: 	If you have used the Object Packager to embed a packaged object the options displayed on this menu will be different. For more information about OLE packages, see the Help documentation for Object Packager.


Edit - Object Edit/Open
Object Edit/Open (Edit Menu)

Related Topics

Edit

Opens the object in the current application window (the toolbars and menus will change). The <object name> Open menu option changes depending on the selected object. For example, the Designer application displays the Edit→Document Object→Edit menu option if the selected embedded object is a Microsoft Word document.

This menu option is available only if an embedded or linked object is selected.

Note:	If a package is selected on the active diagram, the Edit menu option changes to Package Object. Select Edit→Package Object→Edit Package to invoke the Object Packager application. The Object Packager can be used to edit the embedded or linked object.

Open

Opens the embedded or linked object in its own application window. The <object name> Open menu option changes depending on the object you select. For example, the Designer application displays the Edit→Bitmap Image Object→Open menu option if the selected embedded object is a Microsoft Paint image.

This option is available only if an embedded or linked object is selected.

Note:	If a package is selected on the active diagram, the Edit menu option changes to Package Object. Select Edit→Package Object→Activate Contents to view the contents of the package.


Edit - Object Convert
Object Convert (Edit Menu)

Related Topics

Converts an embedded object to a different file format or changes the display of an embedded or linked object.

The <object name> Convert menu option changes depending on the object you select. For example, the Designer application displays the Edit→Document Object→Convert menu option if the selected embedded object is a Microsoft Word document.

This menu option is available only if an embedded or linked object is selected.

Note:	If a package is selected on the active diagram, the menu option changes to Edit→Package Object→Convert.

Dialog box options

Current Type

Displays the type of object that you are converting or activating. For example, Microsoft Word.

Object Type list

Select the type of object to which you want to convert. The contents of the list box depend on which applications are installed on your computer support object linking and embedding.

Convert to

Converts the selected object to the type of information selected in the Object Type list box.

Activate As

Opens the selected object in the type of information selected in the Object Type list box, but after editing, returns the object to the type displayed in Current Type.

Display As Icon

Indicates that the embedded object is displayed as an icon on the diagram.

Change Icon... button

Changes the icon that represents an embedded object. This button is only displayed when you check the Display As Icon checkbox. For more information, select the Help button on the Change Icon dialog box.

Result

Describes the result of the selected option.


Edit - Links
Links (Edit Menu)

Related Topics

Displays and modifies existing links on the diagram. This option is dimmed if no links exist on the diagram.

Dialog box options

Links Box

Displays details for all links on the diagram, including the filename, the type and whether the tool updates the links automatically or manually.

Source

Displays the name and the location of the source file.

Type

Displays the application or type of application in which the linked object was created.

Update

Indicates how the information in the linked object is to be updated.

Automatic

Indicates that existing data will be updated every time new data becomes available.

Manual

Indicates that the data will only be updated when you select the Update Now button.

Update Now button

Updates all selected links in the Links box.

Open Source button

Opens the selected file in the source application ready for editing.

Change Source... button

Specifies a different source file for a selected link so that the link receives data from the new source file. For more information, use the context-sensitive help facility in the Change Source dialog box.

Break Link button

Breaks the link between the source file and the current diagram for all selected links.


Edit - Paste Link
Paste Link (Edit Menu)

Related Topics

Inserts a linked object from the Clipboard. The linked object is displayed on the diagram but is defined and stored in the source document.


View - Normal Size
Normal Size (View Menu)

Related Topics

Resets the magnification of the diagram in the active window to the magnification it was displayed when opened or created.


View - Zoom In
   Zoom In (View Menu)

Related Topics

Increases the magnification of the diagram in the active window. The new view of the diagram is centered around the same position as the view on which the magnification is based.


View - Zoom Out
   Zoom Out (View Menu)

Related Topics

Decreases the magnification of the diagram in the active window. The new view of the diagram is centered around the same position as the view on which the reduced magnification is based.


View - Fit to Area
   Fit to Area (View Menu)

Related Topics

Increases the magnification of a selected area of the diagram so that it fits the active window.


View - Fit to Selection
   Fit to Selection (View Menu)

Related Topics

Adjusts the magnification of items selected on the diagram in the active window so that they are displayed at the maximum size that can fit into that diagram window.

This option is available only if one or more items are selected on the diagram.


View - Fit to Diagram
   Fit to Diagram (View Menu)

Related Topics

Adjusts the magnification of the whole diagram in the active window so that it is displayed at the maximum size that can fit into that window.


View - Toolbar
Toolbar (View Menu)

Related Topics

Shows or hides the standard toolbar below the menu bar.


View - Tool Palette
Tool Palette (View Menu)

Related Topics

Shows or hides the tool palette.


View - Status Bar
Status Bar (View Menu)

Related Topics

Shows or hides the status bar at the bottom of the application window.


View - Spreadtable View
      Spreadtable View/Default View (View Menu)

Related Topics

The Property Palette can display properties in one of two views: spreadtable view, and default view.

Spreadtable View   [image]    In spreadtable view,  you can list more than one set of properties in the spreadtable. For example, you can select two or more tables from the Navigator and compare their property values on the spreadtable.

Default View  [image]    In default view, the Property Palette is displayed as a two-column grid, with the property names listed vertically and their values listed alongside.


View - Intersection View
      Union View/Intersection View (View Menu)

Related Topics

The Property Palette can show a set of properties in one of two views: union (the default) and intersection. The union/intersection view applies to conflicts of property types (e.g., Name, Length) and not to conflicts of property values (e.g., HEADQUARTERS, 10). Thus the setting of this button is not relevant when the selected repository objects are of the same type because in this case they have the same set of property types.

If there is a property type that has been given different values for different repository objects, then that property value is displayed in the Property Palette as a set of hashes (#####) regardless of the Union/Intersection button.

Union View    [image]   In Union View, the Property Palette lists the combined property types, i.e., all the property types of the selected object types.

Intersection View   [image]   In Intersection View, the Property Palette lists only the common property types, i.e., the property types that appear in all of the selected types.


View - Grid
Grid (View Menu)

Related Topics

Shows or hides the grid in the active window.


Layout - Autolayout
   Autolayout (Layout Menu)

Related Topics

Repositions the selected elements on the active diagram so that they are presented in a different syntactically correct layout. This process can be repeated until the preferred layout of elements is achieved. If no elements are selected on the active diagram, this option will reposition all the elements on the active diagram.


Layout - Autolayout to New Area
Autolayout to New Area (Layout Menu)

Related Topics

Repositions the selected elements within a newly defined autolayout area on the active diagram so that they are presented in a syntactically correct layout. This process can be repeated until the preferred layout of elements is achieved on the active diagram.

If the newly defined autolayout area is not large enough to contain the selected elements at their current sizes, the selected elements will not be automatically laid out.


Layout - Autolayout to Same Area
Autolayout To Same Area (Layout Menu)

Related Topics

Repositions the selected elements within the previously defined autolayout area on the active diagram so that they are displayed in a syntactically correct layout. This process can be repeated until the preferred layout of elements is displayed on the active diagram.

The previously defined autolayout area must be large enough to contain the selected elements at their current sizes.


Layout - Previous Layout
   Previous Layout (Layout Menu)

Related Topics

Undoes the previous autolayout operation performed on the active diagram. This option is available only if:

•	elements on the diagram have been automatically repositioned two or more times in succession, and no other subsequent actions have been performed

•	there are still previous autolayout operations to be restored.


Layout - Minimize Number of Pages
Minimize Number of Pages (Layout Menu)

Related Topics

Minimizes the number of pages used for the active diagram. Since deleting or moving the last diagram item on a page does not also automatically delete the page, a diagram may include redundant blank pages outside the outermost points of any items on the diagram. This option fits the area of the diagram within its outermost points into as few pages as possible, by shifting the diagram to the top left corner and removing any redundant blank pages.


Options - Customize Property Palette
Customize Property Palette (Options Menu)

Customizes which properties are displayed on the Property Palette.

Dialog box options

Show

Show Owning Folder

Displays or hides the name of the owning container for an element.

Show Version Label

Displays or hides the version label property in the Property Palette.

Show Audit Properties

Displays the audit properties (date created, date changed etc.) in the Property Palette.

Property Clipboard

Include Multi Line Text Properties

Includes or excludes multi-line text properties in the Properties Clipboard, used when copying properties.

Automatically switch to spreadtable mode on multi insert

If active, automatically switches the Property Palette to spreadtable view when creating more than one element in a single operation.


Options - Text Editor Options
Text Editor Options (Options Menu)

Related Topics

Defines Text Editor options. This enables you to specify which text editor to use for the values of repository definition properties that are stored in ASCII or HTML format.

Default text editors are set up for ASCII text and HTML text based on the settings in the Windows Registry. You can specify alternative editors for either or both of these kinds of text.

Dialog box options

Text Editor

Select command to run the ASCII editor

The command that runs the ASCII text editor. Ensure that the filename is followed by the characters <SPACE>%1 in order for the command to function correctly.

Browse button

Locates the .EXE file for the ASCII text editor. Selecting this button displays the Browse dialog box.

HTML Editor

Select command to run the HTML editor

The command that runs the HTML editor. If you specify Netscape Navigator as the editor, ensure that the filename is followed by the characters <SPACE>"%1" for the command to function correctly.

Browse Button

Locates the .EXE file for the HTML editor. Selecting this button displays the Browse dialog box.


Options - Broadcast Options
Broadcast Options (Options Menu)

Related Topics

Defines broadcast options.

Dialog box options

Broadcast Notifications

Disabled

Turns off the broadcasting mechanism, i.e., the user does not receive (or send) notification messages.

Desktop only

Broadcasts all changes made in the current tool to all tools running on this machine.

Network

Broadcasts all changes made in the current tool to all users participating in the network broadcasting mechanism.


Options - Diagnostics
Diagnostics (Options Menu)

Allows you to set diagnostic file and trace settings. This feature should not be used unless requested to do so by your Oracle customer support representative. If you inadvertently set any of the diagnostic options you may find that the tool's performance is affected. If you do find any degradation in performance, click the Disable Option button to switch off the diagnostics facility.


Font dialog box

Allows you to specify the details of the font to be used for a text item.

Dialog box options

Font

Specifies the font to be used. You can choose a font from the list.

Font Style

Specifies the style for the selected font. You can choose a style from the list. Available styles are: regular, italic, bold and bold italic.

Size

Specifies the size in points of the font for this text item. A point is 1/72nd of an inch.

Sample

Shows an example of how this text item will appear with the current font options.

Script

Specifies the character set to be used for the selected text item.


Tools - Navigator
Navigator (Tools Menu)

Related Topics

Opens a new Navigator if none is open, or makes the Navigator window the active window if the Property Palette is active.

Navigator windows use a tree structure to represent the repository definitions that are recorded  in the repository, and the associations between those definitions.


Tools - Property Palette
Property Palette (Tools Menu)

Related Topics

Opens a new Property Palette if none is open or if the present palette is pinned, or makes the latest Property Palette the active window if the Navigator window is active.

Property Palettes display the properties of definitions, e.g. table definitions, that are recorded in the repository.


Edit - TextPad
   TextPad (Edit Menu)

Related Topics

Opens the TextPad, which enables you to attach textual information to the selected text property.


Edit - ASCII Editor
   ASCII Editor (Edit Menu)

Related Topics

Opens the ASCII editor, which enables you to attach ASCII text to the selected multi-line text property.


Edit - HTML Editor
   HTML Editor (Edit Menu)

Related Topics

Opens the HTML editor, which enables you to attach HTML text to the selected multi-line text property.


Tools - Process Modeler
Process Modeler (Tools Menu)

Related Topics

Invokes the Process Modeler with the same database connection and workarea as the current tool.


Tools - Dataflow Diagrammer
Dataflow Diagrammer (Tools Menu)

Related Topics

Invokes the Dataflow Diagrammer with the same database connection and workarea as the current tool.


Tools - Repository Reports
Repository Reports (Tools Menu)

Invokes the Repository Reports tool, which enables you to run reports about the contents of the repository.


Tools - Entity Relationship Diagrammer
Entity Relationship Diagrammer (Tools Menu)

Related Topics

Invokes the Entity Relationship Diagrammer with the same database connection and workarea as the current tool.


Tools - Function Hierarchy Diagrammer
Function Hierarchy Diagrammer (Tools Menu)

Related Topics

Invokes the Function Hierarchy Diagrammer with the same database connection and workarea as the current tool.


Tools - SQL Plus
SQL*Plus (Tools Menu)

Opens a SQL*Plus window.


Tools - Repository Object Navigator
Repository Object Navigator (Tools Menu)

Invokes the Repository Object Navigator with the same database connection as the current tool.


Tools - Dependency Manager
Dependency Manager (Tools Menu)

Related Topics

Invokes the Dependency Manager, from which you can examine dependency information stored in the repository. You can also use the Dependency Manager to edit some repository information.


Tools - Matrix Diagrammer
Matrix Diagrammer (Tools Menu)

Invokes the Matrix Diagrammer with the same database connection and workarea as the current tool.


Tools - Design Editor
Design Editor (Tools Menu)

Related Topics

Invokes the Design Editor with the same database connection and workarea as the current tool.


Window - New Window
New Window (Window Menu)

Creates a new diagram window containing the active diagram. You can use this new window to display a different part of the active diagram.


Window - Cascade
Cascade (Window Menu)

Arranges all your open windows so that they overlap and each window's title bar is visible.


Window - Tile Horizontally
Tile Horizontally (Window Menu)

Arranges all your open windows so that they fit horizontally in the main window. The title bar and a portion of the tool remain visible for each window. The windows are displayed at the largest possible size that will fit into the tool window without overlapping each other or the icons of minimized tool windows.


Window - Tile Vertically
Tile Vertically (Window Menu)

Arranges all your open windows so that they fit vertically in the main window. The title bar and a portion of the tool remain visible for each window.


Window - Arrange Icons
Arrange Icons (Window Menu)

Arranges your window icons so that they line up neatly and do not overlap.


Window - Window Name
1, 2, 3... Command (Window Menu)

Switches to the window and makes it active. A check mark is displayed next to the name of the active window.


Window - Arrange Windows
Arrange Windows (Window Menu)

Displays all open windows so that they do not overlap.


Help - Help Topics
Help Topics (Help Menu)

Related Topics

Displays a list of the main subject areas in the online documentation system.


Help - Show Keys
Show Keys (Help Menu)

Displays the shortcut keys for the current tool.


Help - How to use Help
How to Use Help (Help Menu)

Related Topics

Displays general information on how to use the Microsoft Windows help.


Help - About
About (Help Menu)

Displays copyright and version number information about this application. You might need to know the version number for product support purposes.


Help - Customer Support
Customer Support (Help Menu)

Displays an Oracle Support Problem Report (displayed in your default ASCII text editor) that you are requested to complete before contacting Oracle Support for assistance. The report asks for details about you, your environment setup and details about the problem, including any steps to reproduce the problem. By completing this form prior to contacting Oracle Support, you will aid the processing and response to your request.

A default text editor is set up for ASCII text based on the settings in the Windows Registry. You can specify an alternative editor by using Options→Text Editor Options.


Context-Sensitive Help button
   Context-Sensitive Help

Related Topics

Provides access to context-sensitive help information about the menu options, standard toolbar and drawing toolbar buttons.

Selecting this button, or pressing SHIFT+F1, and then selecting a menu option, standard toolbar button or palette button, displays help information for the chosen item.


   Select button

Related Topics

Puts the active diagram in Select mode. In Select mode, any element or association on the diagram can be selected or deselected by clicking on it. Selected items are displayed with grab bars. When an item has been selected, you can move it, resize it or set the preferences (e.g., fill color, line color, line width or font settings) for it.


Line width button
   Line Width

Changes the line width of the selected elements and associations on the active diagram.


Line color button
   Line Color

Changes the line color of the selected elements and associations on the active diagram.


Fill color button
   Fill Color

Changes the fill color of the selected elements and associations on the active diagram.


Font button
   Font

Changes the font used by the selected elements and associations on the active diagram.


Utilities - Resequence
Resequence (Utilities Menu)

Related Topics

Allows you to change the order in which some types of selected elements are ordered in the Navigator. For example, you can resequence columns in a table definition.

Elements that can be resequenced are indicated in the Navigator window by [image].

Dialog box options

List box

Lists the repository definitions that you can resequence. This list box allows single selection only. Use the resequence buttons to move a selected definition up or down the list box.

Resequence buttons

Specifies the order in which the definitions are to be displayed on the Navigator window and diagrams.

Tip:	Instead of using the Resequence buttons you can hold down the CTRL key and press the Up and Down arrows.


Utilities - Select in Other Tools
Select in Other Tools (Utilities Menu)

Related Topics

Selects the same repository objects, as currently selected on the active tool, in other tools (providing that the other tools are open in the same context).


Utilities - Update Columns in a Domain
Update Columns in a Domain (Utilities Menu)

Related Topics

Updates all the appropriate columns/Oracle object type attributes with the property details of the selected domain. You might use this, for example, when you make a change to a domain and want to propagate these changes to all the columns/type attributes that use that domain.

This utility overwrites any properties in a column/attribute that conflict with the same property in the column's/attribute's domain. Null values in the domain replace any non-null values. The exception to this is the Default Values property, which is overwritten only if the corresponding column/attribute property has a null value.


Utilities - Force Delete
Force Delete (Utilities Menu)

Related Topics

Invokes the Force Delete or Force Purge wizard. These wizards remove selected repository objects or secondary access controlled (SAC) elements, regardless of any delete constraints that may have been defined for the corresponding object type. About

Each wizard is a predefined set of screen forms that takes you step by step through the force delete or force purge process.

Note:	It is possible to undo a force delete operation. Objects removed in this way are placed in the workarea wastebasket, from where they can be recovered. However, it is not possible to recover references or child elements of force-deleted objects.

It is not possible to undo a force purge operation.

The Force Delete Wizard is invoked if the selection is a non-versioned object or a SAC element of any kind of object. In this case the selection is removed to the workarea wastebasket. If the selection is a checked-out versioned object, Force Delete has no effect. You can use the Force Delete Wizard only if you have the FORCE system privilege, and DELETE access rights to the workarea and the owning container.

The Force Purge Wizard is invoked if the selection is a checked-in versioned object. The version visible in your workarea is completely removed from the repository and cannot be recovered. You can use this wizard only if you have the FORCE or PURGE system privileges, and DELETE access rights to the owning container.


Force Delete/Force Purge: Objects Selected

Lists the objects that you have selected for the force delete or force purge operation.

If the list is incorrect, click Cancel and reselect the objects, otherwise click Next.

Path

The hierarchical path of the object in your workarea.

Element Type

The repository element type for this object.


Force Delete/Force Purge: Purged Objects
Force Purge: Purged Objects

Lists the objects that will be purged (that is, have all object versions removed).

Status

A value of OK indicates that the purge operation can continue for this object. If an object is checked in, this is indicated; you will need to select the object and check it out before the operation can continue.

An example of when an object in the list might be checked in would be when purging a domain that is referenced by a column. In this case the column will be cascade deleted. However, if the table to which the column belongs is checked in, it must be checked out before the column can be deleted and the operation can continue.

Path

The hierarchical path of the object in your workarea.

Element Type

The repository element type for this object.

Check Out

Checks out a selected item in the list that is marked as checked in, so that the operation can continue.


Force Delete/Force Purge: Deleted Objects

Lists the objects that will be deleted.

Status

A value of OK indicates that the delete operation can continue for this object. If an object is checked in, this is indicated; you will need to select the object and check it out before the operation can continue.

An example of when an object in the list might be checked in would be when deleting a domain that is referenced by a column. In this case the column will be cascade deleted. However, if the table to which the column belongs is checked in, it must be checked out before the column can be deleted and the operation can continue.

Path

The hierarchical path of the object in your workarea.

Element Type

The repository element type for this object.

Check Out

Checks out a selected item in the list that is marked as checked in, so that the operation can continue.


Force Delete/Force Purge: References

Lists reference properties for the objects that you are deleting or purging. These references will be nullified. Note that, although deleted objects (but not purged objects) can be restored from the wastebasket, the references cannot.

Status

A value of OK indicates that the operation can continue. If an object is checked in, this is indicated; you will need to select the object and check it out before the operation can continue.

Property

The element type of the reference property.

Referencing Element/Element Type

The element (and its type) that references the object selected for delete or purge. For example, if you are deleting a domain that is referenced by a column, this field shows the column name and its path in the repository.

Referenced Element/Element Type

The element (and its type) that is referenced by the element in the previous pair of fields. For example, if you are deleting a domain that is referenced by a column, this field shows the domain name and its path in the repository.

Check Out

Checks out a selected item in the list that is marked as checked in, so that the operation can continue.


Utilities - External References
External References (Utilities Menu and Configuration Wizard)

Related Topics!Alink(COM_Listing_external_references, , , )

Enables you to check whether repository objects in a selected workarea, container or configuration make reference to objects outside that workarea, container or configuration. You can then include any of these externally referenced objects in the workarea, container or configuration.

Dialog box options

For

The name and (if under version control) the version label for this workarea, container or configuration.

List Mandatory Only

When this check box is selected, clicking the List button causes the display to show only the mandatory external references for this workarea, container or configuration.

Recurse Sub Folders

When this check box is selected, clicking the List button causes the display to also show external references for child objects of this workarea, container or configuration (for example, sub-folders of a folder).

Name

The name of an object for which an external reference exists.

Type

The type of object listed.

Reason

The reason why the reference to this object is classed as an external reference:

Lost + Found	The object resides in the Lost+Found area, i.e. it has no owning container
No Access Rights	You do not have access to the container that owns this object
Not in Folder	This object is not in the selected container
Not in Workarea	This object is not in the selected workarea
Not in Repository	This object is not in the repository; this message indicates a problem that requires resolution, e.g. by creating the required object
Wrong Version	The referenced version of this object has no record of the reference; you can use Change Version to choose a different version
Status

Indicates whether the object is checked in, checked out or not under version control. If an object is not checked in, you cannot include it in a workarea.

Mandatory

Indicates whether this is a mandatory reference.

Version

The version label for this object (if it is under version control).

Include Iteratively

When this check box is selected, selecting objects from the list and clicking the Include button causes these objects to be iteratively included in the selected workarea, container or configuration. This means that any objects referenced by the externally referenced objects are also included, as well as any objects referenced by those extra objects, and so on until all referenced objects are included. Example

Show Latest on Branch

Appears only if workarea or configuration selected. For objects under version control, this enables you to list objects from a checkin branch other than the default.

List

Redisplays the list based on the status of the List Mandatory Only and Recurse Sub Folders check boxes.

Select All

Selects all the objects in the list of references. Used in conjunction with the Include button.

Include

For objects selected in the list, includes these objects in the container identified by the For: field.

Change Version

If the For field shows a workarea or configuration name, then for a selected object in the list, this allows you to list a different version of that object (if the object is under version control).

List References

For a selected object in the list, shows the objects that reference it and the kind of reference they make to it.


Include iteratively - example
Iterative inclusion - example

Assume that a container called Folder1 has an entity, ENT_A, which has a relationship to ENT_B in a different container, Folder2. ENT_B, in turn, has references to ENT_X, ENT_Y and ENT_Z in other containers. You select Folder1 and list its external references. You see only ENT_B in the list. You want to include ENT_B in Folder1, so you select ENT_B in the list.

If you clicked Include at this point, you would include only ENT_B in Folder1. However, you want to include not only ENT_B but any other objects that it references, and any other objects that they reference, and so on. To do so, you select the Include Iteratively check box and click Include.


Utilities - Extended Copy
Extended Copy (Utilities Menu)

Related Topics

Copies one or more selected PAC elements within a workarea, enabling you to specify what to do about references to other objects. The copies are renamed with a system-generated or a user-defined name.

This option invokes the Extended Copy Wizard, a series of screens that takes you step by step through the copy process.


Extended Copy Wizard:  Copy List

Specifies the complete set of objects to be copied.

Target Container

(Mandatory)  The container to which the objects are to be copied.

Objects to Copy

Lists the set of objects that are to be copied.

Path

The complete repository path specification of an object to be copied.

Element Type

The element type for this object.

Add

Enables you to include further objects in the set to be copied.

Remove

Removes selected objects from the copy list.

Copy Dependencies

When checked, copies any dependency information created for the objects by the Dependency Manager tool. When cleared, no dependency information is copied.


Extended Copy Wizard:  References

Lists all objects referenced by those in the copy set. You can choose to copy the referenced objects, leave them as they are, nullify the reference properties or remap the references to different objects.

Type

Type of object identified by Name.

Name

The name of a referenced object.

In Target ?

Indicates whether the referenced object is owned by the target container.

Copy

Copies the referenced object as well as the referencing object, and updates the reference properties to point to the new copy of the object.

Leave

Specifies that the referenced object is not copied, nor are the reference properties updated. This applies only to those objects that are known as "shareable" (that is, they can be referenced from a container other than their own). The exceptions are listed here.

Null

For optional references only, sets the reference properties to null in the new copy of the object. Does not apply to mandatory references.

Remap

Enables you to change the reference properties to point to a different object. Checking this box displays a screen from which you can choose a different object.

Remap to

If Remap is checked, this field identifies a likely candidate for the remap (an object with the same name and type) in the target container, if such an object exists. If you choose a different object, it is shown here.

Details

For a selected object in the referenced objects list, indicates which objects reference it.

Set Remap

Changes the reference properties to point to the object indicated in the Remap To field.


Extended Copy Wizard:  Reference Details

For a selected object in the referenced objects list, indicates which objects reference it.

Type

The type of object that references the object shown at the top of the screen.

Name

The name of an object that references the object shown.

Property

The property through which the object is referenced.

Mandatory

Indicates whether this is a mandatory reference.


Extended Copy Wizard:  Name Change

Enables you to specify a new name for a copied object. Lists all the objects to be copied.

Original Path

The repository path and name of the object being copied.

Copy Name

The name you want the copy to have. By default the name of the copy is name_1, where name is the name of the original object. You can specify a different name for the copy here.


Utilities - Publish Diagrams
Publish Diagrams (Utilities Menu)

Related Topics

Publishes diagrams to a file or to the Repository Object Browser (ROB).

This option opens the Publish Diagrams dialog.


Publish Diagrams dialog

Enables you to publish Designer diagrams to the Repository Object Browser (ROB) or to save them as files to a file system directory.

Available Diagrams pane

Shows the diagrams within the current workarea.  If you want to publish a subset of these diagrams, click the diagram or diagrams that you want to publish.

Single right arrow

Click to move the diagrams highlighted in the Available Diagrams pane to the Selected Diagrams pane.

Single left arrow

Click to move diagrams highlighted in the Selected Diagrams pane to the Available Diagrams pane.

Double right arrow

Click to move all diagrams in the Available Diagrams pane into the Selected Diagrams pane.

Double left arrow

Click to move all diagrams in the Selected Diagrams pane to the Available Diagrams pane.

Selected Diagrams pane

Diagrams listed in this pane will be published when you click the OK button.  If a diagram was active in the Design Editor when you opened the Publish Diagrams dialog, it will automatically be listed in this pane.

File Name text box

This is enabled only if the "Publish to File" option is chosen (see below). This text box displays the target file name for the diagram currently highlighted in the Selected Diagrams pane. By default the target file name is the same as the diagram name in the repository.  You can change the target file name by overtyping the text in this box.

Destination group

Use the options in this group to specify the destination for publishing.

Publish to Repository Object Browser option

Choose this option to publish the diagrams to the Repository Object Browser.

Publish to File option

Choose this option to publish the diagrams to files.

Directory text box

This text box shows the file system directory to which the files containing the diagrams will be written.  A directory will be suggested, which will be one of the following:

-	the mapped directory of the application system, if the selected diagrams belong to one application system

-	the directory chosen during the previous publish operation

-	the system temporary directory.

You can change the suggested directory by overtyping the text in this box, or by using the Browse button.

Browse button

Click to open a browse dialog, though which you can choose an existing directory.

Publish Format text box

Choose a format for the published diagrams from the drop-down list.  You can choose from PNG, GIF, TIFF, JPEG and BMP.


Version - Check In
   Check In (Version Menu)

Related Topics

Checks in all the selected objects. You can specify checkin options and enter notes that you want to associate with the objects.

This option is valid only if the objects selected are either checked out or are not yet under version control. Checking in an object that is not yet under version control adds this object to version control.

Choosing this option displays the Check In dialog box.  About


Check In dialog box

Related Topics

Checks in all the selected objects. You can choose the branch to which you want to check in the objects as well as specifying checkout options and entering notes that you want to associate with the objects.  How

Objects selected for check in

Lists all objects selected for check in. These can include objects not under version control, objects mapped to a repository container but not uploaded to the repository, and checked-out objects.

Note:	All objects listed here, whether they are highlighted or not, will be checked in when you click OK.

(Not applicable when using the Version History Viewer as this tool operates within the context of only one object.)

Options for object_name

Current checkin branch

(Display only)  The name of the current checkin branch for this object. You can change the checkin branch in the Use branch field.

Use branch

For existing objects, enables you to check in this object to a branch other than the one from which you checked out the object. If the object was checked out locked by another user from a branch, you cannot check in your object version to that same branch.

For new objects, lists the branch to which the object will be checked in:

•	If no default checkin branch is set, the object is checked in to the MAIN branch.

•	If a default checkin branch is set, the object is checked in to the default checkin branch in addition to the MAIN branch.

(Not applicable when using the Version History Viewer as this tool operates within the context of only one object.)

Version label

The version label attached to each object when checked in. Depending on the repository policy, this version label can be generated automatically by the system, or defined by the user.  About

Use checkout notes

Determines whether you want to use the same notes for checkin that you specified for checkout.

Check out after checkin

Determines whether you want to check out the objects again immediately after checkin. This enables you to continue working on the object after ensuring that the latest version is available to other users.

If the objects were initially checked out with a lock, they will be checked out again with locks.

Check in even if unchanged

Determines whether the objects are checked in even if they have not changed since they were checked out.

Checkin notes

Any notes you enter here will apply to all the selected objects in the Objects selected for check in list.


Version - Check Out
   Check Out (Version Menu)

Related Topics

Checks out all the selected object versions. You can specify checkout options and enter notes that you want to associate with the objects.

This option is valid only if the selected object versions are checked in.

Choosing this option displays the Check Out dialog box.  About


Check Out dialog box

Related Topics

Checks out all the selected object versions. You can specify checkout options and enter notes that you want to associate with the objects.  How

Objects selected for check out

Lists the objects you have chosen to check out.

(Not applicable when using the Version History Viewer as this tool operates within the context of only one object.)

Options for object_name

Lock

Determines whether the object is locked when it is checked out. Locking the object prevents anyone else from checking in another version onto the same branch until the lock is removed.

If a strict locking policy is in force, you cannot change this option as the strict locking policy ensures that every checkout is automatically set to locked.

Check out latest

Determines whether the latest version of the object is to be checked out, regardless of the version that is selected. This option is dimmed if the latest version is already selected.

(Not applicable when using the Version History Viewer as this tool operates within the context of only one object.)

Version dependencies

Determines whether the dependency links to any objects referenced by this object are to be versioned as well (but not the referenced objects themselves).

Checkout notes

Any notes you enter here will apply to all the selected objects in the Objects selected for check out list.


Version - Check Out Contents
Check Out Contents (Version Menu)

Related Topics

Checks out all the object versions within a specified context (checks out the 'contents' of the context element).

Depending on the type of sub-context you can specify various options, including whether to recurse subcontainers, and whether to check out the context element itself. Examples of context elements are workareas and containers.

Selecting the Recurse subcontainer option checks out all subcontainers and their contents as well as the top level contents of the context element. Selecting the Check out sub-context itself option checks out the selected context element itself, as well as its contents.

For

Workarea

The name of the selected workarea. Use the Browse button to select an alternative workarea.

Sub-context

Enables you to select one of the following sub-context types:

•	Entire Workarea

•	Container

•	Configuration

•	Diagram

•	User-Defined Set

Enter the name of the selected sub-context in the adjacent field, for example, the name of the container for which you want to check out its contents. Use the Browse button to locate and select the sub-context element.

Recurse subcontainers

Determines whether all subcontainers for a selected container, together with their contents, are checked out.

This option is not applicable for workareas; if checking out the contents of a workarea, all objects within that workarea, regardless of which container they are in, are always checked out.

Preview checkout list

Determines whether the Preview Checkout dialog box is displayed before the checkout operation. This dialog box enables you to refine the selection of objects for check out by specifying which of the objects within a group of objects (sub-context) you want to check out.  About

Check out sub-context itself

Determines whether the sub-context element itself is checked out in addition to its contents.

This option is not applicable for workareas.

Check out system folder

Only applicable for workareas, this option determines whether the system folder is also checked out.


Version - Compare Previous Version
   Compare Previous Version (Version Menu)

Related Topics

Compares a version of an object with its immediately previous version, and displays the results of the compare operation in the Compare window.

The version of the object currently in the workarea view is indicated by an arrow in the Version History Viewer display area, if this tool is active for the object.


List Checkouts dialog box

Related Topics

Lists all the repository objects in a selected context that are checked out, are not under version control or are new file system files. Other details are also displayed where applicable, for example, object type, checkout and checkin dates and other version details. The selection of objects displayed is determined by the selection criteria you chose previously in the List Checkouts: Criteria dialog box.  About

From this dialog box you can also:

•	check in all or selected objects

•	undo a checkout

•	add new objects to version control (by checking in the objects)

•	compare an object version with its previous version

For

(Display only) The name of the selected workarea and sub-context (entire workarea, container type, configuration, diagram or user-defined set), and the default checkin branch (if any).

Object details

The following object details are displayed:

Name	The name of the object.
Predecessor Version	For objects already in version control, the details of the version from which the checkout was performed.
Version Label	The version label attached to the object version. Depending on the workarea rules, this version label may have been generated automatically by the system, or defined by the user.
Status	The object status: this can be Checked Out, Not Versioned or New File System File.
Type	The type of the object.
Date Checked Out	The date when the object was last checked out.
Checked Out By	The name of the user who last checked out the object.
New Query

Redisplays the List Checkouts: Criteria dialog box, enabling you to change the criteria determining which objects are displayed in the List Checkouts dialog box.

Check in

Checks in any objects selected in the list.

Undo Checkout

Undoes the checkout of any checked-out objects selected in the list.

Compare

Compares, with its previous version, a checked-out object selected in the list.

Select All

Selects all objects in the list.


Version - List Checkouts
List Checkouts (Version Menu)

Related Topics

Displays the List Checkouts: Criteria dialog box, enabling you to determine which of the objects within a selected context will have their details displayed in the List Checkouts dialog box.  About

For

Workarea

The name of the selected workarea. Use the Browse button to select an alternative workarea.

Sub-context

Enables you to select one of the following sub-context types:

•	Entire Workarea

•	Container

•	Configuration

•	Diagram

•	User-Defined Set

Enter the name of the selected sub-context in the adjacent field, for example, the name of the container for which you want to list checkouts. Use the Browse button to locate and select the sub-context element.

Show

Checked-out objects

Determines whether all checked-out objects for the selected workarea and sub-context are displayed in the List Checkouts dialog box.

Non versioned objects

Determines whether repository objects that have not been added yet to version control are displayed in the List Checkouts dialog box.

Non repository files

Determines whether objects mapped to a repository container but not uploaded to the repository are displayed in the List Checkouts dialog box.

Recurse subcontainers

Determines whether all subcontainers and their contents are displayed in the List Checkouts dialog box, in addition to the top level contents of the context element.

Checked out / Created

By me

Determines whether only those objects that are checked out by you, or created by you (but not added yet to version control), are displayed in the List Checkouts dialog box.

By anybody

Determines whether all those objects that are checked out by anybody, or created by anybody (but not added yet to version control), are displayed in the List Checkouts dialog box.


Preview Checkout dialog box

Related Topics

Displayed if you selected the Preview checkout list option on the Check Out Contents dialog box, this dialog box enables you to refine the selection of objects for check out by specifying which of the objects within a group of objects (sub-context) you want to check out.

For

(Display only) The name of the selected workarea and sub-context (entire workarea, container, configuration, diagram or user-defined set), and the default checkin branch (if any).

Object details

The following object details are displayed:

Name	The object name and path in the repository.
Version	The branch and version number for the object.
Version Label	The version label attached to the object version. Depending on the workarea rules, this version label may have been generated automatically by the system, or defined by the user.
Latest On Branch	Indicates whether the object version is the latest on the branch.
Type	The type of the object.
Check Out

Checks out any objects selected in the list.

Select All

Selects all objects in the list.


Version - Undo Checkout
   Undo Checkout (Version Menu)

Related Topics

Abandons (undoes) the checkout of all selected object versions. This reverts the object to the state it was in prior to being checked out.  About

List

The selected object versions for which you want to undo the checkouts.

(Not applicable when using the Version History Viewer as this tool operates within the context of only one object.)

Save filesystem changes (saved to <filename>.KEEP)

Displayed only if the selected object is a mapped file, this option saves any changes made since the object was checked out. By default, when you undo a checkout, any changes made since the object was checked out are lost. However, if a selected object is a mapped file, this option allows you to preserve the changes in a separate file. The file is called <filename>.KEEP, where <filename> is the name of the original file.


Version - View Version Events
View Version Events (Version Menu)

Related Topics

Displays the Version Event Viewer in which you can view event details of an object and its versions.  How

For each event you can view information including:

•	the type of event (checkin, checkout, locked, branched or merged)

•	the version label

•	the name of the object

•	the branch on which the version resides

•	the date the event occurred

•	the user who initiated the event

•	notes about the event


Version Event Viewer window

Related Topics

The Version Event Viewer displays details of all events that have occurred for an object.

You can re-sequence the information displayed and choose to display only selected information.  How

Note:	Any refinements of the details displayed are not reflected in the Event Viewer window until you click the Rescan button.

Event History for

The name of the object for which the events are displayed.

Start date field

The start date for any events displayed in the window. To activate this field, enable the Start date checkbox.

End date field

The end date for any events displayed in the window. To activate this field, enable the End date checkbox.

Start date checkbox

Activates the start date field, enabling you to specify a start date for any events displayed in the window.

End date checkbox

Activates the end date field, enabling you to specify an end date for any events displayed in the window.

Exclude Checkouts

Excludes any checkout event details. Checkout details are overwritten each time the object is checked in, so checkout details are only shown if the object currently has a checked-out version.

Report Key panel

Enables you to rearrange the report display and to include or exclude selected information from the display.

Display list

Displays a list of the details currently displayed in the report, including the order in which they are displayed and whether they appear in the left or right columns.

To add any additional details to the report, select the chosen detail from the drop-down list and click Add.

To remove or reorder any details, select the detail from this display list and click the appropriate button.

Drop-down list

A list of all possible event details that can be displayed in the report.

To add any additional details to the report, select the chosen detail from the drop-down list and click Add.

Add

Adds the detail selected from the drop-down list to the report.

Remove

Removes the detail selected in the display list from the report.

Higher

Moves the detail selected in the display list one position higher up in the order of details in the same column.

Lower

Moves the detail selected in the display list one position lower down in the order of details in the same column.

move Left

Moves the detail selected in the display list to the end of the left column.

move Right

Moves the detail selected in the display list to the end of the right column.

Rescan

Refreshes the display with the specified details.

Tabular list of events

Displays the specified details for each event in a tabular form.


Version - View Version History
  View Version History (Version Menu)

Related Topics

Displays the Version History Viewer in which you can view the version history of an object displayed in a graphical representation.  How

As well as viewing the full version history of an object, you can also:

•	check in object versions from, and check out object versions to, the context workarea

•	compare object versions

•	merge object versions

•	change the visible version of an object in the workarea


Version History Viewer window

Related Topics

The Version History Viewer displays the version history of an object in a graphical representation.  About

The Version History Viewer window contains the following:

Display Area	Displays a diagram made up of a number of nodes that correspond to each object version.
Status Panel	Shows information about the selected node.
Toolbar	Used to customize the display and provides shortcuts to the functionality available from the menus.


Generic Select dialog box

Displayed from the Browse button or automatically displayed when additional information is required for the current activity.

The title of the dialog box will depend on the context in which it is displayed.

Some features of the dialog box are displayed only if they are required in the particular context. For example the Select All button is displayed only if more than one object can be selected in one operation.

Look In

Displays the label for the area you are currently viewing and, where appropriate, enables you to move to another location in the hierarchy.

  Up One Level

Selects the level above the current level in the repository hierarchy.

  List View

Displays only the names of the repository objects in a multi-column list.

  General Details View

Displays the following general details about the objects in the list:

Name

The name of the object.

Type

The type of the object.

Attributes

The attributes (properties) of the object:

CI	checked-in
CO	checked-out
R	read-only
Modified

The date when the object was last modified.

Modified By

The username of the repository user who last modified the object.

  Version Details View

Displays the following version details about the objects in the list:

Name

The name of the object.

Type

The type of the object.

Attributes

The attributes (properties) of the object:

CI	checked-in
CO	checked-out
R	read-only
Version

The checkin branch and version number of the object, for example, MAIN:1.

Version Label

The version label of the object, for example, 1.3.

  Hierarchical View

Displays all the repository objects below the selected level. Objects are displayed with their path in the repository indicated.

  Flat View

Displays only the repository objects at the selected level in the repository hierarchy. In this view, double-clicking the name of a workarea or container displays the objects at that level.

Find elements that match these criteria

Available on some variants of this dialog box, these options enable you to move to a selected object. You can filter the list of objects displayed by name, type and version.

Name

The name of the selected object.

Type

The object type.

Version

The version of the selected object.


Set Context Workarea dialog box

Displayed when a checkout operation is performed from the Version History Viewer but the repository cannot determine the context workarea, this dialog box enables you to select a context workarea to which the object will be checked out.

All the workareas to which you have access are listed.

Select workarea

Enables you to select a workarea to make that workarea the context workarea.


Which configurations include this version dialog box

Related Topics

Available from the Version History Viewer,  [image]  displays the Which configurations include this version dialog box, listing all the configurations that include the selected object version.

Configurations

A list of all the configurations that include the selected object version.

Show version labels

Determines whether you want to display the version label for each configuration in the list.

When this option is not selected, the branch label is displayed for each configuration in the list.


Which workareas include this version dialog box

Related Topics

Available from the Version History Viewer,  [image] displays the Which workareas include this version dialog box, listing all the workareas that include the selected object version.

Workareas

A list of all workareas that include the selected object version.


Version History Viewer toolbar

Related Topics

The following toolbar buttons are available from the Version History Viewer:

Button	Description
	Updates the display area with any new information.
	Opens a dialog box displaying the version properties of the selected object version.
	Opens a dialog box displaying a summary list of configurations containing the selected version.
	Opens a dialog box displaying a summary list of workareas containing the selected version.
	Checks out the selected object version.
	Checks in the selected checkout.
	Undoes a checkout.
	Hides or shows the insignificant versions of the object. Insignificant versions include those that are not root or tip versions, are not branch parent versions, are not target or source versions in a merge operation, are not common ancestor versions, or are not the source of a checkout.
	Shows or hides the status panel at the bottom of the screen to allow more space for the version tree.
	Displays all notes associated with the version history diagram including branch labels and checkin notes.
	Displays all notes associated with major nodes in the version history diagram including branch labels and checkin notes.
	Hides all checkin notes and branch labels.
	Allows you to select the types of node to highlight in the version diagram and change the node colors to suit your personal preferences.
	Changes the size of the nodes and consequently the size of the entire diagram.


Version Properties dialog box

Related Topics

 opens the Version Properties dialog box for the selected version in the Version History Viewer.

Version name

The object name, branch name and position of the version on the branch.

Date created

The date and time the object version was created.

Created by

The username of the person who created the object version.

Status

The current status of the object version: checked in or checked out.

Notes

Notes that were added when the object version was checked in.


Checkout Properties dialog box

Related Topics

Displays the properties of the checkout selected in the Version History Viewer.

Original name

The object name, branch name and position on the branch of the original object version from which the selected version was checked out.

Date

The date and time when the object version was checked out.

Created by

The name of the user who created the object version

Notes

Any notes that were added when the version was checked out.


Version History Viewer display area

Related Topics

The Version History Viewer display area shows the version tree, a graphical representation of an object.  About

The version tree is made up of a number of nodes, each representing a single object version. Nodes are connected to other nodes by lines (or edges). The version tree includes all versions of the object and any branches and merges that may have taken place during development.

Notes entered at checkin or checkout are displayed beneath the node. They can be toggled on and off from the toolbar.

Depending on the version labeling policy, the name or the label assigned to each version is displayed inside the node. About

Version tree node colors

The following diagram illustrates the default node colors in the Version History Viewer. These colors can be customized to suit your personal preferences.  How

	Blue nodes represent the checked-out versions of this object. Red nodes are the leaf (or tip) nodes and are at the tip of each branch. They represent the latest version for that branch. Yellow nodes are major nodes. A major node is a node that corresponds with either the root of the branch, the parent node of a branch, or is a merge result node. The selected node is indicated by the blue cornered highlight selector. The node that is selected by this user’s workarea is marked with an arrow. The red triangle on the top left hand corner of node 1.3 indicates a marked node. Nodes are marked when they are being used in a compare or merge operation.  How


Version History Viewer Status panel

Related Topics

The Version History Viewer status panel at the bottom of the Version History Viewer window displays information associated with the selected node.

The status panel can be hidden from the display using the [image] button, so that more space is available for the display area.

Branch

The name of the branch to which the selected node belongs.  About

Version Label

The version label, which can be automatically generated or defined by the user.  How

Notes

These are optionally added to an object version when a checkout or checkin operation is performed. The note is a text string of a maximum 2000 characters. Full details of the note are available from the Version Properties dialog box.  How

Date Created

The date the object version was checked in to the repository.

Status

The three recognized states of a node are Checked in, Checked out, and Locked.


Compare window

Related Topics

The Compare window displays the results of a compare operation.

A compare operation involves a base object version and a contributor object version. The base object version is the version with which the contributor object version is compared.

The compare window consists of two panes separated by a resizing splitter. The left pane displays the contents of the base object version; the right pane displays the contents of the contributor object version.

Expanding or collapsing branches on the right pane will cause the corresponding branch on the left to expand or collapse.

You can scroll the screen vertically and horizontally using the scroll bars. Scrolling is synchronized so that corresponding items can be examined side by side.

Identifying differences between object versions

The compare display provides three ways in which differences between object versions can be identified:

•	Different text colors to represent additions, deletions and modifications.

•	Vertical bars to the left of each section of the object version to highlight what is being compared. The color of the block marker corresponds with the text color.

•	Icons to indicate the nature of the difference that exists between object versions:

Icon	Difference
	Added - An item has been added to the contributor version but not to the base version with which it is being compared.
	Deleted - An item has been deleted from the contributor version but not from the base version with which it is being compared.
	Update - An item is included in both the contributor and the base versions but the item is different in each version.


Merge window

Related Topics

The Merge window displays the results of a merge operation. A merge operation takes two contributor object versions (target and source), compares them to a common ancestor version, and uses internal rules to create a result based on changes found in all three versions.  About

The Merge window displays the differences and conflicts encountered by the merge algorithm. It also shows selections made by the algorithm, and lets you override those selections before the result is produced.

The Merge window appears in the following circumstances:

•	You attempt to do an automatic merge, and the merge algorithm encounters conflicts.

•	You explicitly ask for the Merge window to be displayed.

Difference blocks

The Merge window displays any differences in a series of difference blocks. A difference block shows the form that an item of data has in the contributor versions (source and target) and the common ancestor version, and indicates whether the item has been added, removed, or modified in one or both of the contributors with respect to the common ancestor. The difference might be:

•	A simple difference: a difference that the algorithm has been able to resolve using its own rules. In this case, the version containing the form of the item that the merge has selected to go forward to the result has its box selected. You can override the selection made by the algorithm by choosing an alternative form.

•	A conflict: a difference that the algorithm has been unable to resolve using its own rules. In this case, no contributor has its box selected. You must resolve the conflict by choosing the form of the item that you want to go forward to the result. If the conflict is for a file or for multi-line text, you can select more than one form of the comparison to go forward to the result; if the conflict is for structured repository object types, you can select only one.

Use the following menus to perform merge tasks:
File
View
Navigate
Merge
Help

The arrow toolbar buttons enable you to navigate through the lists of differences and conflicts.


Object Visibility dialog box

Related Topics

Displayed when you create an object in a checked-out container and check in the object for the first time, this dialog box warns you that the object being checked in may not be visible to other users until you check in the owning container.

To ensure that other users will be able to see the new object in their workareas (provided that the workarea specifications allow this), click OK and then check in the container.

Do not show this message again

Enables you to prevent the dialog box from being displayed every time you create and check in an object for the first time. Note that selecting this option hides the dialog box not only in the current working session, but also in all future working sessions.


Select Paths for Inherited Classes dialog box

Related Topics

Displayed when comparing or merging Oracle Forms (files with the .fmb, .olb or .mmb extension) that use subclassing or referenced objects, this dialog box enables you to define:

•	the scope: the workarea or configuration in which the Form versions participate

•	the path: the Forms path for the Form you want to compare or merge

Note that when comparing or merging Oracle Forms that use subclassing or referenced objects, you must ensure that:

•	each of the Form versions you are comparing or merging is in a different workarea or configuration

•	the Forms path exists in every workarea or configuration used for the comparing or merging operation

•	the files on the paths are uploaded into the repository  How

The options displayed in the dialog box differ according to whether you are comparing or merging Oracle Forms.

• Comparing Oracle Forms	The options enable you to enter the scope and path for the contributor and base object versions.
• Merging Oracle Forms	The options enable you enter the scope and path for the target, source and ancestor object versions.
Options displayed when comparing Oracle Forms

For

The name of the Form for which you are defining additional information.

Contributor Form

Information about the contributor Form version for this compare operation.

Workarea

Indicates whether or not the scope of the compare operation is for a workarea in which the contributor Form version participates.

Configuration

Indicates whether or not the scope of the compare operation is for a configuration in which the contributor Form version participates.

Name

The name of the workarea or configuration in which the contributor Form version participates. Select the name of the workarea or configuration from the list of those in which the contributor Form version participates.

Path

The Forms path for the contributor Form version. The path defaults to one previously used by the Form, but can be changed by the user. Paths should be defined relative to the root. Specify the path without any version information, and use a semicolon for separating multiple paths.

Base Form

Information about the base Form version for this compare operation.

Workarea

Indicates whether or not the scope of the compare operation is for the workarea in which the base Form version participates.

Configuration

Indicates whether or not the scope of the compare operation is for the configuration in which the base Form version participates.

Name

The name of the workarea or configuration in which the base Form version participates. Select the name of the workarea or configuration from the list of those in which the base Form version participates.

Path

The Forms path for the base Form version. The path defaults to one previously used by the Form, but can be changed by the user. Paths should be defined relative to the root. Specify the path without any version information, and use a semicolon for separating multiple paths.

Options displayed when merging Oracle Forms

For

The name of the Form for which you are defining additional information.

Target Form

Information about the target Form version for this merge operation.

Workarea

Indicates whether or not the scope of the merge operation is for the workarea in which the target Form version participates.

Configuration

Indicates whether or not the scope of the merge operation is for the configuration in which the target Form version participates.

Name

The name of the workarea or configuration in which the target Form version participates. Select the name of the workarea or configuration from the list of those in which the target Form version participates.

Path

The Forms path for the target Form version. The path defaults to one previously used by the Form, but can be changed by the user. Paths should be defined relative to the root. Specify the path without any version information, and use a semicolon for separating multiple paths.

Source Form

Information about the source Form version for this merge operation.

Workarea

Indicates whether or not the scope of the merge operation is for a workarea in which the source Form version participates.

Configuration

Indicates whether or not the scope of the merge operation is for a configuration in which the source Form version participates.

Name

The name of the workarea or configuration in which the source Form version participates. Select the name of the workarea or configuration from the list of those in which the source Form version participates.

Path

The Forms path for the source Form version. The path defaults to one previously used by the Form, but can be changed by the user. Paths should be defined relative to the root. Specify the path without any version information, and use a semicolon for separating multiple paths.

Common Ancestor Form

Information about the common ancestor Form version for this merge operation.

Workarea

Indicates whether or not the scope of the merge operation is for the workarea in which the ancestor Form version participates.

Configuration

Indicates whether or not the scope of the merge operation is for the configuration in which the ancestor Form version participates.

Name

The name of the workarea or configuration in which the ancestor Form version participates. Select the name of the workarea or configuration from the list of those in which the ancestor Form version participates.

Path

The Forms path for the ancestor Form version. The path defaults to one previously used by the Form, but can be changed by the user. Paths should be defined relative to the root. Specify the path without any version information, and use a semicolon for separating multiple paths.


Merge Confirmation dialog box

Related Topics

Lists the source and target for the merge operation, and enables you to choose whether you want to preview the merge results in the Merge window, or perform an automatic merge if there are no conflicts.

If merging binary files other than Oracle Forms, the merge operation does not compare the source and target versions but instead copies the contents of the source over the contents of the target. When merging binary files, this dialog box does not therefore display the Use Merge window and Perform automatic merge options but instead displays a message informing you that the merge will copy the source file over the target file.

Source

The source object version for the merge operation: the version which is merged with the target.

Target

The target object version for the merge operation: the version into which changes made in the source are to be merged.

Use Merge window

Displays the Merge window listing the differences and conflicts encountered by the merge algorithm and the selections made by the algorithm, and letting you override those selections before the result is produced.

Perform automatic merge

Performs an automatic merge if there are no conflicts. The Merge window is displayed only if there are conflicts between object versions, so enabling you to resolve the differences; otherwise the Merge window is not displayed.


File Menu

Save

Merges the selected data into an updated form of the target and saves the result.

Exit

Exits from the tool.


View Menu

Toolbar

Shows or hides the standard toolbar below the menu bar.


Navigate Menu

Previous Difference

Navigates to the previous difference in the window.

Next Difference

Navigates to the next difference in the window.

Previous Conflict

Navigates to the previous conflict in the window.

Next Conflict

Navigates to the next conflict in the window.


Merge Menu

Select Source

Selects the source from the difference block currently in focus.

This menu option will be only be available when a difference block is currently in focus in the Merge Window.

Select Target

Selects the target from the difference block currently in focus.

This menu option will be only be available when a difference block is currently in focus in the Merge Window.

Select Common Ancestor

Selects the common ancestor from the difference block currently in focus.

This menu option will be only be available when a difference block is currently in focus in the Merge Window.


Help Menu

Help Topics

Displays a list of the main subject areas in the online documentation system.

About

Displays copyright and version number information about this application. You might need to know the version number for product support purposes.


File - Open
   Open (File Menu)

Opens an existing diagram.

If the diagram you select is already open this option brings that diagram to the front. If the selected diagram is minimized it will be restored to its previous state.

If the diagram you are opening contains elements that do not match those held in the repository and you have set the Requery on Open option in the Customize dialog box, the mismatched elements are requeried automatically before you open the diagram. If you have not set the Requery on Open option, the diagram is opened exactly as it was when last closed, but cannot be edited.

Dialog box options

Diagrams for workarea

Lists the existing diagrams, grouped by container, that are visible to your workarea. Choose the diagram you want to open by expanding the appropriate container node and selecting the diagram name.


Edit - Delete From Repository
Delete from Repository (Edit Menu)

Deletes one or more selected elements from the diagram and places in them in the repository Wastebasket.

You must have delete privileges to a workarea and container before you can remove elements or their associations from it. If an element is "shared", i.e. directly owned by another application system, it can be deleted from the owning application system only.

•	Deleting an element from the current diagram window deletes the element node from the current window and from any copies of the same diagram that are also open.

•	Deleting from a diagram an element that is also included on other closed diagrams removes the element node from the current diagram only. Any diagrams containing the deleted element become temporarily out of date until you requery the repository.

Dialog box options

List box

Displays the names of all the diagram elements that are selected on the active diagram. By default, all elements are selected for deletion. Each diagram element is qualified by a container name.

Select All

Selects for deletion all the elements shown in the list box.


Edit - Select <Element Type>
Select→Element Type (Edit Menu)

Related Topics

Selects named elements of the specified element type on the active diagram.

Dialog box options

List box

Displays the names of elements of the type you want to select on the diagram.

Select All

Selects all the elements shown in the list box.


Edit - Navigate to - Element Type
Navigate to→Element Type (Edit Menu)

Related Topics

Searches for a specified element on the active diagram and redisplays the diagram to show that element and its surrounding items.

Dialog box options

List box

Displays the elements to which you can navigate on the active diagram.


Edit - Requery - Element type
Requery→<Element Type> (Edit Menu)

Requeries your choice of any out-of-date elements on the diagram of the specified type.

After requerying, any changes that have been made to the properties of the elements you requery are reflected on the diagram. Any elements you requery that have been deleted from the repository are removed from the diagram.

Dialog box options

List box

Displays the names of all the out-of-date entities on the diagram with an explanation of why each is out of date.

Select All

Selects all the entities shown in the list box.


Edit - Properties
Properties (Edit Menu)

Maintains the properties of an element on the active diagram.

Tip:	You can also open an element dialog box by double-clicking on the element on the diagram.


Version - Check In / Check Out <container>
 Check In / Check Out <container> (Version Menu)

Checks in or checks out a container, depending on whether it is currently checked-in or checked-out. The text for this option is one of the following:

Menu text	Meaning
No Current Container	There are no diagrams open and no container is in use.
Check In <container>	The current container is checked out and can be checked in using this option.
Check Out <container>	The current container is checked in and can be checked out using this option.


Utilities - Database Design Transformer
Database Design Transformer (Utilities Menu)

Creates and maintains database designs based upon entity models recorded in the repository. It creates tables to record instances of each entity, columns to store attributes, and constraints to implement the relationships between entities.

Like the entity model, the database design that is generated is stored in the repository. This model can subsequently be used by other Oracle Designer utilities to generate the SQL statements required to create the database itself.


Container List (Main toolbar)

The Container List identifies the container in which new diagram elements will be created in the repository.

In the Process Modeler, Function Hierarchy Diagrammer and the Dataflow Diagrammer, diagram elements are always created in the same container as the diagram, therefore this field is display only and simply identifies the container in which the active diagram exists.

In the Entity Relationship Diagrammer, where diagrams can contain elements from multiple containers, you use this field to specify the container in which diagram elements will be created. If the container that you want to use is not shown in the dropdown list, click the list button to the right of the dropdown list to see other containers that are visible to your workarea.

Note: The Container List does not display a container name if a diagram is not open.


Utilities - Function/AttributeMatrix
Function/Attribute Matrix (Utilities Menu)

Related Topics

Helps you to define a function/attribute matrix, by presenting functions visible to the workarea and allowing you to specify the functions for which you want to define a function/attribute matrix.

This utility creates a function/attribute matrix by generating a default function attribute usage for each attribute that qualifies an entity used by the function. A new function attribute usage is not created for any existing function attribute usages.

Dialog box options

List box

Lists the functions visible to the workarea. Note, although all functions are listed in the dialog box, attribute usages can only be created for functions that have entity usages.

Select All button

Selects all the functions shown in the list box.


Options - Customize
Customize (Options Menu)

Changes the diagrammer display options.

This option displays the Customize dialog box which allows you to change:

•	colors

•	line widths

•	fonts

•	grid settings

•	size of elements

and to determine:

•	which properties and items are displayed

•	whether a diagram is requeried on opening


Layout - Rescale Diagram
Rescale Diagram (Layout Menu)

Related Topics

Rescales all the elements on the diagram so that the diagram is displayed to fit into a specified number of pages. When a diagram is rescaled using this utility, nodes, dog-legs, arcs, recursive relationships (pig's ears) and fonts are resized to be in proportion to the rescaled diagram.

Dialog box options

New Number of Pages

Horizontal

Defines the number of pages in the horizontal axis to which the diagram will be rescaled.

Vertical

Defines the number of pages in the vertical axis to which the diagram will be rescaled.

Current Number of Pages

Horizontal

Display only
Indicates the number of pages in the horizontal axis on which the diagram is currently displayed.

Vertical

Display only
Indicates the number of pages in the vertical axis on which the diagram is currently displayed.

Scale Fonts checkbox

Defines whether or not the fonts on the rescaled diagram are resized to be in proportion to the size of the diagram.

Maintain Aspect Ratio checkbox

Defines whether or not the number of pages defined in the Horizontal and Vertical fields (in the New Number of Pages group) retain their aspect ratio. If this box is checked, the Horizontal and Vertical fields in the New Number of Pages group will change dynamically whenever a change is made to either of them.


Utilities - Table to Entity Retrofit
Table to Entity Retrofit (Utilities Menu)

Related Topics

The ‘Table to Entity Retrofit’ utility transforms (or 'reverse engineers') repository-held relational table definitions into entities, attributes, relationships and unique identifiers.


Table to Entity Retrofit dialog box

Related Topics

The ‘Table to Entity Retrofit’ utility transforms (or 'reverse engineers') repository-held relational table definitions into entities, attributes, relationships and unique identifiers.

Use this dialog to specify the table definitions from which entity definitions are to be created.

Table Name

The names of the tables to be transformed. Only tables that do not currently implement entities can be selected.

Entity Name

Mandatory, 30 character
The name of the entity definition to be created. This field defaults to the table name with any underscore characters present in the name replaced with spaces. If the wording is not acceptable, you can type over this entry.

Entity Short Name

Mandatory, 10 character
The short name of the entity definition to be created. This field defaults to the table name. If the wording is not acceptable, you can type over this entry.

Entity Plural

Mandatory, 100 character
The name of the entity plural to be created. This field defaults to the table name with any underscore characters present in the name replaced with spaces. If the wording is not acceptable, you can type over this entry.

Update relationships for existing entities

With this box checked, the utility will create relationships for foreign keys that have been added to tables that implement existing entities.

Update unique identifiers for existing entities

With this box checked, the utility will create unique identifiers for primary and unique key constraints that have been added to tables that implement existing entities. Also, the utility will replace attribute unique identifier entries with relationship entries or create new relationship entries, where the primary or unique key implementing the unique identifier shares columns with a foreign key of the table.

Candidate Tables button

Displays a Candidate Tables dialog box listing all the tables in the current application system that can be transformed into entities. Tables previously used to implement entities are not displayed in the list. A Filter field is available to locate specific tables in the list.

Retrofit button

Transforms the table definitions displayed in the Table to Entity Retrofit dialog into entity definitions.

Grid Save button

Saves the current widths of grid columns.

Grid Reset button

Resets grid columns to their default widths.


Candidate Tables dialog box

Related Topics

This dialog lists all the tables in the current application system that can be transformed into entities. A Filter field is available to locate specific tables in the list. Choose the tables you require and press OK.