Selecting in other tools

Related Topics

In a multi-tool environment different tools may focus on different parts of a process, or present you with an alternative way of viewing data. For example, you can create and maintain repository table definitions from both the Design Editor and the Repository Object Navigator, however only the Repository Object Navigator can be used to control which users have access to a table definition.

The Select in other Tools utility helps you to perform tasks in other tools, by finding and selecting the objects with which you want to work. For example, from the Design Editor you can quickly give other users access to the table definition, by using the Select in other Tools utility to select the table definition in the Repository Object Navigator and then choosing the appropriate Repository Object Navigator menu option.

To select repository objects in other tools

1.	In the active tool, select the objects that you want to select in other tools.

2. 	Choose Utilities→Select in Other Tools.

If the other tools have the same workarea and container opened as the active tool, and the tool can display these object types, the objects are selected.

Note:	If the same workarea and container are not currently opened in the Repository Object Navigator, a new Navigator window is displayed with the required objects selected.


About Automatic Checkout

Related Topics

Automatic Checkout enables repository elements to be automatically checked out when they are required to be updated, rather than halting an action until you check the element out. For example, If you change the properties of a checked-in element, the element is automatically checked out and the update is performed. Similarly, if a generator attempts to update a repository element during design capture, the element (and its associated elements) is automatically checked out.

Note:	This feature is available for versioned repositories only.  About

For repositories that are not using a strict locking policy, you can choose whether the Automatic Checkout option checks out repository elements with a lock or without a lock.  How

Notes on the use of the Automatic Checkout option:

•	Automatic Checkout does not apply to checked-in containers, i.e., if you try to create a repository element for a checked-in container, a dialog box is displayed asking if you want to check out the container and create the element or cancel the create operation.

•	If you have already checked out a repository element that requires updating, there is no attempt to check out the element again.

•	If another user has already checked out the repository element unlocked, the element is checked out to you. It is your responsibility to check the element back in (and merge the element with other versions if necessary).

•	If another user has already checked out the repository element locked, the element cannot be checked out again if a strict locking policy has been applied to the repository or if you have chosen to perform Automatic Checkout with a lock. Therefore, the element cannot be updated.

•	During application generation, Adjustment messages indicate whether the generators have succeeded or failed to check out repository elements.  About

•	Diagrams in the Design Editor are always opened in edit mode, regardless of the Automatic Checkout option.


About the Post Processing Mode
About Post Processing Mode

Related Topics

When you specify options for generation and design capture, you can specify whether proposed changes to the repository are automatically performed or whether you want to view and edit the changes before accepting them. Post Processing Mode allows you to choose how to process proposed repository changes, that may consist of new elements that are to be created in the repository, and existing elements whose property values are to be changed.

Post Processing Mode is activated only if you have chosen the Browse/Edit option from the Generate and Design Capture dialog boxes.  When Post Processing Mode is active, a floating palette is displayed.

The changes are shown on the Navigator and, if appropriate, on a diagram. For example, if you are capturing tables and roles, the names of the tables and roles are highlighted on the Navigator. The tables are also shown on a Server Model Diagram.

After you have performed your edits, you must do one of the following to turn Post Processing Mode off:

•	Click [image] on the Post Processing Palette to update the repository and switch off Post Processing Mode.

•	Click [image] on the Post Processing Palette to cancel all proposed generation changes and switch off Post Processing Mode.

Note:	You cannot perform edits, except those proposed by generation/design capture, until you have switched off Post Processing Mode.


Property Dialog boxes vs. Property Palettes

Related Topics

When you create and edit repository elements, you can use either Property Dialog boxes or Property Palettes.  How

•	Property Dialog boxes, provide you with an easy to use interface, grouping together related elements and properties. Property Dialog boxes are the default way of setting properties and should be used if you are not familiar with the product. Any properties that are not commonly used by an element can be accessed from the final (Advanced) dialog box page.

•	Property Palettes, provide you with a direct way of entering/editing properties of an object. Property palettes are the quickest way of setting properties, because all properties are displayed in a single palette. Property palettes show all of the possible values for each property. However, not all of the values for a property are always applicable.


Using Property Dialog boxes or Property Palettes

Related Topics

When creating and editing repository elements you can specify whether Property Dialog boxes or Property Palettes should be used.  About

To specify whether dialog boxes or palettes should be used:

•	Click the appropriate button on the main toolbar:

	Identifies that Property Dialog boxes are currently used.
	Identifies that Property Palettes are currently used.


Showing or hiding the Default Database Implementation Wizard

Related Topics

The Default Database Implementation Wizard is displayed by default when database object definitions, e.g. table definitions are created in the repository. The purpose of this wizard is to allow you to identify the database and database user for which a database object is to be implemented.  About

To hide the Default Database Implementation Wizard, do one of the following:

•	From the first page of the wizard itself, choose one of the options that specifies that the wizard is not to be displayed for future invocations of the tool.

•	Choose Options→General Settings and clear the "Show Default Setting Dialogs" box.

To redisplay the Default Database Implementation Wizard:

1.	Choose Options→General Settings.

2.	Select the Show Default Setting Dialogs box.


Showing or hiding dialog boxes for drag and drop operations

Related Topics

When creating copies of repository elements using the drag and drop method, the Copy Objects dialog box is displayed.

To hide the Copy Objects dialog box during drag and drop, do one of the following:

•	From the dialog box itself, use the box (displayed at the bottom of the dialog box) to specify that the dialog box is not to be displayed in future.

•	Choose Options→General Settings and clear the "Show Dialogs on Drag & Drop" box.

To redisplay the Copy Objects dialog box:

1.	Choose Options→General Settings.

2.	Select the "Show Dialogs on Drag & Drop" box.


Setting the default date format

Related Topics

You can specify the default date format that is to be used by all dates shown.

To set the date format:

1.	Choose Options→General Settings.

2.	In the General Date Format field, enter the required date format, e.g. DD-MM-YY.


Setting the default level for error messages

Related Topics

You can specify the types of error messages that are to be displayed by default in the Message Window. The Message Window displays errors that are encountered during validation, generation and design capture.

To set which types of error messages are to be displayed:

1.	Choose Options→General Settings.

2.	From the Generation group, choose the level of error messages that are to be displayed.


Setting the Automatic Checkout option

Related Topics

Automatic Checkout enables repository elements to be automatically checked out when they are required to be updated, rather than forcing you to manually check out elements prior to updating them.  About

To set the Automatic Check Out option:

1.	Choose Options→General Settings.

2.	Check the Auto Check Out box.

3.	Specify whether you want to check objects out unlocked or locked.

Note:	If the repository is set to use a Strict Locking policy it is not possible to check objects out unlocked, as all objects are locked on checkout.


Customizing the display of diagrams

Related Topics

You can customize the appearance of a diagram by changing the colors, line widths and fonts of its diagram elements.

To change the color, line width or font of diagram elements:

1.	(Optional)  Select one or more elements on a diagram.

2.	Choose Options→Color/Font/Style.

3.	Do one of the following:

•	If elements are selected on the diagram, use the options on the right of the dialog box to change the required attributes.

•	If elements are not selected on the diagram, specify the types of elements for which you want to define display attributes, e.g. existing elements and new elements. Then, change the required attributes. Use the Element dropdown list to determine the element for which attributes are being specified.


Finding references to elements

Related Topics

As you develop your repository designs, references are made between repository elements. For example, when you specify the table on which a table implementation is based, references are created between the two repository elements. These types of references are referred to as usages.

To find references to an element:

1.	Select the element for which you want to find references.

2.	Choose View→Usages.

3.	From the dropdown list on the dialog box, select the type of element for which you want to find references to your chosen element.

4.	(Optional)  Navigate to an element that references your chosen element by doing the following:

−	Select the element from the list box.

−	Click Goto.

The element from which the reference is made is highlighted on the Navigator. If the element is displayed on a different Navigator view, a new Design Navigator is opened.


Searching for a text string

Related Topics

To find a text string in the active window, e.g., to find the name of a table in the Design Navigator, you can search for the next or previous occurrence of that text string. The search is not case-sensitive and the wildcard character % can be used to widen the search.

To find...	Enter...
A text string starting with cer	cer
A text string starting with or containing cer	%cer
A text string starting with cer and containing nty.	cer%nty
To search down:

1.	From the Main Toolbar, enter the text for which you want to search in the Search list box (located to the right of the Print button).

Note:	To find text that is not at the start of a text string, e.g., to find a specific word in a generator preference description, you must start your search with %.

2.	Indicate the start point of the search by selecting an item in the window that is to be searched.

Note:	To search the entire contents of a window, either the first entry must be selected or nothing must be selected.

3.	Click [image].

The next match for the specified text string is selected. To find the next occurrence of the text string, click [image] again.

To search up:

1.	From the Main Toolbar, enter the text string for which you want to search in the toolbar Search list box (located to the right of the Print button).

Note:	To find text that is not at the start of a text string, e.g., to find a specific word in a generator preference description, you must start your search with %.

2.	Indicate the start point of the search by selecting an item. For example, to indicate the start point on a Navigator, select the required node.

3.	Click [image].

The search up the list box starts from the currently selected item.


Using shortcut keys

Related Topics

Shortcuts for menu options

To		Press		As a shortcut for
Close the active window		CTRL+W		File→Close
Save the outstanding changes to the repository		CTRL+S		File→Save Uncommitted Data
Print the contents of the active window		CTRL+P		File→Print
Exit from the tool		CTRL+Q		File→Exit
Undo the last operation performed		CTRL+Z		Edit→Undo
Retain an action canceled out using undo		CTRL+R		Edit→Redo
Remove the selected item or items and place the selection on the Clipboard		CTRL+X		Edit→Cut
Copy the selected item or items to the Clipboard		CTRL+C		Edit→Copy
Place the contents of the Clipboard into the active window		CTRL+V		Edit→Paste
Create a new repository element under the selected node		CTRL+ INSERT		Edit→Create
Delete the selected elements from the diagram and from the repository		CTRL+DEL		Edit→Delete From Repository
Select all the elements on the diagram		CTRL+A		Edit→Select All
Edit the properties of the selected element		ALT+ENTER		Edit→Properties
Zoom in		CTRL++		View→Zoom In
Zoom out		CTRL+ -		View→Zoom Out
Navigate to an object that is referenced by a selected object/property		F12		Navigator→Locate Object Definition/ Properties→Locate Object Definition
Return to the object from which you navigated to a referenced object		SHIFT+F12		Navigator→Return to Object Reference
Open a new Navigator		F3		Tools→Navigator
Open a new Property Palette		F4		Tools→Property Palette
Show this shortcut key help topic		CTRL+K		Help→Show Keys
Shortcuts when using windows

To		Press
Make the next window active		CTRL+F6
Edit properties		ALT+ENTER
Shortcuts when using dialog boxess

To		Press
Go to the next control		TAB
Go to the previous control		SHIFT+TAB
Go to the next page		CTRL+TAB
Go to the previous page		SHIFT+CTRL+TAB
Shortcuts when using the Navigator

To		Press
Display the next view in the Navigator		CTRL+PAGE UP
Display the previous view in the Navigator		CTRL+PAGE DOWN


About the design and generation environment

Related Topics

The Oracle Designer design and generation environment comprises the Design Editor and a number of generator products that provide an integrated environment to:

•	Design and generate Oracle databases and other types of databases, including generation of the Server Application Programming Interface (API).

•	Design and generate client applications, e.g., Oracle Forms applications and Oracle Reports applications.

Your database and application designs are recorded in the Oracle Designer Repository allowing you to enhance and complete them before using the generator products to create your final systems, e.g. databases.

From your repository server designs you can use the Server Generator to:

•	Generate SQL DDL to create Oracle7 databases, Oracle8 databases and Oracle RdB databases.

•	Generate SQL DDL to create databases other than Oracle databases.

•	Generate Server Application Programming Interface (API) for use by client applications to insert, update, delete and lock rows in tables.

•	Allow generation of ANSI SQL DDL for use across Oracle databases and other types of databases.

•	Provide access to Oracle databases and other types of databases via ODBC.

•	Capture design information from Oracle databases and other types of databases into the repository.

From repository module designs you can use the application generator products to:

•	Generate Web PL/SQL applications, Visual Basic applications, Oracle Forms applications and Oracle Reports applications.

•	Generate Microsoft Windows help for use by Visual Basic applications and Oracle Forms applications.

•	Capture design information from existing applications into the repository.


Features added for design and generation in 6i
Features added for design and generation in 6i/9i

Related Topics

New for the design level tool set in 6i/9i

Major changes for the design level tool set in 6i/9i

Changes to the Design Editor components for 6i/9i

New supporting features for 6i/9i

Terminology changes

Server generator new features in 6i/9i:

	Server Generator
Application generator new features in 6i/9i:

	Form Generator		Web PL/SQL Generator
	Help Generator		Report Generator
	Library Generator		Visual Basic Generator
Major changes for the design level tool set in 6i/9i

Workareas	A workarea provides you with a view of the repository objects on which you are working. The Design Editor presents repository data in the context of a workarea, enabling multiple containers to be accessed.  About
Containers	Containers are the mechanism for storing and organizing repository data. Two types of containers are used in the Design Editor, application systems and folders.  About
Dependency Manager tool	This new dependency management tool replaces the Analyze Dependencies utility and the PL/SQL Summary Usages utility which have been removed in 6i.  About
Version control	Repository held data can now be checked in and out to control and manage changes.  About
Changes to the Design Editor components for 6i/9i

Design Navigator	The customization feature available from the Options menu has a new Apply button. This enables you to see the impact of your chosen options without having to close the Customize dialog box.
Logic Editor	Rationalized user interface which now supports creation of Java definitions.
Module Diagrams	Support for the following features has been added:    -   multi-region blocks for Form generation    -   Relative Tab Stops Editor for Form generation    -   improved modeling for Lists of Values
Reusable Component Editor	Support for reusable List of Values components has been incorporated.
Generator Preferences Palette	Additional preference levels are now supported for application generation. The menu items for inheriting preference values and creating preference sets have moved from the Edit menu to the Preferences menu.
Module Network Viewer	Support for the display of specified top level modules, using the module Top Level property.  How  Prior to 6i, the Top Level ? property defaulted to No. From 6i onwards it defaults to Yes.
Guides	Visual enhancements have been made to the guides.
New supporting features for 6i/9i design and generation environment

Generate Default Lists of Values utility

Relative Tab Stops Editor

Advanced tab on property dialog boxes

Automatic Checkout option

Terminology changes

Terminology changes to repository elements and properties

6.0 element	6i/9i element
snapshot	materialized view
6.0 property	6i/9i property
Lookup Validation WHERE Clause (table usage)	Validation WHERE Clause
Other terminology changes

6.0	6i/9i
WebServer Generator	Web PL/SQL Generator
Removed in 6i/9i

The following repository objects and properties have been removed in 6i:

6.0 repository item	Replaced by...
Create Lookup Item property	This property of a lookup item is superseded by the introduction of explicit modeling of LOVs.
Display in LOV property	This property of a lookup item is superseded by the introduction of explicit modeling of LOVs.
Enter FK via Descriptor property	This property of a lookup table usage is superseded by the introduction of explicit modeling of LOVs.
Filter Before Display property	This property of a table usage is superseded by the introduction of explicit modeling of LOVs.
LOV Title property	This property of a table usage is superseded by the introduction of explicit modeling of LOVs.
The following tools, utilities, etc., have been removed from the Design Editor in 6i.

Interface item	Replaced by...
6.0. Dependency Analyzer utility	This utility has been superseded by the more functionally rich Dependency Manager tool.
PL/SQL summary usages utility	The functionality provided by this utility is included in the Dependency Manager tool.


Features added for design and generation in Release 6.0
Features added to the design and generation environment for Release 6.0

Related Topics

New features within the design environment in Oracle Designer Release 6.0 are for Form generation only.  About


Features added for design and generation in Release 2.1.2
Features added to the design and generation environment for Release 2.1.2

Related Topics

The following features were incorporated in the design and generation environment for Release 2.1.2 of Oracle Designer.

Note:	Notice the product name changed from Designer/2000 to Oracle Designer in Release 2.1.2.

New for the design level tool set in Release 2.1.2

Batch processing tools	The batch processing tools allow you to store details for generation or design capture in a file to be run at a future date. They also allow you to generate multiple client applications, e.g. Oracle Forms applications, in a single operation.
Blocks on tabs in Module Diagrams	Module Diagrams have been updated to support design of blocks on tab canvas pages for Oracle Forms applications.
Generator Preferences Palette new features	Status bar, situated below the Filter box, that identifies the selection for which preferences are being set.  Revert button, to allow you to cancel changes that you have made to preference values, without canceling changes that you have made outside of the Generator Preferences Palette.   Track Selections button, to provide quicker access to the Track Selections feature.


Features added for design and generation in Release 2.1.1
Features added to the design and generation environment for Release 2.1.1

Related Topics

Major new features in Designer/2000 design and generation environment in  Release 2.1.1

This was a maintenance release for the design and generation tool set, and therefore contained no major new features.

For information about new features for each of the generator products, refer to their new features sections.


Features added for design and generation in Release  2.1
Features added to the design and generation environment for Release 2.1

Related Topics

In Release 2.1, the Design Editor becomes the basis for the design and generation environment.

New for the design level tool set in Release 2.1

Major changes for the design level tool set between R1.x and R2.1

Additions to the design level tool set for Release 2.1

New utilities for Release 2.1

New supporting features for Release 2.1

Terminology

Terminology changes to repository elements

General changes to terminology

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Major changes to the design level tool set between R1.x and R2.1

The Design Editor supersedes a number of individual tools that were provided for design and generation in previous releases. The functionality provided by individual Release 1 design level tools is now incorporated into the Design Editor as a component.

R1.x tools	R2.x Design Editor components
Data Diagrammer	Server Model Diagrams The separate Data Diagrammer tool is replaced with Server Model Diagrams within the Design Editor.  In addition to defining tables, views and snapshots on Server Model Diagrams, you can design database clusters, Oracle Object Types and Oracle Collection Types. Server Model Diagrams also have an extended set of display features, allowing you to show and hide additional information, such as, triggers, indexes and synonyms.
Module Diagrammer	Module Diagrams Module Diagrams are accessed from within the Design Editor.   The following features are new to Module Diagrams: - modules can be broken down into components - calling and called modules are shown on Module Diagrams - different views are used to present data and display information
Module Logic Navigator	Logic Editor Logic is defined using the Logic Editor component within the Design Editor.  In previous releases you could define server-side procedural logic by recording PL/SQL functions, packages and procedures. You can now record 'application logic' or custom code. For example, you can record Visual Basic logic that can be used by a Visual Basic module.
Module Structure Diagrammer	Module Network/ PL/SQL Composition viewer A module network viewer enables you to display module networks horizontally in the Navigator. This allows you to clearly see the relationships between the modules in a network. There is no longer a separate Preferences Navigator tool. Instead preference values are set using the Generator Preferences Palette within the Design Editor.
Preferences Navigator	Generator Preferences Palette The Preferences Navigator tool is replaced with the Generator Preferences Palette within the Design Editor.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Additions to the design level tool set for Release 2.1

In addition to the Design Editor components that support Release 1 functionality, there are three new Design Editor components:

Design Editor Navigator	The Design Editor Navigator is a key component within the Design Editor. It allows you to create and access a subset of the repository elements. Most of the tasks that can be performed using other Design Editor components can be performed from the Navigator.
Reusable Component Editor	Module designs can be broken down into module components. The module components can be used either by one module only or they can be reusable. The Reusable Component Graphical Editor is the Design Editor component that you can use to graphically edit reusable components.
Database Navigator	View the structure of an online database using the Database Navigator.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------

New utilities for Release 2.1

The following utilities are new for release 2.1:

Utility name	Purpose
Copy with new languages	Creates copies of new elements with different languages. Information that is not relevant for the target language is automatically removed.
Copy menus	Copies menu structures from one module to another.
Create Oracle object types	Creates Oracle object types based on the structure of existing relational table/view definitions. This facility will help you migrate a relational server model to an object-relational design.
Create object views	Creates an object view of existing relational table/view definitions. Object views can help you migrate a server model based on a relational design, to an object-relational design.
Analyze Dependencies	Identifies dependencies between repository elements in the same container.
Map unbound items	Converts an unbound item (i.e. one whose value cannot be derived from a single database column) into a bound item (an item whose value can be derived from single database column), by mapping the unbound item to a database column.
Validation utility	Performs quality checks on application designs recorded in the repository, prior to generating a product. For example, you can validate Oracle Forms applications. During validation, parts of a design that will prevent the generator products from completing successfully are reported by the messaging system (see supporting features).
Resequence elements	Changes the order in which elements are ordered in the Navigator. For example, you can resequence columns for a table.
Select in other tools	Selects the same repository elements, as currently selected in the Design Editor, on other tools, e.g. the Repository Object Navigator.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------

New supporting features for Release 2.1

There are many features within the Design Editor that help you to perform tasks. Most of these features are optional, providing you with a flexible working environment.

Feature	Purpose
Post Processing Mode	Post Processing Mode allows you to choose how to process repository changes that result from generation or design capture. The proposed changes may consist of new elements that are to be created in the repository, and existing elements whose property values are to be changed.
Broadcast Mechanism	Provides you with a multi user environment by notifying you of any changes that are made to the container in which you are working.
Drag and drop	You can use drag and drop, instead of clicking on menu options or toolbar buttons, to perform a wide range of tasks. For example, you can open existing diagrams by dragging them from the Design Editor Navigator component onto the work surface. You can then drag existing repository elements from the Navigator onto the diagrams.
Guides	The guides provide you with structured paths for performing groups of related tasks.
Wizards	The wizards allow you to specify the database and database user for which a database object is to be created.
Choice for editing properties	When you create and edit repository elements, you can use either Property Dialog boxes or Property Palettes.
Choice of Text Editors	There is a choice of several text editors; these are the textpad, ASCII text editor and an HTML editor.
Messaging System	Displays messages that identify the status of generation and design capture. Also displays messages associated with syntax checking for the Logic Editor.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------

 Terminology changes to repository elements and properties

Release 1.x element/property	Release 2.x element/property
Caption property	Prompt property
Derivation Expression property	Derivation Text property
Detailed column usage (dcu)	Item
Detailed table usage (dtu)	Module component
Display Datatype property (Forms)	Display Type property
Display Style property (WebServer)	Display Type property
Implementation Item property	Template/Library Object property
Justification property	Alignment property
named preference set	preference set
Page/Popup Width property	Canvas Width property
Page/Popup Height property	Canvas Height property
Page Text (WebServer)	User Text
Presentation Style (WebServer)	Layout Style
secondary usage	No longer required. Non-base table items are generated from unbound items. A bound item based on the same column as an earlier bound item is generated as a mirror item.
Select property	Query property
Soft LOV property	Dynamic List property
User Help Text property	User/Help Text property
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------

 Terminology changes (general)

Release 1.x	Release 2.x
boilerplate graphic (Forms)	graphic object
boilerplate text (Forms)	graphic text
Consolidate	Requery
copy context (Forms)	block context
derived item (Forms)	formula item
Forms Generator	Form Generator
regeneration	generating generated forms again
Oracle Forms	Form Builder
page (Forms)	content canvas
popup (Forms)	stacked canvas
stacked item group (a generated set of stacked canvases accessed via a poplist as an alternative to native Form Builder tab canvases)	A repository item group with the Stacked property set to Yes. In Designer/2000 Release 2 you can generate both native Form Builder tab canvases, and the alternative implementation using stacked canvases and a poplist
reverse engineering	design capture Note: the Design Capture utility is located on the Generate menu.
Object Hierarchy window and its Hierarchy Tree (Repository Object Navigator)	Navigator window
Properties window	Property Palette
Undo	Revert


Starting the Design Editor

Related Topics

Installation and setup

The Design Editor is part of the Oracle Designer tool set, therefore before you can use the Design Editor you must first ensure that Oracle Designer has been correctly installed and that a repository is available for you to use. For more information, see the Oracle Designer Installation Guide.

Starting the Design Editor

1.	To start the Design Editor, first start Oracle Designer by choosing Programs→Oracle Designer [version - home] →Oracle Designer from the Windows Start menu.

2.	Complete the Connect dialog box, which acts as a security check for the system.

You will need a username and password. If you don't have these already, ask your System Administrator to give you an account on the system. For security reasons, the password is shown as asterisks as you type it in.

Note:	If you are working with a versioned repository, when you successfully complete the Connect dialog box, the Workarea dialog box is displayed from which you must choose an existing workarea or create a new one.

When you have specified the required connection information the Oracle Designer Window is displayed.

3.	From the Oracle Designer Window, choose the Design Editor.

The first time you use the Design Editor a Welcome screen is displayed, identifying the main groups of tasks that can be performed within the Design Editor. Use the Welcome screen to open the Design Editor in the context of the type of designs you want to create.  About

Next Step

Ensure you have sufficient access to the repository


The Design Editor Welcome Screen

Related Topics

The Design Editor Welcome Screen provides you with a way of controlling the information that the Design Editor displays when it is started. The options on this dialog box represent the main groups of tasks that you can perform. The option you choose is used by the Design Editor to provide you with a default setup for performing each group of tasks.

How to use the Welcome Screen:

From the list of options, choose the one that most suitably describes what you want to do and then click OK.

Note:	If you do not want to set the Design Editor according to the tasks you want to perform, click Cancel.

Design Options	What does this option do?
Server Model	Sets the Design Editor so that you can record database repository elements, such as tables and columns. These elements are used by the Server Generator to generate a physical database. If the Use a Guide box is checked, the Server Model guide is started.  If the Open New Diagram box is checked, a Server Model Diagram is opened.
Module Applications	Sets the Design Editor so that you can record information about the client applications that you want to create. Module definitions are used by the Client Application generators to generate applications, such as forms and Visual Basic applications. If the Use a Guide box is checked, the Module Application guide is started.  If the Open New Diagram box is checked, a Module Diagram is opened.
Database Administration	Sets the Design Editor so that you can specify physical details, such as storage and security for a database. These details are used by the Server Generator when generating a database. If the Use a Guide box is checked, the Database Administration guide is started. If the Open New Diagram box is checked, a Server Model Diagram is opened.
Distribution and Replication	Sets the Design Editor so that you can specify distribution and replication details. These details are used by the Server Generator when generating a database.


Ensuring you have sufficient access to the repository

Related Topics

The Design Editor presents you with a view of the repository in the context of a single workarea.

If you are working with a non-versioned repository, the repository has a single workarea (called a Global Shared Workarea) that you share with other repository users. In a non-versioned repository, the access that you and other users have to repository data is determined by your access rights.

If you are working with a versioned repository, you may use a shared workarea or a private workarea. In addition to access rights, workarea rules control access to the repository data. Depending on your access rights you can create workareas, edit workarea specifications and refresh workareas from the Design Editor. Typically, there is a repository owner who controls repository details such as your access rights and whether the repository is under version control.

When opening the Design Editor for the first time you may find that it does not display existing repository data that you were expecting to see. The most common reasons that you cannot see existing repository data are:

•	You have been granted insufficient access rights for the containers you want to use.

•	Your workarea specification does not include the containers you require. This applies to versioned repositories only. Note, if you change the workarea specification you must also refresh the workarea to propagate the changes.

Next Step

Identify the starting point for your design


Identifying the starting point for your design

Related Topics

Oracle Designer provides you with more than one approach to creating first cut database designs and application designs in the repository. The approach you choose will depend on whether your design strategy is based on a top-down analysis of the system, on a rapid development approach or on legacy development.

To create an initial design in the repository, you can:

•	Create default designs automatically from existing analysis data in the repository, using the Oracle Designer Transformers (accessed from the Oracle Designer Welcome Screen). Then use the Design Editor to enhance and complete the designs.

•	Create default designs automatically from existing design data in the repository, using the Oracle Designer Copy utilities. For example, you may have an existing relational database design that you want to use as the basis of a new object-relational system. Use the Design Editor to enhance and complete the designs.

•	Record new designs, using the Design Editor's design components.

•	Capture existing systems into the repository, using the generator products' capture facilities. Then enhance and complete the resulting designs using the Design Editor.


About the Design Editor

Related Topics

The Design Editor has a range of components, supporting features and utilities that you can use to record database and application designs in the repository.  About

Note:	The work surface is the space on which the component windows are displayed.

Some of the design components are used for both database design and application design. These design components are:

Design Component	Purpose
Design Navigator	Creating, editing and deleting all types of design level repository elements, e.g. tables and modules.
Property Palettes and Property Dialog Boxes	Specifying properties of elements, e.g., changing a table definition name.
Logic Editor	Specifying server-side logic and application logic.
Generator Preferences Palette	Setting generator preferences.

The Design Editor also contains design components that are specifically for either database design or application design. For example, you use Server Model Diagrams for database design and Module Diagrams to design modules from which applications can be generated.

When you use the Design Editor, you will notice that the menus, and their options, change according to the type of component or window that is active, thus presenting only the options that are appropriate for the selection in the active window.

Note:	If you are working with a non-versioned repository, the Version menu is permanently dimmed, i.e., none of its options are available to you.


Fundamentals of using the Design Editor

Related Topics

The range of tasks that you can perform from the Design Editor vary, depending on your chosen approach and goal.

Before starting to use the Design Editor you should:

•	ensure you have sufficient access to the repository	About
•	identify your starting point, e.g., whether you want to create a completely new design or create a design based on an existing system	About

When you have established that your access rights are correctly defined and you have identified your starting point, you are ready to start using the Design Editor. Some key points to note when using the Design Editor are:

•	the Design Editor allows you to create designs that span multiple containers	About
•	repository updates made outside the context of your Design Editor session are not automatically available to you	About
•	if you are using a versioned repository, you should be aware of version control features specific to the Design Editor, e.g. Automatic Checkout	About


About containers and the Design Editor

Related Topics

The repository elements you create within the Design Editor are stored in repository containers.  About

From the Design Editor, the containers that are visible to your workarea are displayed in the Design Navigator. Wherever you are required to specify a container for an object in your design, for example when using the Design Guides, you choose from a list of recently used containers. A button is displayed to the right of the container list, allowing you to choose a container that doesn't appear in the history list.

Note:	Checked-in containers are identified by default using the color pale blue.

The System Folder (a container of special significance) must always be visible to your workarea. This folder provides the predefined languages required for designing applications.

When you create diagrams in the Design Editor, the diagram elements do not have to exist in the same container as the diagram on which they are displayed.

Note:	Server Model Diagrams may contain repository elements from more than one container.


About repository updates and the Design Editor

Related Topics

If you are working in a shared workarea, or you have more than one Oracle Designer tool open, you should be aware that updates made to the repository by other users, or by you in another Oracle Designer tool, are not automatically reflected in the Design Editor. If you want to be notified of changes to data shown in the Design Editor, you should use the broadcast mechanism to highlight where repository data has been updated.

Although the broadcast mechanism highlights where updates have taken place, you must use the Requery facility to update the Design Editor.  About

If the information displayed in the Design Editor is out of date, it is likely that:

•	A requery operation to fetch the most recent repository data has not been performed from the Design Editor.

•	The workarea specification has changed but has not been refreshed. This applies to versioned repositories only.


About version control and the Design Editor

Related Topics

As you build and develop complex designs in the repository, you may decide to use the Oracle Repository version control system, e.g., to maintain a history of changes. From the Design Editor you can perform tasks, such as checking in and checking out of repository objects, comparing object versions and viewing details about versioned objects. More complex tasks such as specifying branch labels can be performed from the Repository Object Navigator only.

If you decide to version your repository, you should use the Repository Object Navigator to specify policies for branching, labeling and locking, e.g., whether a Strict Locking policy is to be used.

From the Design Editor, an Automatic Checkout feature is provided to allow checked-in repository elements to be automatically checked out when they are required to be updated, e.g. if you change the properties of an element or run design capture. About

The Design Navigator uses the following notation to identify the repository objects that are under version control, and whether they are checked-in or checked-out.

Identifier	Meaning
element_name	Repository element that is not under version control.
element_name	Repository element that is under version control and checked-in.
Element_name	Repository element that is under version control and checked-out.
Note:	This example illustrates the default colors only. The colors used are customizable and can be changed.  How

Primary differences between working with a versioned or non-versioned repository

Using the Design Editor to create repository designs and run the generator products from a versioned repository is very similar to working with a non-versioned repository.

If you have used the Design Editor with non-versioned repositories, you will see one major difference with a versioned repository: the properties of a repository element (i.e., a PAC element or its associated SAC elements) can only be updated if the element is checked-out or if the element has not been added to version control. For example, if you capture a database to a checked-in container the operation will fail, unless you have opted to use the Automatic Checkout feature.

Note:	The application generators can update repository element properties during generation. If the elements requiring update are checked-in (and Automatic Checkout is switched off) generation proceeds but the repository is not updated. Distinctive colored messages are displayed in the Message Window to indicate whether the generators have successfully updated the repository.

Diagrams are always opened in edit mode, regardless of the Automatic Checkout option. For example, if you open a checked-in diagram, it is checked out ready for you to perform edits. If you close the diagram without making any changes the check-out operation is undone, reverting the diagram to its checked-in state. If you do edit the diagram it remains checked-out until you check it in.

In a versioned repository, a workarea's specification (i.e., configurations and/or workarea rules) determines which versions of which repository elements are visible to the workarea. When defining the specification for a workarea, it is your responsibility to make sure that the correct versions of the correct repository elements are visible to the workarea.


Design Editor utilities

Related Topics

To help automate the process of recording your designs, the Design Editor contains a number of utilities, that are available from the Utilities menu.

The Utilities menu updates dynamically, presenting utilities that are relevant to the current selection. For example, if a Server Model Diagram is the active window, utilities for managing diagram arcs are displayed on the menu, if the Navigator window is active the arc utilities are not displayed because they can be used only for Server Model Diagrams.

General utilities

Copying elements

Force deleting elements

Resequencing elements

Selecting objects in other tools

Locking and unlocking generator preferences

Freezing and unfreezing generator preferences

Utilities specific to database design

Creating Oracle object types from relational tables/views

Creating object views for relational tables/views

Creating arcs

Adding foreign keys to arcs

Deleting foreign keys from arcs

Updating columns in a domain

Utilities specific to application design

Generating default links during application design

Generating default Lists of Values

Changing components between reusable and non-reusable

Mapping unbound items to database columns

Creating item groups using diagrams

Removing items from a group on a diagram

Copying elements with new languages

Copying menu structures

Pre-generation Validation utility


Validating repository designs prior to generation

Related Topics

The Validate utility enables you to quality check application designs recorded in the repository, prior to generating a product. For example, you can validate Oracle Forms applications.

During validation, any parts of a design that will prevent the generator products from completing successfully are reported by the messaging system. You can use the messaging system to locate and correct any errors.  How

When you are satisfied with the results from the Validate utility, you can run the generator products to create the required application.

To validate a module:

1.	Select the required module from the Navigator or ensure that a module diagram is the active window.

2.	Choose Utilities→Validate.


About the Design Guides

Related Topics

The Design Editor provides three guides that help you to perform the main design tasks, e.g. creating a database design. A map is supplied with each guide, to show you the structure of the guide and the repository elements that you can define using that guide.

Note:	To display a guide's map click the Show Map button.

Guide Name	What does the guide do?
Server Model Guide	Takes you through the process of creating a logical database design, i.e., a design without implementation considerations.
Module Application Guide	Takes you through the process of creating, designing and generating your client applications, such as forms, reports and Visual Basic applications.
Database Administration Guide	Takes you through the process of defining implementation aspects, such as storage and security for a database.
To start the guides:

You can start the guides from the Welcome Screen when you start the Design Editor or you can start the guides at any time, by selecting the required guide from the Design Editor Tools menu.

Tip:	When a guide is displayed you can perform other tasks within the Design Editor and return to the guide at any time.

To use the guides:

From the first page of each guide you can create a new design in the repository, either by working through the guide or by capturing an existing system. Each subsequent page is typically one of the following:

•	A list of repository element types (determined by the guide you are using and the previous displayed page) from which you choose the type of element with which you want to work, e.g., Sequences, Tables and Columns.

•	A list of elements (determined by your choice of element type) that are part of your design. You can create, edit or delete elements from this type of page. Where appropriate, you can also display elements on diagrams or start the generator products.

Note:	Your design is stored in the container specified on the first page of the guide.


About the Module Display Wizard

Related Topics

The Module Display Wizard helps you to define layout details for a module component, sub-component or List of Values component. For example, it allows you specify which items are visible on a generated application. This wizard is available from the Design Editor and can be used for editing both reusable and non-reusable components.

Note:	The Module Display Wizard cannot be used to create components.

To define module layout details using the Module Display wizard:

1.	From the Design Editor, select the required component from the Navigator.

2.	Choose Tools→Module Display Wizard.

The wizard title bar identifies the module language, e.g. Visual Basic.


Using the Design Editor for database design

Related Topics

Before starting to use the Design Editor to create database designs in the repository, you should understand the fundamental concepts, e.g., how your access to the repository is determined.  About

Use the following design components to perform database design tasks:

Design components	Tasks you perform with the design components
Design Navigator (Server Model, DB Admin and Distribution tabs)	Creating, editing and deleting all types of database design elements, e.g. database and database user definitions.
Server Model Diagrams	Creating, editing and deleting logical database design elements, e.g. table and column definitions.
Property Palettes and Property Dialog Boxes	Specifying properties of elements, e.g., changing a table definition name.
Logic Editor	Specifying server-side logic, e.g., entering Java classes.
Generator Preferences Palette	Setting generator preferences.
Database Navigator	Viewing online databases.

In addition to the design components there are many supporting features. In particular, the following features help you to create database designs that are as complete and correct as possible:

•	Server Model Guide

•	Database Administration Guide

•	Default Database Implementation Wizard

For information about the process of creating a database design, see Generating a database - step by step

Utilities are provided to automate as much of the database design process as possible. In addition to general Oracle Designer utilities such as the Extended Copy utility, the following utilities are specific to the database design process:

•	Creating Oracle object types from relational tables/views

•	Creating object views for relational tables/views

•	Creating arcs

•	Adding foreign keys to arcs

•	Deleting foreign keys from arcs

•	Updating columns in a domain


Designing and generating applications

Related Topics

Before starting to use the Design Editor to create database designs in the repository, you should understand the fundamental concepts, e.g., how your access to the repository is determined.  About

The fundamental steps for designing and generating an application are:

• Design a database.	How
• Design the application.	How
• Generate the application.	How
• Modify the application design.	How
These steps are the same for all languages, enabling you to implement the same application in multiple languages.

In addition to creating new designs within the Design Editor, you can use existing applications as the basis for new designs. This process is called design capture.  About

Making full use of Oracle Designer features like application logic, you can generate finished applications without making any modifications using the target language. Producing these "100% generated" applications ensures that you can record the whole of an application design in the repository, without having to make any manual edits to the final generated application. A Logic Editor is provided to help you record application logic.

Summary of Design Editor support for application design

Module Diagrams and Reusable Component Diagrams are supplied for you to create and edit your application designs graphically. In addition, the following application design specific features are provided:

•	Module Application Guide

•	Module Display Wizard

•	Module Network Viewer

•	Relative Tab Stops Editor


The application design process - designing a database

Related Topics

Before you can use Oracle Designer to design and generate an application, you must ensure that a database design is accurately recorded in the Oracle Designer Repository.

A database design comprises repository elements such as tables, columns and constraints. You will use these elements when designing an application. Making sure the server model elements are as complete as  possible will both speed up the application design process and ensure that the generated applications are consistent. For example, setting a table definition's Display Title property will ensure every application that uses the table definition will use the same default title.

When you design an application, you reference server model elements held in the repository. The actual database objects themselves do not have to exist on the database before you design or generate an application. For example, during application design you may want to specify that a generated application uses the Employees table. The Employees table definition must have been recorded in the repository but it need not have been created on the database. Note that before you can run the generated application, the Employees table must exist on the database.

You can record a new database design in the repository using Oracle Designer in one of the following ways:

• Create a database design automatically from analysis data, using Database Design Transformer.	How
• Record a new database design, using the Design Editor.	How
• Capture database objects from an existing database, by capturing the database into the repository.	How


The application design process - designing an application

Related Topics

Before you can generate a client application, e.g., an Oracle Forms application, you must design the application and record that design in the Oracle Designer Repository.

When you design an application, you make use of server model elements recorded in the repository during database design. If you have not already recorded your database design in the repository you must do so before starting to design applications.  How

The first step in application design is to create a repository module definition. Each module definition is the basis from which you can generate an application. For example, to generate an Oracle Forms module you would create a module definition in the repository.

Having created a module definition you represent the main parts of a generated application by creating module components. For example, each block on a generated Oracle Forms form is generated from a module component. Module components are particularly useful for reusing and sharing parts of applications.

For each component that is to access database tables you must create module component table usages. The table usages are references to table definitions in the repository, identifying which tables are to be used. When creating table usages, it is important that the database design recorded in the repository reflects the online database against which the generated application is to be run.

With the module definition, its module components and its table usages in place, you can define elements in the application to display and manipulate data from columns in the database. You enter descriptions of these elements into the repository as item definitions.

In summary, the steps to create a basic application design are:

• Create a module definition.	How
• Create a module component.	How
• Create a module component table usage.	How
• Create an item definition.	How

Having completed these tasks, you are ready to use the Oracle Designer generators to generate an application from your design.

Initially, you may find that your generated applications do not immediately meet your requirements. The appearance or functionality of the application may not be what you intended, so you will have to modify your application design using Oracle Designer features, such as generator preferences and application logic.


The application design process - generating applications

Related Topics

Before you can generate an application, you must first have entered the following in the Oracle Designer Repository:

• a database design	How
• an application design	How

Depending on the functionality in the application that is to be generated, you might also have to use the Generate Database Objects utility to create:

•	the code control table needed to provide unique identifiers for columns deriving unique values from a sequence defined as 'Code Control'. This is relevant for Oracle Forms applications, Visual Basic applications and Web PL/SQL applications.

•	the reference code table needed to carry out runtime validation and LOV processing for columns deriving values from 'dynamic lists' or 'domains', e.g., pop lists and text lists. This is relevant for Oracle Forms applications and Oracle Reports applications, Visual Basic applications and Web PL/SQL applications.

To generate an application:

1.	From the Design Editor, select the module definition from which you want to generate an application.

2.	Do one of the following

•	To generate an application in the language currently specified for the module definition, choose Generate→Generate Module (e.g., to generate an Oracle Forms application from a repository module whose Language property is set to Oracle Forms).

•	To generate an application in a different language to that currently specified for the module definition, choose Generate→Generate Module As and specify the new language (e.g., to generate a Visual Basic application from a repository module whose Language property is set to Oracle Forms).

3.	(Optional)  Click Options to set the generation options. After setting your preferred options close the Options dialog box.

4.	Click Start.

The Message Window is displayed showing the generation status. If the generator proposes changes to the application design, you are given the option of accepting, rejecting or editing the proposed changes.  About


The application design process - modifying application designs

Related Topics

Having generated an application from the Oracle Designer Repository, you may find that the appearance or functionality is not what you intended.

You can perform the following tasks to improve and enhance your application designs:

•	set generator preferences  How

•	define application logic  About

•	define multiple module applications by creating module networks.  How

•	provide help for generated screen based applications  How

•	change the basic layout of an application  How


Capturing applications into the repository

Related Topics

Design capture is the process of taking an existing application, and creating a corresponding repository module definition. For example, you can capture an existing Oracle Forms application into the repository and then edit the resulting repository elements. The design capture process enables you to use the repository's reporting and cross-referencing facilities to document the existing application and prepare for further system development.

Note:	Generator preferences are not set during design capture.

The Oracle Designer application generators do not attempt to infer the database design from the captured application. Therefore, definitions of the tables and columns used by an application must already exist in the repository before you can capture the design of that application. If the required database object definitions do not already exist in the repository, consider using the Oracle Designer Capture Server Model from Database utility to read information from the database and create corresponding table and column definitions in the repository. For more information about capturing database objects, see Capturing an existing database design.

You can capture designs for each of the application types listed below.

• Oracle Forms	About
• Oracle Reports	About
• Visual Basic applications	About
Note:	You can also capture designs of existing Oracle common library modules.  About


Hints and tips for the Design Editor

Related Topics

The hints and tips are grouped in the following categories:

•	Creating, editing and deleting repository elements

•	Using diagrams

•	Using drag and drop

•	Advanced tips for power users

Creating, editing and deleting repository elements

Creating repository elements

Editing repository elements

Deleting repository elements

Creating repository elements

•	You can quickly create several repository elements of the same type, using the Fast Create facility.  How.

•	To fast create repository elements directly from the Design Navigator, ensure the Design Editor is set to use Property Palettes. Then select the container that identifies the type of element that you want to create (for example, Tables). Click [image]. An entry box is displayed in the Navigator. Enter the name of the element. Then press Enter to save the element or the Down arrow key to add another entry.

Note:	If the container is empty, you can double-click on its name to display the Navigator entry box.

Editing repository elements

•	To edit the properties of a repository element, double-click on the name of the element to display a Property Palette or Property Dialog box.

•	To see all of the properties that exist for a repository element when editing it from a diagram, set the Design Editor to use Property Palettes. Each time you click on a diagram element, all of its properties are displayed in a Property Palette.

•	To see properties for more than one repository element in the same palette, set the Property Palette to spreadtable mode.

Deleting repository elements

•	To delete elements to which references have been made by other elements, use Utilities→Force Delete.

Using diagrams

•	When printing diagrams, use the Fit to Page option (on the Print dialog box) to print the diagram on a single page. Alternatively, use the X and Y fields to specify the number of pages on which to print the diagram.

•	You can set the Design Navigator to track your diagram selections.  How

See also:

Hints and tips for Server Model Diagrams

Hints and tips for Module Diagrams and Reusable Component Diagrams

Using drag and drop

Drag and drop within the Design Navigator

Drag and drop across Design Editor components

Drag and drop to perform design capture

Drag and drop within the Design Navigator

From the Design Navigator, you can use drag and drop to copy, move and share elements. When you use drag and drop to perform these actions in the Design Navigator, use the following keys:

Key	Purpose	Example
CTRL	Copy	To create a copy of a table definition in a different container, hold down CTRL and drag the element to the container.
SHIFT	Move	To move a view definition from one container to another, hold down SHIFT and drag the element to the container.
ALT	Link/ Associate/ Share	To share a table with another container, hold down ALT and drag the element to the container.

If you drag and drop elements within the Design Navigator, without holding down CTRL, SHIFT or ALT, the Design Editor will perform the most appropriate action (in most instances Copy is performed).

Note:	When you use drag and drop, the action that will be performed is identified by the cursor shape and the Status Bar (displayed at the base of the Design Editor window).

Drag and drop across Design Editor components

You can drag and drop repository elements between the different Design Editor components. Some examples are:

Element type	From	To	Result
Table	Navigator	Server Model Diagram	Places the elements on the diagram.
Table	Database Navigator	Navigator	Captures design of online database elements.
Table	Navigator and Server Model Diagrams	Database Navigator	Generates elements on a database.
Table	Navigator	Module Diagram	Creates usages of elements for a module
Drag and drop to perform design capture

You can drag a selected file, e.g., a .fmb file from its current directory in the file system, directly onto the Design Editor work surface. This causes the appropriate Design Capture dialog box to be displayed, the 'file to be recovered ' is automatically populated in the dialog box.

You can use the drag and drop method to capture the following:

File type to be dragged	Type of application to be captured
.vbp	Visual Basic
.rdf	Oracle Reports
.fmb	Oracle Forms
.pld, .pll	Oracle Common Libraries
.sql. .pls, .ddl, .rrd, .sch	Server Systems
Advanced tips for power users

•	To get help about a specific element property or a generator preference use the Find facility, from the Help Contents page. Alternatively, select the item for which you want help and press F1.

•	Use shortcut keys to copy and paste repository elements between different components. For example, to place a table on a Server Model Diagram, you can select the table on the Navigator, then press CTRL C. Ensure the required Server Model Diagram is the active window and then press CTRL V.
To view the available shortcut keys, choose Help→Show Keys.

•	Use the Right mouse button to quickly access valid actions.
The right mouse button displays a popup menu listing the valid actions that can be performed. The options that are displayed on the popup menu are in the context of where the cursor is placed and what is selected.

For example, if you position the cursor over a table name in the Navigator and then click the right mouse button, a popup menu is displayed. The menu shows the tasks that are most commonly performed for tables, e.g. creating a table definition, opening a diagram containing the table or generating a database table from the element.

•	Attach textual information to a selected repository element by choosing Edit→Text. Note, 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.  How

•	To find an element in the active window, search for a text string.  How

•	Find where elements are referenced by other elements.  How


Using the Generator Preferences Palette

Using the Generator Preferences Palette to set preferences

Setting generator preferences - step by step

Displaying the Generator Preferences Palette

Creating and deleting generator preference sets

Referencing generator preference sets

Unsetting a generator preference to use an inherited value

Copying generator preferences

Locking and unlocking generator preferences

Freezing and unfreezing generator preferences

Saving and reverting generator preference settings

Using the Generator Preferences Palette to view and locate preference values

Setting the Generator Preferences Palette to track selections

Locating inherited generator preference values

Showing and hiding preferences on the Generator Preferences Palette

Showing or hiding generator preference icons

Displaying generator preference names


About generator preferences and server generation

Related Topics

Server Generator preferences are parameters that customize databases you capture into the repository. You can customize the way databases are both generated and captured by changing the initial settings of Server Generator preferences. For information about these preferences, click below.

•	Server Generator preferences

Server generator preferences are set against containers only, i.e. you must select the name of a container on the navigator to see the groups of preferences that can be set. If you do not set a preference against a container the factory setting, i.e. the default, is used.


About generator preferences and application generation

Related Topics

Generator preferences are parameters that control the appearance and behavior of generated applications. They can be used for prototyping purposes when module specifications are not fully defined. They can also be used to customize generated applications when the database design is complete and each module specification is fully defined.

For each type of application that you can generate using Oracle Designer, you are provided with a number of preferences. For information about these preferences, click below.

•	Form Generator preferences

•	MS Help Generator preferences

•	Report Generator preferences

•	Visual Basic Generator preferences

•	Web PL/SQL Generator preferences

In general, it is desirable that modules within a generated application have similar behavior and appearance. Sometimes, however, an individual module will have a requirement for a unique feature. For example, the standard for your application may be that all radio groups are arranged vertically, but, for a particular instance of a radio group in a generated application, you may want the radio buttons displayed horizontally.

Preferences can be set at various levels, allowing global and local customization for generated applications. For example, preferences can be set at the highest level (container) so they are incorporated in all generated applications. In addition, they can be set at lower levels (modules, for example), so that specific modules can be customized.  About

Note:	Typically, designs for generated applications are recorded within application systems in the Oracle Designer Repository. It is also possible to record application designs within folders.

Every preference has a default (factory setting) that can be used by the generator products. Therefore, it is possible to perform generation without first having to set any preferences.

If you change the value of a preference, that preference is regarded as being explicitly set, even if you have specified the same value as the factory setting for that preference. To return a preference to its factory setting you must unset the preference for that element and any other elements from which it inherits its value. How

For example, suppose the factory default for preference BLKBWD is 4 and you change the value of the preference for a table to 16. The preference icon displayed next to the preference on the Generator Preferences Palette is updated from a factory icon to a table icon. If you then change the preference back to 4, the value is changed but the icon is not updated to show the factory icon because the preference is still considered to be explicitly set.

Groups of preferences can be held in generator preference sets. The values in these preference sets can be applied to all or part of a container.  About

Note:	When a preference value is set via a reference to a preference set, the preference is regarded as being explicitly set, i.e. the preference does not inherit its value from a higher preference level and it does not use the factory setting.

Preferences inherit their values unless they are explicitly set. For example, if a preference value is set at container level, the elements within that application will inherit the same preference value.

Preferences are either mandatory or optional. A mandatory preference must always have a value. For example, the Visual Basic preference HTUINT allows you to specify whether hint text should be created for buttons. This preference value must be set to either Yes or No.


About application generator preference levels

Related Topics

Generator preference levels identify the types of repository elements for which preferences can be set for a container. All preferences are applicable at container level, but only a subset of these preferences are available at other levels.

The levels at which preferences can be set are listed below.

	Factory		Table		Module		Constraint usage
	Container		Column		LOV component		Item
	Domain		Constraint		Module component		Item group
					Module sub-component		Action Item
Note:	The Generator Preferences Palette can optionally be set to display preference level icons.  About

During generation, the Generators search to find the preference level at which each required preference is set, taking into account any preference sets that have been applied. The required preferences are determined by the product that is being generated.  About

Product	Preference levels
Help Generator	Container and module
Reports Generator	Container, module and module component
Visual Basic Generator	Container and module
Web PL/SQL Generator	Container, table, module, component (module or LOV) and action item
Form Generator	Container, domain, table, constraint, column, module, component (module, sub or LOV), constraint usage, item, item group
Factory level preference values

Factory level preferences are the default values that are supplied for each of the different products. Initially, all preferences use factory settings and therefore have a [image] displayed next to them on the Generator Preferences Palette. As a generated application is developed and enhanced, its appearance and behavior can be altered by setting the preferences at other preference levels.

If you change the value of a preference, that preference is regarded as being explicitly set, even if you have specified the same value as the factory setting for that preference. To return a preference to its factory setting you must unset the preference at that level and at any levels from which it inherits its value.  How

For example, suppose the factory default for preference BLKBWD is 4 and you change the value of the preference to 16 at table level. The icon displayed next to the preference is updated from a factory level icon to a table level icon. If you then change the preference back to 4, the value is changed but the icon is not updated to show the factory level icon because the preference is still regarded as being explicitly set.

Container level preference values

Setting preferences against a whole container ensures consistent behavior and appearance of generated applications.

When you set a preference against a container, its value is inherited by other repository element types for which preferences can be set. However, if you then set the preference, or you create a reference to a preference set, for a different element type (e.g., a module), it is the value specified at the lower level that is used by the Generators.

Domain level preference values

For each domain in a container, you can set preferences to control how the domain values are displayed on a generated form. These preference settings are then used by columns within that domain and bound items based on those columns. For example, you may set a preference to control the maximum number of entries that appear in a text list (TLSMAX) on a generated form.

When you set a preference against a domain, the preference value is inherited by:

•	columns within the domain

•	bound items based on the columns

Table level preference values

For each table in a container, you can set preferences to control how the table values are displayed on a generated application. For example, for a table that will always be used as a detail block on a form, you could specify that the block will always be displayed with a vertical scroll bar by setting the BLKVSB preference to Y for that table.

When you set a preference against a table, the preference value is inherited by:

•	constraints within the table

•	columns within the table

•	components (module, LOV and sub) for which the table is a base table usage

Note:	Preferences for constraints are inherited by usages of those constraints; preferences that are set for columns are inherited by items based on those columns, hence table preferences are also inherited by these types of repository elements.

If you wish to set a preference against a constraint in the context of a particular table usage, you must first create the constraint usage.

Constraint level preference values

For each constraint in a container, you can set preferences to control when the constraint is used on a generated application. For example, you may set a preference to control when foreign keys should be validated on a generated form.

When you set a preference against a constraint, the preference value is inherited only by usages of that constraint.

To determine which value to use for a constraint, an application generator analyzes the repository element types starting from the constraint.  About

Column level preference values

For each column in a container, you can set preferences to control how the columns are used in a generated application. For example, you may set a preference to control the maximum number of values that appear in combo boxes based on that column.

When you set a preference against a column, the preference value is inherited only by usages of that column, i.e., bound items.

To determine which value to use for a column, an application generator analyzes the repository element types starting from the column.  About

Note:	Tables do not inherit preference values from domains. The illustration shows the order in which the generator searches for column preference values, i.e., first at table level and then at domain level.

Module level preference values

For each module in a container, you can set preferences to control the appearance and behavior of the application that is generated from that module.

When you set a preference against a module, the preference value is inherited by:

•	components (module, LOV and sub) in the module

•	items in the module

•	constraint usages in the module

•	item groups in the module

•	action items in the module

To determine which value to use for a module, an application generator analyzes the repository element types starting from the module.  About

Module component / sub-component / LOV component level preference values

For each module component, sub-component and List of Values (LOV) component in a container, you can set preferences to control the appearance and behavior of that component on a generated application. For example, you may set a preference against a module component to control the maximum number of entries that appear in a text list (TLSMAX) on a generated form.

When you set a preference against a component, the preference value is inherited by:

•	items in the component

•	item groups in the component

•	constraint usages in the component

Note:	Module sub-components inherit directly from the owning module, not from the owning module component.

To determine which value to use for a component, an application generator analyzes the repository element types starting from the module component.  About

Note:	Module does not inherit preference values from table. The illustration shows how the generator searches for component preference values, i.e., first at module level, and then at table level.

If the component contains a base table usage, the generators include table level in the search. If the preference is not set at any level and is not derived from a preference set, the factory setting is used.

It is important to note that preferences explicitly set against a reusable component are used wherever that component is included, i.e., the reusable component's preference settings take precedence over preferences set at higher levels. Non reusable components always inherit their preference values from the owning module. When a reusable component is included in a module it inherits preference values from that module.

Note:	To view the actual values that will be used to generate an application from a module, any reusable components must be shown on the Generator Preferences Palette in the context of that module.

Constraint usage level preference values

For each constraint usage in a container, you can set preferences to control how the constraint usage is used on a generated application.

Constraint usage preference settings are not inherited by any other repository element types.

To determine which value to use for a constraint usage, an application generator analyzes the repository element types starting from the constraint usage.  About

Note:	Module does not inherit preference values from table or constraint. The illustration shows how the generator searches for constraint usage preference values, i.e., first at component level, then module, then constraint, then table level.

Item level preference values

For each item in a container, you can set preferences to control how the group is used on a generated application. The domain, table and column levels apply to bound items only.

Item preference settings are not inherited by any other repository element types.

To determine which value to use for a bound or unbound item, an application generator analyzes the repository element types starting from the item.  About

Although items do not inherit preference values from item groups, they can inherit values from preference sets applied at item group level.

Note:	Domain, table and module each inherit their preference values from container, e.g., module does not inherit preference values from table or domain. The illustration shows how the generator searches for item preference values, i.e.,  first at component level, then module, constraint, table and domain.

Item group level preference values

For each item group in a container, you can set preferences to control how the item group is used on a generated application. For example, you may set a preference to control the decoration that is drawn around an item group on a generated application.

Item group preference settings are not inherited by any other repository element types.

The diagram below shows the levels from which preferences applicable to item groups can be derived. The generators determine an item group's preference settings, by searching first at item group level, then each subsequent level up to container level. If the preference is not set at any level and is not derived from a preference set, the factory setting is used.

Action item level preference values

For each action item in a container, you can set preferences to control how the item is used on a generated application.

Action item preference settings are not inherited by any other repository element types.

The diagram below shows the levels from which preferences applicable to action items can be derived. The generators determine an action item's preference settings, by searching first at action item level, then each subsequent level up to container level. If the preference is not set at any level and is not derived from a preference set, the factory setting is used.


Identifying which preference values are used during application generation

Related Topics

When developing application designs in the repository, an optional part of the process is to set generator preferences. The preferences can be set against repository elements, e.g., modules, to control the level at which preference values are applied.  About

The Generator products follow a few simple rules to identify what preference values should be used during generation. For each preference, the search begins with the lowest applicable level at which preferences can be set and continues to each subsequent higher level. At each level the Generators first identify whether the preference is explicitly set against a repository element and if it is, that value is used. If the preference value is not explicitly set against a repository element, the Generators identify whether it is set using a preference set.

Note:	A preference value that is determined by a generator preference set is regarded as being explicitly set.

Checks are performed at each level until the Generators find the level at which the preference is explicitly set. If the preference is not explicitly set at any level, the factory setting is used.  About

Where containers are nested, preference values are inherited only from the immediate owning container. For example, where application system B is the child of application system A, preference values are inherited from application system B where appropriate, otherwise the Factory defaults are used. No inheritance will occur from application system A.

Elements that are shared into a container from another container, keep any explicitly set preference values. For example, if you share a reusable module component into several different containers, the explicitly set values for that module component will be available in each container.


The Design Navigator

Understanding the Design Navigator

About the Design Navigator

About the Design Navigator icons

Using the Design Navigator to record data in the repository

Displaying the Navigator

Creating repository elements

Editing repository elements

Deleting repository elements

Using Design Navigator features

Tracking diagram selections on the Navigator

Fast creating repository elements

Customizing the Navigator


About the Design Navigator

Related Topics

The Design Navigator displays repository data in a tree structure, enabling you to view and manage repository elements for a workarea.

The Design Navigator has a number of views that focus on different aspects of the design process. These views are represented by tabs and can be alternated according to the task that you want to perform. You can specify whether views are identified using names or icons.

Icons/names of views	Design processes
	Server model design	Creating logical database designs
	Module application design	Designing client applications
	Database administration design	Recording database administration details
	Database distribution design	Recording database distribution details
Note:	Some repository elements, such as tables, are included in more than one Navigator view. For example, table definitions are shown in the Server Model Design view and the Module Application Design view. From the Server Model Design view, the associated elements for database design, e.g. indexes can be accessed. From the Module Application Design view, only the elements that are useful for module design, e.g. columns and keys, can be accessed.

If you use a diagram to create, edit or delete a repository element, the Design Navigator is updated automatically to reflect the changes. If changes are made to the same container by different users, a broadcast mechanism causes the Design Navigator to flag which repository elements have changed.  About

Note:	Certain repository elements can be created/updated via the Navigator only. For example, you create and manipulate domain definitions on the Navigator. Similarly, distribution elements are always created and maintained using the Navigator.

Icons are displayed on the Navigator to identify the different repository element types, e.g., [image] is displayed next to relational table definitions. In addition, icons that identify the state of an element are displayed on the Navigator, e.g., [image] is displayed when an element has been changed by another user.  About

The Navigator uses colored text to identify information about the nodes it displays. For example, repository elements that are checked-in, i.e., read only, are by default displayed in a different colored text to those elements that are not checked-in. You can change the color and font used on the Navigator.  How

You can customize the content and appearance of the Navigator. For example, you can filter repository elements from the tree, and you can specify display characteristics for the views.  About


About the Design Navigator icons

Related Topics

Each instance of a repository element has a corresponding icon. These icons are displayed alongside the elements on the Navigator. For example, [image] is displayed next to each relational table definition.

In some cases the icon displayed next to a repository element represents more than a graphical representation of the element type:

•	for modules and module components, icons identify the module language

•	for columns and Oracle object type attributes, icons represent their datatypes  About

In addition to the repository element icons, there are also icons that provide additional information about what is displayed on the Navigator.

Icon	Description
	Identifies that a repository element is referenced from another container.	About
	Identifies that a repository element is checked-out.	About
	Identifies that a repository element has been changed by another user or from another tool and needs refreshing.   Note: Clicking on this icon performs a requery.	About
	Identifies that a Navigator node is filtered. For example, the Relational Tables node may be filtered to show only tables that are created by a specific user.	About
	Identifies where a recursive loop occurs. For example, on a module network where Module A calls Module B and module B then calls Module A.


Database Object Definitions
Displayed Items and Groups branch - Navigator

Related Topics

The Displayed Items and Groups branch is a heading that is displayed from the Modules view of the Navigator. It displays repository elements for which item information can be displayed on generated applications.

This node is displayed within the context of module components and shows item group definitions, bound item definitions and unbound item definitions.

For information about the repository elements that can be accessed from this part of the Navigator, see:

Bound Items

Item Groups

Unbound Items


Security
Security branch - Navigator

Related Topics

The Security Objects node is a heading that is displayed from the Modules view of the Navigator. This Navigator heading displays repository elements that are used to record which users and roles have permission to use an application that is generated from a module definition recorded in the repository.

For information about the repository elements that can be accessed from this part of the Navigator, see:

Modules


Server Model Diagrams

Understanding Server Model Diagrams

About Server Model Diagrams

Server Model Diagram elements and notation

Server Model Diagrams - Object connectors

Using Server Model Diagrams to create database designs

Creating Server Model Diagrams

Opening Server Model Diagrams

Specifying containers for Server Model Diagram elements

Creating Server Model Diagram elements

Including repository elements on a Server Model Diagram

Editing the properties of an element on a Server Model Diagram

Deleting elements from Server Model Diagrams

Using Server Model Diagram features

Tracking associations on Server Model Diagrams

Showing or hiding text for foreign key connectors on Server Model Diagrams

Showing or hiding Server Model Diagram information

Showing or hiding column information on Server Model Diagrams

Viewing secondary element details on Server Model Diagrams

Displaying connector text on Server Model Diagrams

Hints and Tips for using Server Model Diagrams

Tips, tricks and shortcuts for Server Model Diagrams

Drawing tips for Server Model Diagrams


About Server Model Diagrams

Related Topics

The Server Modeler is a graphical tool for modeling logical database designs. The database objects within a schema and how they relate to one another are represented graphically on Server Model Diagrams.

Server Model Diagrams may contain repository elements from multiple containers.

There are several approaches to creating a logical Server model in the repository. Server Model Diagrams support each of these approaches. You can create a Server model from data in the repository, using a transformer, and then use Server Model Diagrams to view and edit the database design graphically. If you are developing a new database, use Server Model Diagrams to create a new Server model from scratch. As you create elements on the diagram, they are also stored in the repository. Alternatively, capture the design of an existing database into the repository, and then use Server Model Diagrams to edit the design.
For information about the types of repository elements that can be represented on Server Model Diagrams, see Server Model Diagram elements and notation.


Creating Server Model Diagrams

Related Topics

This topic explains how to create a Server Model Diagram. To use an existing diagram, you must open that diagram.  How

Note:	In a versioned repository, if you open a checked-in diagram it is checked out ready for you to perform edits. If you close the diagram without making any changes the check-out operation is undone, reverting the diagram to its checked-in state. If you do edit the diagram it remains checked-out until you check it in.

To create a Server Model Diagram:

Do one of the following:

•	Choose File→New→Server Model Diagram.

If you use this option without either selecting a Server Model repository element from the Navigator or ensuring that a Server Model Diagram is active, the New Diagram dialog box is displayed. From the dialog box you must choose the container in which you want the diagram to be created.

•	From the Navigator, select the elements that you want to be displayed on the diagram and drag them onto the work surface.

The container from which you drag the elements determines the container in which the diagram will be created. If you drag elements from multiple containers, the New Diagram dialog box is displayed. From the dialog box you must choose the container in which you want the diagram to be created.

•	From the Navigator, position the cursor over the element that is to appear on a Server Model Diagram. From the right mouse menu, choose Show on New Diagram.

Each new diagram window created is untitled except for a default name "Untitled # " (displayed in the title bar), where # is a number incremented by 1 each time a new diagram is created during the current session. You can either accept the default name when you save the diagram, or assign a more meaningful name.


Opening Server Model Diagrams

Related Topics

If a Server Model Diagram does not already exist you must create a new one. How

To open an existing Server Model Diagram:

Do one of the following:

•	Choose File→Open→Server Model Diagram and choose the required diagram from the list box.

•	From the Navigator, select the required diagram from the Server Model tab and drag it onto the work surface.

If the diagram contains elements that can no longer be found in the workarea the Resolve diagram and workarea dialog box is displayed. From the dialog box identify whether you want to open the diagram without the missing elements, include the missing elements in the workarea or make a copy of the diagram.

You can use the Container List to change the container in which diagram elements are created.  About


Specifying containers for Server Model Diagram elements

Related Topics

When you use a Server Model Diagram to create repository elements, e.g. table definitions, you use the Container List on the main toolbar to identify the container in which the elements are created.  About

To specify the container in which Server Model Diagram elements are created:

1.	Identify the container in which a Server Model Diagram's elements will be created, by clicking on the title bar of the diagram. The name of the container is displayed in the Container List on the main toolbar.

2.	Change the container in which Server Model Diagram elements will be created by choosing a different container from the Container List.


Creating Server Model elements

Related Topics

You can model database designs using Server Model Diagrams. The elements that are shown on the diagrams are recorded as elements in the repository and can be used to generate online databases.

Relational designs	Oracle8 object designs
Creating relational tables	Creating Oracle object types
Creating columns	Creating Oracle object type attributes
Creating arcs	Creating Oracle object type methods
Creating check constraints	Embedding an Oracle object type
Creating clusters	Referencing an Oracle object type
Creating foreign key constraints	Embedding collections of Oracle object types
Creating indexes	Referencing collections of Oracle object types
Creating primary key constraints
Creating materialized views
Creating synonyms
Creating triggers
Creating relational views
Creating unique key constraints
Some server model elements can be created from the Navigator only:

Relational designs	Oracle8 object designs
Creating Domains	Creating object tables
Creating PL/SQL Definitions	Creating object views


Creating relational tables

Related Topics

Relational tables can be modeled using Server Model Diagrams, as described below. Each relational table definition must have a unique name and should contain at least one column.  About

Note:	You can also create object tables.  How

To create a relational table:

1.	Open a Server Model Diagram.  How

2.	(Optional)  Change the container in which the table definition will be created.  How

3.	Click [image].

4.	Position the cursor where you want to create the table and click the mouse button.

A Property Palette or Property dialog box is displayed. The Property dialog box allows you to specify details such as, which columns are to appear on the table. The Property Palette creates a table definition only.  About

5.	Do one of the following to record the table definition in the repository:

•	If a Property dialog box is displayed, enter the table name and alias. Optionally, click Next to enter further details, or click Finish to create the table definition with minimal details. To get help about a dialog box field click ? and then click on the field.

The Default Database Implementation wizard allows you to specify the database and database user for which a database object is to be created. You can specify whether this wizard is to be used by default from the General Settings dialog box. About

•	If a Property Palette is displayed, ensure values are specified for all mandatory properties (these are colored red by default) and optionally specify any other property values. Click [image] to save the changes.


Creating columns

Related Topics

Each column must have a unique name, a datatype and a column sequence. The sequence determines the order in which the columns are created.  About

To create a column:

1.	Open a Server Model Diagram.  How

2.	Select the relational table, relational view, materialized view or cluster diagram element for which the column is to be created.

3.	Click [image].

4.	Enter the names of the columns that you want to create for the selected element.

To edit column details, double-click the column on the diagram. A Property Palette or Property dialog box is displayed. The Property dialog box allows you to edit details for all the columns and define allowable values. The Property Palette displays column properties only.  About


Creating arcs

Related Topics

Columns that are mutually exclusive can be defined on a Server Model Diagram using arcs.  About

To create an arc:

1.	Open a Server Model Diagram.  How

2.	Select one or more foreign key connectors to be included in the arc.

To select more than one element on a diagram hold down the CTRL key as you click on each element.

Note:	The foreign keys must be based on the same element.

3.	Choose Utilities→Create Arc.


Creating clusters

Related Topics

Clustering is a means of grouping common columns in one or more relational tables so that the columns are physically stored in the same data block on the database.  About

To create a cluster:

1.	Open a Server Model Diagram.  How

2.	(Optional)  Change the container in which the cluster definition will be created.  How

3.	Click [image].

4.	Position the cursor where you want to create the cluster and click the mouse button.

A Property Palette or Property dialog box is displayed. The Property dialog box allows you to specify details such as, the cluster key columns and their column mappings. The Property Palette creates an empty cluster definition only.  About

5.	Do one of the following to record the cluster definition in the repository:

•	If a Property dialog box is displayed, follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a Property Palette is displayed, enter the cluster name and specify its type. Optionally specify any other properties. Click [image] to save the changes. Use the Navigator to add cluster columns and their column mappings.


Adding foreign keys to arcs

Related Topics

An arc definition specifies that, for any given row in a relational table, a value must be entered in one of the arc columns.  About

To add foreign keys to an arc:

1.	Open a Server Model Diagram.  How

2.	Select the arc to which you want to add foreign key connectors.

3.	Select the foreign key connectors that you want to add to the selected arc.

4.	Choose Utilities→Add to Arc.

Note:	All the foreign key connectors in an arc must be from the same element, and of the same optionality. No foreign key can be in more than one arc.


Deleting foreign keys from arcs

Related Topics

An arc definition specifies that, for any given row in a relational table, a value must be entered in one of the arc columns.  About

To remove foreign keys from an arc:

1.	Open a Server Model Diagram.  How

2.	Select the foreign keys that you want to remove from the selected arc.

3.	Choose Utilities→Remove from Arc.

Note:	Logically an arc must contain at least two foreign key connectors. If you remove a foreign key connector from an arc leaving only one foreign key connector in the arc, the arc is displayed across the remaining foreign key connector, indicating that the foreign key is part of an arc.


Creating check constraints

Related Topics

You can define a check constraint to determine whether a column value meets a specified condition.  About

To create a check constraint:

1.	Open a Server Model Diagram.  How

Note:	The table, view or materialized view for which you want to define the check constraint, must be displayed on the diagram.

2.	Click the right mouse button on the [image] title bar button of the required relational table, relational view or materialized view element.

Note:	If the [image] button is not displayed, click the right mouse button on the diagram element's title bar.

3.	From the popup menu, choose Add Check Constraint.

A Property Palette or Property dialog box is displayed.  About

4.	Do one of the following to record the check constraint definition in the repository:

•	If a Property dialog box is displayed, follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a Property Palette is displayed, enter the name and SQL Where/Validation condition for the check constraint. Optionally, change any of the default property values. Click [image] to save the changes.

Tip:	To show or hide check constraints for a diagram element, click [image] on the diagram element's title bar.


Creating foreign key constraints

Related Topics

When you create a foreign key, a foreign key column can automatically be created to match the primary key of the referenced relational table. If the referenced table doesn't have a primary key, a default primary key is created. All foreign keys are assigned a constraint name, in the format dependenttable_referencedtable_FK.  About

To create a foreign key and a foreign key column:

1.	Open a Server Model Diagram.  How

2.	Click on the foreign key button for the type of constraint that you want to create.

	Optional Foreign Key
	Mandatory Foreign Key
3.	Click on the relational table, relational view or materialized view diagram element for which the foreign key is to be defined, i.e. the dependent table.

4.	Click on the diagram element that represents the table, view or materialized view  to be referenced.

Note:	If the foreign key is recursive, click within the same diagram element.

To show or hide foreign key constraints for a diagram element, click [image] on the diagram element's title bar.

To create a foreign key based on existing columns:

1.	Choose Options→Use Property Dialogs.

2.	Click the right mouse button on the [image] title bar button of the required table, view or materialized view.

3.	Choose Add Foreign Key from the right mouse menu.


Creating indexes

Related Topics

You can define one or more indexes for relational tables, materialized views and clusters, to increase the speed with which rows are retrieved. About

To create an index:

1.	Open a Server Model Diagram.  How

2.	Click the right mouse button on the [image] title bar button of the required relational table, materialized view or cluster element.

Note:	If the [image] button is not displayed, click the right mouse button on the diagram element's title bar.

3.	From the popup menu, choose Add Index.

A Property Palette or Property dialog box is displayed.  About

4.	Do one of the following to record the index definition in the repository:

•	If a Property dialog box is displayed, follow the instructions on the dialog box to create the index definition and its index entries. To get help about a dialog box field click ? and then click on the field.

•	If a Property Palette is displayed, enter the index name. Optionally, specify any additional properties. Click [image] to save the changes. Use the Navigator to define the index entries for the index.


Creating primary key constraints

Related Topics

When you create a primary key, a default primary key column can automatically be created. All primary keys are assigned a constraint name, in the format tablename_PK.  About

You can rename the primary key column and change its definition after it is created.

To create a primary key and surrogate key column:

1.	Open a Server Model Diagram.  How

2.	Click [image].

3.	Click on the relational table, relational view or materialized view diagram element for which you want to create a primary key.

The primary key column # * is created. The * identifies that the column is mandatory. To show, or hide primary key constraints for a diagram element, click [image] on the diagram element's title bar.

To create a primary key based on existing columns:

1.	Choose Options→Use Property Dialogs.

2.	Click the right mouse button on the [image] title bar button of the required table, view or materialized view.

3.	Choose Add Primary Key from the right mouse menu.


Creating materialized views

Related Topics

A materialized view is a local copy of a table that resides on another in a distributed database.  About

To create a materialized view:

1.	Open a Server Model Diagram.  How

2.	(Optional)  Change the container in which the materialized view definition will be created.  How

3.	Click [image].

4.	Position the cursor where you want to create the materialized view and click the mouse button.

A Property Palette or Property dialog box is displayed. The Property dialog box allows you to specify details such as, the tables on which the materialized view is based. The Property Palette creates an empty materialized view definition only.  About

5.	Do one of the following to record the materialized view definition in the repository:

•	If a Property dialog box is displayed, follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a Property Palette is displayed, enter the materialized view name. Optionally, specify any additional properties. Click [image] to save the changes. Use the Navigator to define the tables and columns for the materialized view.


Creating database synonyms

Related Topics

You can use Server Model Diagrams to define synonyms that mask the names of tables, materialized views, views and clusters in the database.  About

Note:	Database synonyms can be created for Java definitions from the Navigator only.

To create a synonym for elements on Server Model Diagrams:

1.	Open a Server Model Diagram.  How

2.	Click the right mouse button on the [image] title bar button of the required table, materialized view or cluster element.

Note:	If the [image] button is not displayed, click the right mouse button on the diagram element's title bar.

3.	From the popup menu, choose Add Database Synonym.

4.	Enter the synonym name and (optionally) specify any additional properties.

5.	Click [image] to save the changes.


Creating triggers

Related Topics

A trigger performs an action on a relational or object table when a row in the table is inserted, updated or deleted. You can create a trigger if at least one table exists on the diagram.  About

To create a trigger:

1.	Open a Server Model Diagram.  How

2.	Click the right mouse button on the [image] title bar button of the required relational table or relational view element.

Note:	If the [image] button is not displayed, click the right mouse button on the diagram element's title bar.

3.	From the popup menu, choose Add Database Trigger.

A Property Palette or Property dialog box is displayed. The Property dialog box allows you to specify details such as, which columns are to fire the trigger and optionally to define the trigger logic using the Logic Editor. The Property Palette creates an empty trigger definition only.  About

4.	Do one of the following to record the trigger definition in the repository:

•	If a Property dialog box is displayed, follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a Property Palette is displayed, enter the trigger name and optionally, specify any additional properties. Click [image] to save the changes. Use the Navigator to define the columns which fire the trigger and the trigger logic.


Creating unique key constraints

Related Topics

A unique key can consist of one or more optional columns whose values must be unique. The columns must already exist.  About

To create a unique key:

1.	Open a Server Model Diagram.  How

2.	Click the right mouse button on the [image] title bar button of the required relational table, relational view or materialized view element.

Note:	If the [image] button is not displayed, click the right mouse button on the diagram element's title bar.

3.	From the popup menu, choose Add Unique Key.

A Property Palette or Property dialog box is displayed. The Property dialog box allows you to choose columns for the unique key. The Property Palette creates a constraint definition only.  About

4.	Do one of the following to record the unique key definition in the repository:

•	If a Property dialog box is displayed, follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a Property Palette is displayed, enter the unique key name. Optionally, specify any additional properties. Click [image] to save the changes. Use the Navigator to define columns for the unique key.

To show or hide unique key constraints for a diagram element, click [image] on the diagram element's title bar.


Creating relational views

Related Topics

You can create relational views to restrict the presentation of relational table data to different types of database user. A view can be based on one or more base tables.  About

Note:	You can also create object views.  How

To create a relational view:

1.	Open a Server Model Diagram.  How

2.	(Optional)  Change the container in which the view definition will be created.  How

3.	Click [image].

4.	Position the cursor where you want to create the view and click the mouse button.

A Property Palette or Property dialog box is displayed. The Property dialog box allows you to specify details such as, the tables on which the view is based. The Property Palette creates an empty view definition only.  About

5.	Enter the name of the view.

6.	Do one of the following to record the view definition in the repository:

•	If a Property dialog box is displayed, follow the instructions to specify the tables on which the view is based and how the tables are joined. To get help about a dialog box field click ? and then click on the field.

•	If a Property Palette is displayed, enter the view name. Optionally, specify any additional properties. Click [image] to save the changes. Use the Navigator to specify the tables and columns on which the view is based.


Creating Oracle object types

Related Topics

Oracle object types allow you to define your own datatypes that can be used by both relational tables and other Oracle object types. Each Oracle object type should have one or more attributes.  About

Note:	If you want to build an Oracle object type whose structure is based on an existing relational table or view, use the Object View utility.

To create an Oracle object type:

1.	Open a Server Model Diagram.  How

2.	(Optional)  Change the container in which the Oracle object type definition will be created.  How

3.	Click [image].

4.	Position the cursor where you want to create the object type and click the mouse button.

A Property Palette or Property dialog box is displayed. The Property dialog box allows you to specify details such as, attributes for the object type. The Property Palette creates an empty object type definition only.  About

5.	Do one of the following to record the object type definition in the repository:

•	If a Property dialog box is displayed, enter the object type name. Optionally, click Next to enter further details, or click Finish to create the object type definition with minimal details. To get help about a dialog box field click ? and then click on the field.

•	If a Property Palette is displayed, ensure values are specified for all mandatory properties (these are colored red by default) and optionally specify any other property values. Click [image] to save the changes.


Creating Oracle object type attributes

Related Topics

Each Oracle object type that you create should have one or more Oracle object type attributes.  About

To create an Oracle object type attribute:

1.	Open a Server Model Diagram.  How

2.	Select the Oracle object type for which the attribute is to be created.

3.	Click [image] on the toolbar displayed on the right of the diagram.

4.	Enter the names of the attributes that you want to create for the object type.

To edit attribute details, double-click the attribute on the diagram. A Property Palette or Property dialog box is displayed. The Property dialog box allows you to edit details for all the attribute and define allowable values. The Property Palette displays properties for a single attribute only.  About


Creating Oracle object type methods

Related Topics

One or more methods (PL/SQL functions and procedures) can be defined for an Oracle object type. About

To create an Oracle object type method:

1.	Open a Server Model Diagram.  How

Note:	The Oracle object type for which you want to create a method must be displayed on the diagram.

2.	Click the right mouse button on the [image] title bar button of the required Oracle object type diagram element.

Note:	If the Methods button is not displayed, click the right mouse button on the diagram element's title bar.

3.	From the popup menu, choose Add Methods.

A Property Palette or Property dialog box is displayed.  About

4.	Do one of the following to record the method definition in the repository:

•	If a Property dialog box is displayed, follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a Property Palette is displayed, enter the method name. Optionally, specify any additional properties. Click [image] to save the changes.

To show or hide methods on the diagram element, click [image] on the title bar.

Note: 	The new Method definition is displayed under the Oracle Object Type Method node of the Navigator.


Creating object tables

Related Topics

Object tables must have a unique name and must be based on an Oracle object type.  About

Note:	You can also create relational tables.  How

To create an object table:

1.	Click the Server Model tab on the Navigator.

2.	From the Navigator, select the Object Table Definitions node.

3.	Click [image].

A Property Palette or Property dialog box box is displayed.  About

4.	To record the object table in the repository, do one of the following:

•	If a Property dialog box box is displayed, follow the instructions on the dialog box.

•	If a Property Palette is displayed, enter the table name and optionally use the Object Type property to choose the Oracle object type on which the table is to be based. Then click [image] to record the definition in the repository.

Note:	If you attempt to create an object table using a Property Palette and you do not specify an Oracle object type, the table is created as a relational table.

If required, use the Navigator to define database triggers, check constraints and synonyms for the object table.


Creating object views

Related Topics

Object views must have a unique name and must be based on an Oracle object type.  About

If you want to build an object view that is based on an existing relational table or view, use the Oracle Object Type and Object View utilities.

Note:	You can also create relational views.  How

To create an object view:

1.	Click the Server Model tab on the Navigator.

2.	From the Navigator, select the Object Views node.

3.	Click [image].

A Property Palette or Property dialog box box is displayed. The Property dialog box provides an easy to use interface for defining the SELECT statement from which the view is defined. About

4.	To record the object view in the repository, do one of the following:

•	If a Property dialog box box is displayed, follow the instructions on the dialog box.

•	If a Property Palette is displayed, enter the view name and optionally use the Object Type property to choose the Oracle object type on which the view is to be based. Then click [image] to record the definition in the repository.

Note:	If you attempt to create an object view using a Property Palette and you do not specify an Oracle object type, the view is created as a relational view.

If required, use the Navigator to define database triggers and synonyms for the object view.


Embedding an Oracle object type

Related Topics

You can embed an Oracle object type within a relational table, relational view or another Oracle object type. For example, you may want to embed a customer's address as a type within a CUSTOMER table. Typically, embedded objects are those which are not intended to be referenced by other objects.

Note: 	If the Oracle object type is likely to be used by other objects, it can be referenced rather than embedded.  How

To embed an Oracle object type:

1.	Open a Server Model Diagram.  How

2.	If the Oracle object type that is to be embedded does not already exist, create it.  How

Note:	The object that is to be embedded and the object within which it is to be embedded must both be displayed on the diagram.

3.	Click [image].

4.	Click on the relational table, relational view or Oracle object type within which the Oracle object type is to be embedded.

5.	Click on the object type that is to be embedded.

An object column/attribute is automatically created in the 'embedding' object.


Embedding collections of Oracle object types

Related Topics

You can embed a collection of Oracle object types (i.e. nested tables and VARRAYs) within a relational table, relational view or another Oracle object type. For example, you can embed order lines within the context of an ORDERS table. The order lines may be stored as a nested table (if the maximum number of order lines is unknown) or a VARRAY (if there is a maximum number of lines per order).

Note:	You can also reference collections of Oracle object types.  How

To create and embed a collection of types:

1.	Open a Server Model Diagram.  How

2.	If the Oracle object type on which the nested table or VARRAY is to be based does not already exist, create it.  How

Note:	The object that is to be embedded and the object within which it is to be embedded must both be displayed on the diagram.

3.	Click [image].

4.	Click on the relational table, relational view or Oracle object type within which the collection of Oracle object types is to be embedded.

5.	Click on the Oracle object type on which the nested table or VARRAY is to be based.

The Select Collection Type dialog box is displayed. You can choose an existing collection type (i.e. nested table or VARRAY) or create a new one.

An object column/attribute based on the selected collection type is automatically created in the 'embedding' object. To edit the collection type definition, double-click the embedded collection link.

Note:	You can also create and maintain collection type definitions using the Oracle Collection Type node on the Navigator (Server Model tab).


Referencing an Oracle object type

Related Topics

You can reference an Oracle object type from a relational table, relational view or another Oracle object type. For example, you may want to reference a customer's details for an order. If an object is likely to be used by other objects it should be referenced rather than embedded.

Note:	You can also embed an Oracle object type. How

To reference an Oracle object type:

1.	Open a Server Model Diagram.  How

2.	If the Oracle object type that is to be referenced does not already exist, create it.  How

Note:	The object that is to be referenced and the relational table or relational view from which the reference originates must both be displayed on the diagram.

3.	Click [image].

4.	Click on the relational table or relational view from which the Oracle object type is to be referenced.

5.	Click on the Oracle object type that is to be referenced.

An object column/attribute is automatically created in the 'referencing' object.


Referencing collections of Oracle object types

Related Topics

You can reference a collection of Oracle object types (i.e. nested tables and VARRAYs) from a relational table, relational view and from another Oracle object type. For example, you can reference order lines for an ORDERS table. The order lines may be stored as a nested table or a VARRAY (if there is a maximum number of lines per order). If an object is likely to be used by other objects it should be referenced rather than embedded.

Note:	You can also embed collections of Oracle object types.  How

To create and embed a collection of references:

1.	Open a Server Model Diagram.  How

2.	If the Oracle object type on which the nested table or VARRAY is to be based does not already exist, create it.  How

Note:	The object that is to be referenced and the relational table or relational view from which the reference originates must both be displayed on the diagram.

3.	Click

4.	Click on the relational table, relational view or Oracle object type from which the collection of Oracle object types is to be referenced.

5.	Click on the Oracle object type on which the nested table or VARRAY is to based.

The Select Collection Type dialog box is displayed. You can choose an existing collection type (i.e. nested table or VARRAY) or create a new one (set the REF? property to Yes to indicate that this is a collection of REFs).

An object column/attribute based on the selected collection type is automatically created in the 'referencing' object. To edit the collection type definition, double-click the REF collection link.

Note:	You can also create and maintain collection type definitions using the Oracle Collection Type node on the Navigator (Server Model tab).


Including repository elements on a Server Model Diagram

Related Topics

Diagrams can be based on data that is already defined in the repository. For example, if you have used design capture to create table definitions in the repository, you can display this data graphically on a Server Model Diagram to represent a first-cut database design.

When you include repository elements on a Server Model Diagram, you can also include associations, e.g., foreign keys. Elements can be included on an empty diagram or on a diagram that is already populated. You can choose how the elements are laid out on the diagram surface by selecting one of the autolayout options.

To include elements from the repository on a Server Model Diagram:

1.	Click on a Server Model Diagram to ensure that it is the active window.

2.	Choose Edit→Include.

3.	(Optional) Filter elements from the dialog box by entering a text string in the filter field at the top of the dialog box.

4.	(Optional) Change the container from which you want to include additional elements and choose whether you want to see all elements for that container.

5.	Select one or more repository elements and missing associations from the Selection box.

You can include entire groups of elements, such as all tables and all missing associations, by selecting the heading nodes. Similarly, you can include all elements, by selecting the Include Objects node.

6.	Choose the required autolayout option:

•	Whole Diagram - The elements are laid out on the whole diagram surface.

•	New Area - Elements are laid out within an area that you define by dragging the mouse on the diagram. The area that you define must be large enough to contain all of the elements to be included. If the area is too small, you are prompted to define a larger area.

•	Existing Area - Elements are placed within a predefined area on the diagram. If there are too many elements to fit into the predefined area, you are prompted to define a larger area.

7.	(Optional) Include associations on the diagram by selecting the Also Include Associations box.

Note:	If you have selected the New Area autolayout option, the cursor changes to a cross-hair, ready for you to drag open an area into which the elements are to be placed. If the autolayout area is too small, you are prompted to try again.


Editing the properties of an element on a Server Model Diagram

Related Topics

When you edit a database design, you can use the Navigator or a Server Model Diagram. Although you can  perform a wider range of tasks from the Navigator, Server Model Diagrams provide you with a graphical interface that is tailored for working with database design elements.

To modify a repository element from a Server Model Diagram:

1.	Open a Server Model Diagram.  How

2.	Double-click on the diagram element whose properties you want to edit.

A Property Palette or Property dialog box is displayed.  About

3.	Do one of the following:

•	If a Property dialog box is displayed, follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a Property Palette is displayed, change the required property values. Click [image] to save the changes.


Deleting elements from Server Model Diagrams

Related Topics

Each element on a Server Model Diagram represents a repository element. Therefore, if you delete an element from a diagram the associated element is also deleted. Depending on the underlying constraints in the repository, deleting an element may cause dependent elements to also be deleted. For example, deleting a table joined to another table deletes the table and its associated foreign key constraint from the diagram.

When you delete a repository element, it is not immediately removed from the repository. Instead, it is removed from the workarea and placed in a storage area called the wastebasket, similar to the Recycle Bin in Windows.

Note:	If you want to remove an element from a diagram, but not from the workarea, choose Edit→Cut.

To delete an element from a Server Model Diagram:

1.	Select the element that you want to delete from the Server Model Diagram.

2.	Choose Edit→Delete From Repository or press the CTRL key and the Delete key.


Tracking associations on Server Model Diagrams

Related Topics

Association tracking provides you with a way of seeing which columns are associated with a selected diagram element, e.g. a trigger or an index.

If a trigger, index, primary key, foreign key, unique key or cluster column is selected on a Server Model Diagram, and you are using association tracking, its associated columns are highlighted in a different color.

Note:	If columns have been hidden from a Server Model Diagram, any associations with those columns cannot be seen.

To track associations on Server Model Diagrams:

1.	Open a Server Model Diagram.  How

2.	Set the diagram to display secondary details.  How

3.	Choose View→Track Associations.

4.	Click on a secondary element, e.g. a primary key, to see the appropriate columns highlighted on the diagram.


Showing or hiding text for foreign key connectors on Server Model Diagrams

Related Topics

Foreign key constraints that exist between repository elements are represented by foreign key connectors on Server Model Diagrams. The names of the foreign key constraints can optionally be displayed next to the connectors.

To show/hide text for foreign key connectors on Server Model Diagrams:

1.	Open a Server Model Diagram.  How

2.	Choose Options→Show/Hide.

3.	From the Associations group, set the Text box, i.e. check the box to display foreign key names or uncheck the box to remove foreign key names.

4.	(Optional)  Click Save to keep the setting for future invocations of the tool.


Showing or hiding Server Model Diagram information

Related Topics

You can optionally display a diagram legend and annotations on Server Model Diagrams.

To show/hide Server Model Diagram information:

1.	Open a Server Model Diagram.  How

2.	Choose Options→Show/Hide.

3.	From the Diagram group, do the following:

•	Set the Legend option, i.e. check the box to display the legend or uncheck the box to hide the legend.

•	Set the Annotation option, i.e. check the box to display annotations or uncheck the box to hide annotations.

4.	(Optional)  Click Save to keep the setting for future invocations of the tool.


Showing or hiding column information on Server Model Diagrams

Related Topics

Each diagram element on a Server Model Diagram can be set to show or hide information about its associated columns/attributes.

To show/hide column/attribute information on a Server Model Diagram:

1.	Open a Server Model Diagram.  How

2.	Choose Options→Show/Hide.

3.	Use the Display Columns/Attributes box to identify whether column/attribute details are to be shown on Server Model Diagrams.

If the box is unchecked, then all column/attribute information is removed from the diagram.

4.	If the Display Columns/Attributes box is checked, do the following:

•	Use the Display Columns group to specify the types of columns that are to be displayed, e.g. if the Mandatory box is checked all mandatory columns are displayed.

•	Use the Column Details group to specify which indicators are to be shown for the columns, e.g. if the Primary Key Indicator box is checked, the primary key indicator (#) is displayed next to all columns that are part of a primary key.

5.	(Optional)  Click Save to keep the setting for future invocation of the tool.


Viewing secondary element details on Server Model Diagrams

Related Topics

Primary diagram elements, e.g. relational tables, may have secondary elements, e.g. triggers or synonyms. These secondary elements can optionally be displayed for every element on a diagram or for specific elements.

To display secondary element details for all diagram elements:

1.	Open a Server Model Diagram.  How

2.	Choose View→Secondary Element Details.

3.	From the dialog box, specify the elements for which secondary element details are to be displayed, by selecting the required options.

Secondary details are shown for all elements that correspond to your selections.

To display secondary element details for a specific diagram element:

1.	Open a Server Model Diagram.  How

2.	Click on the appropriate title bar button to display secondary details for that element.

Button	Secondary element type
	Triggers
	Indexes
	Synonyms
	Primary key
	Unique keys
	Check constraints
	Foreign keys
	Oracle object type methods

Secondary details are shown only on the diagram elements for which you have clicked on these buttons.


Displaying connector text on Server Model Diagrams

Related Topics

The names of foreign key connectors and object type connectors can be displayed either horizontal to the connector or parallel to the connector.

To specify how connector text is to be displayed:

1.	Open a Server Model Diagram.  How

2.	Choose Options→Layout.

3.	From the Connector Text Alignment list box, choose the required text layout position.


Hints and tips for Server Model Diagrams

Related Topics

Creating and opening Server Model Diagrams

Creating server model diagram elements on Server Model Diagrams

Including existing elements on Server Model Diagrams

Tidying Server Model Diagrams

Drawing tips for Server Model Diagrams

Creating and opening Server Model Diagrams

•	Create a Server Model Diagram by dragging the required elements, e.g. tables, from the Navigator onto the work surface.

Creating server model diagram elements on Server Model Diagrams

•	When creating Sever Model Diagram elements, draw a diagram element, e.g., a table, larger than the default size, by dragging an area to the exact size and position you want for the element, instead of simply clicking on the diagram surface.

•	To create secondary elements, i.e. primary keys and foreign keys, click the right mouse button over the appropriate title bar button on the diagram element. When using these buttons you can create customized elements rather than default ones. For example, using this option to create a foreign key allows you to specify Delete and Update rules as the foreign key is being created.

•	To add a column (that has already been defined for a table) to the table's primary key, do the following

i)	Show the primary key in the secondary usage section of the diagram element. How

ii)	Drag the column from the column/attribute section, onto the primary key in the secondary usage section. A primary indicator (#) is displayed next to the column to show that it is now part of the primary key.

Including existing elements on Server Model Diagrams

•	When creating a complex diagram using existing data, include only a few elements at a time. You can then position elements on the diagram in logical groups, and add to it gradually.

•	When including (Edit→Include) several elements at a time, suppress the display of foreign keys in the Include dialog box. You can then position the elements on the diagram before including foreign keys.

•	You can include existing repository objects on a diagram, by dragging them from the Navigator, other Server Model Diagrams, the Repository Object Navigator or the Matrix Diagrammer.

Tidying Server Model Diagrams

•	Minimize the amount of detail displayed on the diagram, by suppressing the display of column names, primary key indicators and foreign key names etc. To do this, select Options→Show/Hide and from the dialog box deselect the required options.

•	To tidy up a cluttered diagram, choose Edit→Select, click on the Foreign Keys node and close the dialog box. Select Edit→Cut to remove the foreign keys from the diagram. Reposition diagram elements to the required layout. Select Edit→Include and check the Also include Associations to include the foreign keys.

•	To quickly display the properties of an element, select the element and press the ENTER key on the numeric keypad.

•	Display the grid so that you can draw items to a specific size. You can also change the size of the grid cells to the required height and width by choosing Options→Layout.

•	Change the order in which columns/attributes are displayed on Server Model Diagram elements by dragging and dropping them.

Note:	If a diagram element does not show all of its columns/attributes, e.g. you have specified that only mandatory columns should be displayed, you cannot use drag and drop to reorder the displayed columns/attributes.

•	After moving a diagram element, you may also need to reposition the foreign key connectors. To do this, select all of the foreign keys connected to the diagram element (by holding down the CTRL key and clicking on the connectors). Then click [image] to autolayout the selected connectors.

•	Prevent connectors from crossing each other by creating a dog-leg connector. When creating a connector, click on the diagram surface, where you want the connector line to bend, before clicking on the referenced element.

•	You can bend, straighten and change the shape of connectors on Server Model Diagrams.  How


Drawing tips for Server Model Diagrams

Related Topics

To bend an existing connector around other items on a Server Model Diagram:

1.	Open a Server Model Diagram.  How

2.	Select the connector that you want to redraw.

3.	Hold down the SHIFT key and, while clicking on the connector, drag the connector in the direction in which you want to create the dog-leg.
The cursor changes to a four-headed arrow.

4.	When the connector is at the position you want, release the mouse button.

To straighten a dog-leg on a Server Model Diagram:

1.	Open a Server Model Diagram.  How

2.	Select the connector to display the grab bars.

3.	Hold down the SHIFT key and click once on the grab bar at the angled joint.

Tip:	You can reposition the connector by selecting the connector and dragging the grab bars along the edge of the element.

Changing the shapes of recursive connectors

If a recursive connector appears angled on the diagram, you can change its shape to a curved semi circle by holding down the SHIFT key and clicking on the grab bars.

Expanding or shrinking recursive connectors

To increase the size of a recursive connector, select the connector and drag one of the grab bars until the connector is the size you require.

Repositioning recursive connectors

To move a recursive connector, select and drag the connector to the corner of the element. The connector automatically snaps to the corner of the element as shown below.


About arcs

Related Topics

Arcs are used to enforce mutual exclusion between foreign keys.

Arcs can be mandatory or optional.  A mandatory arc enforces that there is one and only one valid foreign key.  An optional arc enforces that there is no more than one valid foreign key.

An arc is represented on a Server Model Diagram by a curved line which extends across each foreign key connector that is part of the exclusive relationship. A small dot at the point of intersection where the arc crosses the connector indicates that the connector is included in the arc.

A connector can cross an arc without belonging to that arc. In such cases there is no intersection dot at the base of the connector.

The rules for defining an arc are as follows:

•	An arc must contain at least two foreign keys.

•	All foreign keys included in the arc must be based on the same table; i.e. the arc must fall across a single table.

•	A foreign key can belong to only one arc.

•	All foreign keys in the arc must be optional.

In the following illustration, the columns CO_COMPANY_IDENTIFIER and CU_CUSTOMER_NUMBER are foreign keys to tables COMPANY and CUSTOMER.  They are defined in an arc to be mutually exclusive.

A dash (-) is used to denote a null value.

For each row in the MEMBERSHIPS table, one of the following conditions must apply:

•	a value must be specified for CO_COMPANY_IDENTIFIER, and CU_CUSTOMER_NUMBER must be null

•	a value must be specified for CU_CUSTOMER_NUMBER and CO_COMPANY_IDENTIFIER must be null

There is no upper limit to the number of foreign keys that can be included in an arc.

Arcs containing foreign keys that share common columns are not supported.


Server Model Diagram elements and notation

Related Topics

The conventions used to model a database schema using Server Model Diagrams are shown below.

The container in which the diagram exists is displayed on the diagram title bar. For information about the elements that can be shown on a Server Model Diagram see:

Tables	Columns	Triggers	Oracle object types
Views	Primary Keys	Check Constraints	Oracle object type attributes
Materialized views	Foreign Keys	Arcs	Object connectors
Clusters	Unique Keys
Each diagram element displays a summary of the properties of the element. The amount of detail shown can be changed to your preferred layout using the options available from the Options menu. An ellipsis (...) at the bottom of an element indicates that there is insufficient space on the element to display all properties of the element.

Title bar diagram element section

This identifies the name and type of the repository element that is represented by the diagram element. For example, in the picture above, the button shows a table icon and the name of the table.

The title bar section also contains buttons that identify which secondary elements have been defined for the element. These buttons are shown below:

Button	Secondary element type
	Triggers
	Indexes
	Synonyms
	Primary key
	Unique keys
	Check constraints
	Foreign keys
	Oracle object type methods

Note:	If a button is dimmed, no secondary elements of that type exist for the primary element.

The title bar buttons can be used to display or hide secondary element details.  How

Title bar buttons can also be used to create secondary elements, by clicking the right mouse button over the appropriate button.

Column/attribute details diagram element section

This shows the columns/attributes that are defined for the element, e.g. the columns for a table. You can specify which columns/attributes are shown in this section.  How

Secondary element section

This shows the secondary elements that are defined for the element, e.g. the indexes that are defined for a table. You can show and hide secondary elements.  How


Server Model Diagrams - Object connectors

Related Topics

Object connectors are used to graphically represent embedded and referenced Oracle object types, VARRAYs and nested tables on Server Model Diagrams. The notation that is used to represent these connectors is described below.

Embedded connectors

An embedded connector illustrates the association between an Oracle object type and the database object within which it is embedded. Embedded connectors have a black diamond at one end. This end of the connector is attached to the 'embedding' object. The other end of the connector identifies whether the embedded object is a single Oracle object type, or a collection of Oracle object types (i.e. a VARRAY or a nested table).

The asterisk indicates that there is no limit to the number of objects that can be stored in an embedded nested table. For embedded VARRAYs, the maximum number of objects that can be stored in the VARRAY is displayed.

The origin of an embedded connector can be a relational table, a relational view or an Oracle object type. However, the destination can only be an Oracle object type.

REF connectors

A REF connector (or REF link) illustrates the association between an Oracle object type and the database object from which it is referenced. A REF connector has a white diamond at one end. This end of the connector is attached to the 'referencing' object. The other end of the connector identifies whether the object being referenced is a single Oracle object type, or a collection of Oracle object types (i.e. a VARRAY or a nested table).

The asterisk indicates that there is no limit to the number of object references that can be stored in the embedding database object. For referenced VARRAYs, the maximum number of object references that can be stored in the VARRAY is displayed.

The origin of a REF connector can be a relational table, a relational view or an Oracle object type. However, the destination can only be an Oracle object type.


Comment topic:

Use the following bookmarks:

de_main


DE Navigator Window specific menu options and palette buttons


Main toolbar - New Component button
   New Component (Main Toolbar)

Related Topics

Creates a new component of the same type as the active component. For example, if the Navigator is active a new Navigator window is created.

Note:	If you use this option to create a new Server Model Diagram based on elements from multiple containers, you are prompted to choose the container in which the diagram is to be created.

This button is available only if the active window is a Navigator or a diagram.


File - New - Server Model Diagram
   New Server Model Diagram (File Menu)

Related Topics

Creates a new untitled Server Model Diagram in a specified container.

A new diagram is untitled when first created; it has no name assigned to it other than "Untitled". Each time a new diagram is created during the current session a number, incremented by 1, is appended to the word "Untitled".

Dialog box options

Container list

Lists the containers visible to the workarea. The container you choose determines both of the following:

•	The container for actions that you perform on the diagram, e.g. creating new elements.

•	The container in which the diagram will be saved.

Note:	You can change the container for which diagram actions are performed using the Container List on the main toolbar.  About


File - New - Navigator
   New Navigator (File Menu)

Related Topics

Opens a new Navigator for the same workarea as the current Navigator.

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


Main toolbar - Open Diagram Component
   Open Diagram Component (Main Toolbar)

Related Topics

Does one of the following:

•	Opens a previously saved diagram of the same type as the active diagram. For example, if a Server Model Diagram is active the Open Diagram dialog box is displayed for you to choose an existing Server Model Diagram.

•	Opens a previously saved diagram of the same type as a diagram selected on the Navigator. For example, if a Server Model Diagram is selected from the Server Model Diagrams tab, the Open Diagram dialog box is displayed for you to choose an existing Server Model Diagram.

•	Opens a new untitled diagram based on the selection in the Navigator. For example, if TABLEA is selected in the Navigator a new untitled Server Model diagram, based on TABLEA, is created.


File - Open - Diagram
   Open Diagram (File Menu)

Related Topics

Opens a previously saved diagram. If the diagram you select from the dialog box 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.

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.


File - Save Uncommitted Data
   Save Uncommitted Data (File Menu)

Saves any outstanding changes to the repository.

By default, changes that you make in the Navigator (such as, creating and deleting elements) are immediately committed to the database. However, any changes that are made using Property Palettes or diagrams are not made to the repository until you change the focus (by making another window active) or perform a save operation, e.g., clicking Finish on a dialog box.

Note:	If you attempt to close any tool that contains uncommitted changes, you will be asked if you want to keep the changes.


File - Revert Uncommitted Data
   Revert Uncommitted Data (File Menu)

Related Topics

Cancels any proposed changes. For example, if you have changed several of an object's properties, but have not saved the changes, selecting this option returns the properties to their original values. You can also use this menu option when reviewing changes to preferences in the Generator Preferences Palette, reviewing changes proposed by the generator products and when deciding whether to accept the results of a design capture.


Text search facility (Main toolbar)

Related Topics

The text search facility allows you to find a text string in the active window. This facility is comprised of:

•	Search list box

This box allows you to enter a text string for which you want to search

•	 Find Next button

Searches the active window for the next occurrence of the string entered in the Search list box. The search for the next occurrence of a text string starts from the selected item and continues to the last item.

•	 Find Previous button

Searches the active window for a previous occurrence of the string entered in the Search list box.


Container List (Main toolbar)

Related Topics

The Container List determines the container in which actions are performed when a design component, e.g., a Server Model Diagram is the active window. For example, if you use the Create Table button from the Server Model Diagram tool palette to create a new relational table, the table is created in the container displayed in the Container List.

The Container List is displayed on the main toolbar and can be changed only if a Server Model Diagram is active.

Note:	The Container List does not display a container name if a container cannot be ascertained or is not relevant for the currently active window. For example, if the workarea node is selected on the Navigator or if the Messages Window is active.


Edit - Create
   Create (Edit Menu)

Related Topics

Creates a new repository element under the selected node in the Navigator. To be able to create a new element, a user must have INSERT access and UPDATE access for the workarea and container.


Edit - Fast Create
Fast Create (Edit Menu)

Related Topics

Creates multiple repository elements of the same type as a selected Navigator branch.

Note:	This option is not available if a workarea or container is selected on the Navigator.

The repository elements are created with minimal, mandatory details, such as names. All other property values are defaulted. The details that you must enter depend on the type of repository element that you want to create. For example, to create table definitions you must enter only the name of each table, but to create database triggers you must specify a name and a purpose for each trigger.

Dialog box options

The list box shows columns for each mandatory property that you must enter.

Note:	For each repository element that is to be created, you must enter a value for every property shown on the dialog box.


Edit - Delete from Repository
   Delete from Repository (Edit Menu)

Related Topics

Deletes one or more selected elements from the repository. Depending on the underlying constraints in the repository, deleting an element may cause associated elements to be deleted. Primary access controlled elements (PACs), e.g. table definitions, are placed in a wastebasket from which they can be retrieved.

Note:	To remove an element from a diagram, but not the workarea, use Edit→Cut.

Repository elements that are associated with other repository elements cannot be deleted from this dialog box. An error message is displayed, informing you of where the element is referenced. To delete repository elements and their references, use Utilities→Force Delete.

Dialog box options

List box

Lists the names and types of the elements selected for deletion. The list box identifies the name and type of each element.

Delete

Deletes all of the listed elements. Any elements that are displayed in the list box but which are not to be deleted, can be removed using the Remove From List button.

Remove From List

Removes from the list, elements that are not to be deleted.


Edit - Select
Select (Edit Menu)

Related Topics

Selects one or more specified elements on the active diagram.

Dialog box options

Filter control

Allows you to filter the repository elements that are displayed in the list box. For example to list all elements containing the letters "EN", type %EN%. Use the underscore character (_) to represent any single character.

List box

Lists the repository elements that can be selected on the diagram, e.g. table definitions on Server Model diagrams.

Identify the elements that are to be selected on the diagram, by selecting one or more entries from this list.


Edit - Navigate To
Navigate To (Edit Menu)

Related Topics

Searches for a specified element on the active diagram and redisplays the diagram to show the element and its surrounding elements in the center of the window.

Dialog box options

Filter control

Allows you to filter the repository elements that are displayed in the list box. For example to list all elements containing the letters "EN", type %EN%. Use the underscore character (_) to represent any single character.

List box

Lists the repository elements to which you can navigate on the diagram.

And Select

When checked, specifies that the element to which you want to navigate is to be selected on the diagram.


Edit - Properties
   Properties (Edit Menu)

Related Topics

Displays the properties of the selected repository element in either a Properties Palette or a Property Dialog box.

Use the Options menu to specify whether you want Properties Palettes or Property Dialog boxes to be displayed by default.


Edit - Logic
    Logic (Edit Menu)

Related Topics

Enables you to enter logic code against the selected repository element, by opening the Logic Editor. This option is available only for repository elements for which logic code should be defined, e.g. PL/SQL definitions.


Edit - Generator Preferences
   Generator Preferences (Edit Menu)

Related Topics

Displays the Generator Preferences Palette for the selected repository element. This option is only available if a element, for which preferences can be set, is selected.


View - Database Administration Guide
Database Administration Design (View Menu)

Related Topics

Changes the view of the Navigator to show the DB Admin tab. If the contents of this tab are already shown, a checkmark is displayed next to this menu option.

Tip:	Instead of using this menu option you can click the DB Admin tab on the Navigator.


View - Database Distribution Guide
Database Distribution Design (View Menu)

Related Topics

Changes the view of the Navigator to show the Distribution tab. If the contents of this tab are already shown, a checkmark is displayed next to this menu option.

Tip: Instead of using this menu option you can click the Distribution tab on the Navigator.


View - Server Model Guide
Server Model Design (View Menu)

Related Topics

Changes the view of the Navigator to show the Server Model tab. If the contents of this tab are already shown, a checkmark is displayed next to this menu option.

Tip:	Instead of using this menu option you can click the Server Model tab on the Navigator.


View - Usages
Usages (View Menu)

Related Topics

Identifies the use of a repository element by other elements in the same workarea. For example, you may want to know which other repository elements make use of a specific table. The element for which you want to find usages must be selected in the Navigator or diagram.

You can quickly navigate to the source of a reference on the Navigator, by selecting a repository element from the list box and clicking Goto. The element from which the reference is made is highlighted on the Navigator. If the element is displayed on a different Navigator view, a new Navigator is displayed.

Dialog box options

List box

Lists the types of repository elements that can reference the chosen element. A [image] is displayed next to the types of repository elements that do reference the chosen object element.

Goto

Navigates to the element that references the element selected in the list box.


View - Message Window
Message Window (View Menu)

Related Topics

Show or hides the Message Window. The Message Window displays progress information and details of any errors or warnings that occur during generation and design capture.


Navigator - Clear Selected Filters
Clear Selected Filters (Navigator Menu)

Related Topics

Removes all filters that have been applied to repository elements, allowing those repository elements to be accessed from the Navigator.

Note:	You can see the currently set filters by choosing Options→Customize.


Navigator - Clear All Filters
Clear All Filters (Navigator Menu)

Related Topics

Removes filters that have been applied to all repository elements that can be shown in the Navigator.

Note:	You can see the currently set filters by choosing Options→Customize.


Navigator - Show/Hide Tabs
Show/Hide Tabs (Navigator Menu)

Related Topics

Shows or hides the tabs that identify which view is currently shown on the Navigator. Hiding the tabs provides slightly more space to show the content of the Navigator. If you do hide the tabs, use the options on the View menu to switch between the different views.


Navigator - Show Icons/Text on Tabs
Show Icons/Text on Tabs (Navigator Menu)

Related Topics

Determines whether icons or text are used to identify each of the different views on the Navigator.


Navigator - Vertical/Horizontal Tabs
Vertical/Horizontal Tabs (Navigator Menu)

Related Topics

Displays the Navigator tabs vertically or horizontally. If the tabs are currently displayed across the top of the Navigator, i.e. horizontally, then this menu option allows you to switch to the vertical display.


Navigator - Track Diagram Selection
   Track Diagram Selection (Navigator Menu)

Related Topics

Determines whether selections that are made on diagrams are reflected on the Navigator. For example, if you select a table on a Server Model Diagram, that table is also selected on the Navigator. If selections are being tracked a check mark is displayed next to this menu option.


Utilities - Create Object View - from Relational Table/View
Create Oracle Object Type (Utilities Menu)

Related Topics

Creates Oracle object types based on the structure of relational tables/views. Use this option to migrate a server model based on a relational table design to an Oracle8 object design.

The utility creates an Oracle object type from each table/view you select named <Relational Table/View>_T_V. It also creates an Oracle object type attribute from each non-foreign key column and a REF attribute from each foreign key.  For REF attributes to be correctly mapped to Oracle object types, both relational tables/views referenced by the foreign key must be selected (or have been selected previously).

Mapping information is also created to record the relationship between the relational table/columns and the Oracle object type/attributes. This mapping information is used when the Oracle object types are subsequently used to implement object views (use the menu option Utilities→Create Object View).

Note:	The utility may only be run once for a particular relational table/view.  Once a relational table/view has been used to create a new Oracle object type it is not displayed in this dialog, unless the corresponding Oracle object type is deleted.

Dialog box options

Don't Process

Lists relational tables and views to be excluded from the process. Use the directional arrows to include or exclude tables/views from the list.

Process

Lists relational tables and views from which Oracle object types will be created. Use the directional arrows to include or exclude tables/views from the list.

Directional arrows

Process Selection arrow
Moves selected relational tables/views to the Process list box.
Double-click on a relational table/view to move it to the opposite list.

Process All arrow
Moves all relational tables/views to the Process list box.

Don't Process All arrow
Moves all relational tables/views to the Don't Process list box.

Don't Process Selection arrow
Moves selected relational tables/views to the Don't Process list box.
Double-click on a relational table/view to move it to the opposite list.


Utilities - Create Object View - from Oracle Object Type
Create Object View from Oracle Object Type (Utilities Menu)

Related Topics

Creates object views based on Oracle object type definitions and their mappings to relational table/views.

The utility creates an object view  for each Oracle object type you select named <Relational Table/View>_T_V, together with the required SQL statements to construct the object rows from the underlying relational tables. It also creates OIDs from the underlying relational tables primary/unique key.

Note:	Only Oracle object types mapped to relational table/views are displayed in this dialog.

Dialog box options

Don't Process

Lists Oracle object types to be excluded from the process. Use the directional arrows to include or exclude Oracle object types from the list.

Process

Lists Oracle object types from which object views will be created. Use the directional arrows to include or exclude Oracle object types from the list.

Note:	 If an object view has already been created for a particular Oracle object type, the object view definition will be updated.

Directional arrows

Process Selection arrow
Moves selected Oracle object types to the Process list box.
Double-click on an Oracle object type to move it to the opposite list.

Process All arrow
Moves all Oracle object types to the Process list box.

Don't Process All arrow
Moves all Oracle object types to the Don't Process list box.

Don't Process Selection arrow
Moves selected Oracle object types to the Don't Process list box.
Double-click on an Oracle object type to move it to the opposite list.


Security - Remove Current User Locks
Remove Current User Locks (Utilities/Security Menu)

Related Topics

Removes all locks on preferences that have been set for a selected container by the current user. Locks that have been set by other users are not removed when this option is used.

This option is only available to the container owner (and users that have administrative privileges on the container) only.


Security - Unfreeze All
Unfreeze All (Utilities/Security Menu)

Related Topics

Unfreezes preferences for all of the repository elements in a selected container.

This option is only available to the container owner (and users that have administrative privileges on the container) only.


Security - Remove All User Locks
Remove All User Locks (Utilities/Security Menu)

Related Topics

Removes all locks that have been set for preferences in a selected container.

This option is only available to the container owner (and users that have administrative privileges on the container) only.


Tools - Database Navigator
Database Navigator (Tools Menu)

Related Topics

Opens the Database Navigator which shows online database objects for a specified database and user.

Dialog box options

Oracle

Identifies that the Database Navigator will be invoked for an Oracle database.

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>

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

scott/scott@HQ8

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

Note:	A user name specified in the Owner field, overrides a user name entered in this field.

Password

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

Connect

The connect string required to access the database account. Example, using Net8: alias

Note, You must ensure that the database alias is specified in the TNSNAMES.ORA file in your Oracle home directory, usually C:\<oracle_home>\NET80\ADMIN.

Owner

This is an optional field allowing you to browse and capture database objects for a user other than the user specified in the Username field. You specify the user name in the format:

<username>

ODBC

Invokes the Database Navigator, based on an Oracle database, or another type of database, via an ODBC data source.

To use this option you must have installed an ODBC driver for the target database type and set up a data source to the required database. A specific driver is required for each type of database you want to access.

Note:	When you connect to an ODBC data source, you will prompted for logon information. This information will vary depending on the type of ODBC driver you are using.

Source

Specifies the name of a predefined data source. If the data source you require is not listed, cancel this dialog box then set up a data source to the database you want to access.

The data source will be available when you next run the Database Navigator.

Type

Displays the type and version of your target database. In most cases, the database type can be determined automatically when a successful connection is made.

Note:	Selection of the blank database type indicates that Server Generator will attempt to read the database type from the ODBC driver. If the database type is recognized then it will be used, otherwise a default type is used.


Tools - Server Model Guide
Server Model Guide (Tools Menu)

Related Topics

Invokes the Server Model Guide to lead you through the process of creating database objects that make up your database design.

Note:	You can also invoke the Server Model Guide directly from the Welcome Screen at startup.


Tools - Database Administration Guide
Database Administration Guide (Tools Menu)

Related Topics

Invokes the Database Administration Guide to lead you through the process of designing the physical implementation aspects of a database design.

Note:	You can also invoke the Database Administration Guide directly from the Welcome Screen at startup.


Options - Color/Font/Style
Color/Font/Style (Options Menu)

Related Topics

Applies display attributes, e.g. color, to one or more elements on the navigator, Property Palette, textpad or a diagram. The attributes that can be specified are determined by the type of element that is selected.

If the navigator, a Property Palette or the textpad is the active window, choosing this option displays the Options - Color/Font/Style for Navigator dialog box.

If a diagram is the active window, choosing this option displays the Options - Color/Font/Style for diagrams dialog box.


Options - Color/Font/Style for Navigator
Color/Font/Style for Navigator (Options Menu)

Related Topics

Applies display attributes, e.g. color, to one or more elements on the Navigator, Property Palette or textpad. The attributes that can be specified are determined by the type of element that is selected.

Dialog box options

Text Color

Identifies the text type for which the color is to be set. For example, if you want to set the color for error messages, choose Error from this list.

Note:	The current color setting for the selected text type is displayed in the Preview box to the right of this field.

Fonts

Identifies whether the font is to be set for the Navigator, Property Palette or textpad.

Note:	The current font setting for the selected window is displayed in the Preview box to the right of this field.

Color Palette >>

When clicked this button displays the color palette dialog box, from which you can choose the required color.

Font Dialog >>

When clicked this button displays the font dialog box, from which you can choose the required font.


Options - Color/Font/Style for diagrams
Color/Font/Style for diagrams (Options Menu)

Related Topics

Applies diagram display attributes, e.g. color, to one or more elements on a diagram. The attributes that can be specified are determined by the type of element that is selected on the diagram, or the type of element that is chosen from the Element Type dropdown list.

Dialog box options

Set Preferences For

Identifies whether diagram display attributes are to be set for selected elements, existing elements or new elements.

Selected Elements

Identifies that diagram display attributes are to be set for elements that are selected on the diagram only. If no elements are selected on the diagram then this option is not available.

Existing Elements

Identifies that diagram display attributes are to be set for existing elements only.

New Elements

Identifies that diagram display attributes are to be set for all elements that are created after the settings in this dialog box have been saved.

Element Type

Lists the types of diagram elements for which display attributes can be specified. This list is not available if you are specifying display attributes for selected elements.

Preview

Displays a preview of the type of element chosen from the Element Type dropdown list. A preview is not shown if more than one element is selected from the diagram.

Fill Color

Shows the color that identifies a diagram element, e.g. the color of a table on a Server Model Diagram. You can change the fill color by clicking on this field and choosing a new color from the color option palette (using the mouse or the arrow keys). This option is not available if the chosen element type is not represented graphically on the diagram. For example, columns are represented textually and therefore do not have a fill color.

Fill Color As Is

This option is available only if multiple elements are selected on the diagram. When checked, it identifies that the fill colors of the selected elements are those shown on the diagram. If you change the fill color, this box becomes unchecked, and the proposed color of the elements is identified by the Fill Color field . To reset the elements to use the color shown on the diagram, recheck the box.

Line Color

Not available for Server Model Diagrams

Shows the color of any lines associated with a diagram element. You can change the line color by clicking on this field and choosing a new color from the color option palette (using the mouse or the arrow keys). This option is not available if the chosen element type is not represented graphically on the diagram. For example, columns are represented textually and therefore do not have a line color.

Line Color As Is

Not available for Server Model Diagrams

This option is available only if multiple elements are selected on the diagram. When checked, it identifies that the line colors of the selected elements are those shown on the diagram. If you change the line color, this box becomes unchecked, and the proposed line color of the elements is identified by the Line Color field . To reset the elements to use the color shown on the diagram, recheck the box.

Line Width

Not available for Server Model Diagrams

Shows the width of any lines associated with a diagram element. You can change the line width by entering a number (between 1 and 19) or by clicking on the line width display and choosing a new width from the width option palette. This option is not available if the chosen element type is not represented graphically on the diagram, e.g., textual elements.

Line Width As Is

Not available for Server Model Diagrams

This option is available only if multiple elements are selected on the diagram. When checked, it identifies that the line widths of the selected elements are those shown on the diagram. If you change the line width, this box becomes unchecked, and the proposed line width of the elements is identified by the Line Width field . To reset the elements to use the width shown on the diagram, recheck the box.

Font

Identifies the font, style, color and size that are used for the text on a diagram element. To change any of these attributes click on the field and choose the required options from the Font dialog box.

Font As Is

This option is available only if multiple elements are selected on the diagram. When checked, it identifies that the fonts of the selected elements are those shown on the diagram. If you change the font, this box becomes unchecked, and the proposed font for the elements is identified by the Font field . To reset the elements to use the font shown on the diagram, recheck the box.

Secondary Font

This option is available only if the diagram element has secondary text. For example, the column names that are displayed on a table definition are regarded as secondary text.

Secondary Font As Is

This option is available only if multiple elements are selected on the diagram. When checked, it identifies that the secondary fonts of the selected elements are those shown on the diagram. If you change the secondary font, this box becomes unchecked, and the proposed secondary font for the elements is identified by the Secondary Font field . To reset the elements to use the secondary font shown on the diagram, recheck the box.


Options - Layout Server Model Diagram
Layout (Options Menu)

Related Topics

Defines your preferred Server Model Diagram layout settings.

Dialog box options

Autolayout

Minimum Table Width (cells)

Defines the minimum width in grid cells of all tables on the diagram.

Minimum Table Height (cells)

Defines the minimum height in grid cells of all tables on the diagram.

Connector Text Alignment

Specifies whether foreign key and object type connector names are displayed horizontal to, or parallel with, their corresponding connectors on the diagram.

Grid

Cell Size

The size of the grid cells.

Snap

Sets the snap-to-grid option on, which aligns elements to the grid lines on the diagram.

Display

Shows or hides the grid lines on the diagram. Grid lines appear as horizontal and vertical dotted lines on the drawing surface.

OK

Changes the display options for the duration of the current session.

Cancel

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

Restore

Removes all changes that you have made since the last Save and returns the last saved settings in their stead. These default values are stored in the Registry. Note that even if you saved the diagram with a set of preferences, these settings will be reset to the values held in the Registry.

Save

Saves the current display options to the Registry, so that future invocations of the tool will use these settings.


Options - Use Property Dialogs/Property Palettes
      Use Property Dialogs/Palette (Options Menu)

Related Topics

When you create and edit repository elements, e.g., table definitions, you have the choice of using Property Dialog boxes or Property Palettes. The dialogs and palettes are interfaces for entering information into the repository. You can switch between using dialog boxes and palettes at any time.

Note:	Property Dialog boxes are not available for all element types . If Property Dialog boxes are chosen and a dialog box is not available for the selected element type, a Property Palette is displayed.

Use Property Dialogs   [image]   When the tool is set to use Property Dialog boxes (the default), this button is displayed in the main toolbar. Property Dialog boxes group together associated elements. For example, when creating a table definition, you can also create columns for that table.

Use Property Palettes   [image]   When the tool is set to use Property Palettes, this button is displayed in the Main toolbar.


Options - Logic Editor
Logic Editor Options (Options Menu)

Related Topics

Defines your preferred Logic Editor display settings.

Allows you to change the layout and the look of code displayed in the Logic Editor Code Window, to suit the way that you work. Changes to the display options are applied to the current session and any subsequent sessions of the Logic Editor.

Dialog box options

The Logic Editor Options dialog box is organized into the following tabs:

Color/Font

Language/Tabs

Keyboard

Misc


Logic Editor Options - Color/Font tab
Logic Editor Options - Color/Font

Related Topics

Enables you to change colors and fonts displayed in the Logic Editor Code Window.

Color

Item

Lists the different categories of logic code for which you can change the display color in the Code Window.

Foreground

Shows the foreground color, e.g. the color of the code, in which the chosen item category is displayed, and allows you to change the color.

Background

Shows the background color, e.g. the color of the space surrounding the code, in which the chosen item category is displayed. Also allows you to change the color. This field is not displayed for some item categories, e.g. Left Margin.

Font

Displays an example of the font, font style and point size in which logic code is displayed in the Code Window, and allows you to change any of these characteristics.

Change

Displays the Font dialog box that allows you to change the font, font style and point size of logic code.

OK

Saves the changes you have made, overwriting any previous settings and closes the dialog box.

Cancel

Cancels changes you have made and closes the dialog box. Any changes that have been made prior to clicking the Apply button cannot be canceled.

Apply

Saves the changes you have made, overwriting any previous settings. The dialog box remains open, for you to make further changes to the display of the Logic Editor. Once you have clicked Apply you cannot undo your changes by clicking Cancel.


Logic Editor Options - Language/Tabs tab
Logic Editor Options - Language/Tabs

Related Topics

Enables you to change the indentation style and tab settings in the Logic Editor Code Window.

Auto Indentation Style

Sets the indentation level for sub-clauses embedded in logic code.

Increasing the indent creates a larger space between a keyword and any nested keywords. Decreasing the indent reduces the amount of space between a keyword and any nested keywords.

Valid values are in the range 0 to 30.

Off

Disables automatic indentation of code typed into the Code Window.

Follow Language Scoping

Determines the indentation of each line based on the logic code language structure.

Copy From Previous Line

Starts each new line at the same indentation level as the previous line of code.

Tabs

Sets the tabs settings in the Logic Editor Code Window.

Tab Size

Specifies the size of tabs using spaces as the unit of measure.

Convert tabs to spaces while typing

Specifies that tabs you enter while this box is checked are converted into spaces. Existing tabs are not converted to spaces.

Language

Identifies the language of the logic currently being edited. The Logic Editor uses this information to help recognize language specific characteristics, i.e., the characters used to specify comment lines. Typically you should not need to change the value shown in this field.

OK

Saves the changes you have made, overwriting any previous settings and closes the dialog box.

Cancel

Cancels changes you have made and closes the dialog box. Any changes that have been made prior to clicking the Apply button cannot be canceled.

Apply

Saves the changes you have made, overwriting any previous settings. The dialog box remains open, for you to make further changes to the display of the Logic Editor. Once you have clicked Apply you cannot undo your changes by clicking Cancel.


Logic Editor Options - Keyboard tab
Logic Editor Options - Keyboard

Related Topics

Enables you to view and specify key assignments to perform actions in the Logic Editor Code Window.

Command

Lists the commands that can be performed while using the Code Window. Selecting a command displays key assignments in the Key Assignments field and a short description in the Description field. Note, not all commands have default key assignments.

Key Assignments

Displays the key assignments for the selected command.

Assign

Assigns the key assignment that you have entered in the New Key Assignment field, to the selected command.

Remove

Removes the key assignment displayed in the Key Assignments field.

Reset

Resets all of the key assignments to their default settings. Any key assignments that you have specified are removed.

New Key Assignment

Allows you to enter a new key assignment for a command. The display panel below this field identifies whether a key assignment is already used for another command.

Description

Displays a short description of the selected command.

OK

Saves the changes you have made, overwriting any previous settings and closes the dialog box.

Cancel

Cancels changes you have made and closes the dialog box. Any changes that have been made prior to clicking the Apply button cannot be canceled.

Apply

Saves the changes you have made, overwriting any previous settings. The dialog box remains open, for you to make further changes to the display of the Logic Editor. Once you have clicked Apply you cannot undo your changes by clicking Cancel.


Logic Editor Options - Misc tab
Logic Editor Options - Misc

Related Topics

Enables you to change the indentation style and tab settings in the Logic Editor Code Window.

Smooth Scrolling

Identifies whether smooth scrolling is used.

Show Left Margin

Identifies whether a margin is used to inset all logic code from the left of the Code Window.

Show Line Tooltip # While Scrolling

Identifies whether a popup tooltip is displayed when you move the vertical scrollbar. The tooltip displays the line number of the first line displayed in the Code Window and is updated as you scroll up or down the window.

Allow Drag and Drop

Identifies whether you can drag selected code from one location to another within the Code Window.

Allow Column Selection

Identifies whether you can select one or more columns across multiple lines of code  without selecting entire all columns in those lines. If this box is checked, you can select vertical lines in the Logic Editor Code Window by positioning the cursor at the start of the column that you want to select, holding down the ALT key and dragging the mouse. For example, if you want to select a comment that spans several lines of code, without selecting the code, this box should be checked.

Color Syntax Highlighting

Identifies whether the colors specified on the Color/Font tab are shown throughout the logic code.

Show Horizontal Scrollbar

Displays or hides the Code Window horizontal scrollbar.

Show Vertical Scrollbar

Displays or hides the Code Window vertical scrollbar.

Allow Horizontal Splitting

Displays or hides a splitter bar on the Code Window horizontal scrollbar. You can drag the splitter bar to display two views on the same Code Window.

Allow Vertical Splitting

Displays or hides a splitter bar on the Code Window vertical scrollbar. You can drag the splitter bar to display two views on the same Code Window.

Maximum Undoable Actions

Identifies the number of actions that you can undo while using the Logic Editor. The number of actions that can be undone can be either unlimited or set to a specified limit.

OK

Saves the changes you have made, overwriting any previous settings and closes the dialog box.

Cancel

Cancels changes you have made and closes the dialog box. Any changes that have been made prior to clicking the Apply button cannot be canceled.

Apply

Saves the changes you have made, overwriting any previous settings. The dialog box remains open, for you to make further changes to the display of the Logic Editor. Once you have clicked Apply you cannot undo your changes by clicking Cancel.


Options - General Generator Options
General Generator Options (Options Menu)

Sets the general generator options. These options are used for both database generation and client application generation.

Dialog box options

Scope of Code Control Table

Defines the scope and name of the code control table that supplies unique identifiers for items based on columns that derive values from a code control sequence. The options are to create:

•	a single table for all containers called CG_CODE_CONTROLS
•	a different table for each container called <container_name>_CODE_CONTROLS
•	a different code controls table for each table that derives a value from a code control sequence called <table_name>_CC
Scope of Reference Code Table

Defines the scope and name of the reference code table that supplies LOVs and validation for items, parameters, and controls in generated forms, reports, Web PL/SQL and Visual Basic applications respectively:

The options are to create:

•	a single table for all containers called CG_REF_CODES
•	a different table for each container called <container_name>_REF_CODES
Tablespace for Reference Codes/Code Controls Tables (30 characters)

Use this option to specify the tablespace in which to create tables (and associated indexes) for help text, reference values and code controls.

If you do not set this option, you will be prompted to specify the tablespace in which to create the tables and indexes. If you do not then specify a tablespace, they will be created in the default tablespace for your Oracle user.

File Name Length Restriction

Specifies a maximum length for a repository module's Implementation Name (if set) or Short Name property. Use this option in environments that enforce a limit of less than 30 characters on the length of filenames. The Oracle Designer generators will not generate from modules where this restriction is exceeded. To enforce no restriction on the length of filenames, enter 0 in this field.

Increment used when generating Sequence within Parent

Specifies an increment for autogenerated sequence numbers unique within a parent.

Name of Dual Table

Specifies the name of the single-row DUAL table used by Form Generator. The default is SYS.DUAL.

Record Time on Change History Columns

Specifies whether to record the time as well as the date when a row is inserted and/or updated. If checked, the time is recorded in the appropriate row in the date created and/or date modified column. If unchecked, the time is not recorded.


Server Model Diagram  specific menu options and palette buttons


Edit - Include
Include (Edit Menu)

Related Topics

Includes selected repository elements on the diagram. The elements that are included are determined by the branches you select in the selection box. For example, to include all elements select the Include Objects node, to include missing associations only select the Missing Associations node.

You can filter the dialog box to show one or more element types, or use the Filter field to locate elements by name. You can optionally include associations, e.g., foreign keys, for the elements you include.

Elements included using this option are automatically laid-out on the diagram according to one of the Autolayout options.

Dialog box options

Filter control

Allows you to filter the repository elements that are displayed in the list box. For example to list all elements containing the letters "EN", type %EN%. Use the underscore character (_) to represent any single character.

Show Objects for Database (by container)

Identifies whether the List box shows all database object elements for the current container or only those in the container that can be implemented on a specified database. If all database object elements are to be shown in the Selection box, choose All Objects from this list.

You can change the container from which you want to choose repository elements by clicking the Container List button.

Selection box

Lists the repository elements, and missing associations, that can be included on the diagram. An association is considered missing only if both of the elements with which it is associated are already on the diagram and the association is not shown on the diagram.

Identify the elements that are to be selected on the diagram, by selecting one or more entries from this list.

Autolayout to

Whole Diagram

The diagram elements are laid out on the whole diagram drawing surface.

New Area

Diagram elements are laid out within an area that you define by dragging the mouse on the diagram. The area that you define must be large enough to contain all of the elements to be included. A warning is issued if the area is too small and prompts you to define a larger area.

Existing Area

Diagram elements are placed within a predefined area on the diagram. If there are too many elements to fit into the predefined area, you are prompted to define a larger area.

Also include Associations

Identifies whether associations are to be included and displayed on the diagram. An association is included only if it exists between two of the elements to be included, or if it exists between an element to be included and an element already on the diagram.


View - Secondary Element Details
Secondary Element Details (View Menu)

Related Topics

Shows or hides the secondary element details, e.g. triggers and primary keys of tables, for diagram elements on Server Model Diagrams.

Dialog box options

The dialog box lists the types of secondary elements that can be displayed on the diagram. The element types for which check marks are displayed are shown on the diagram.


View - Track Associations
Track Associations (View Menu)

Related Topics

For Server Model Diagrams, identifies where columns are used by secondary elements such as triggers, indexes, keys and cluster columns. For example, if an index is selected on a Server Model Diagram, the index columns are highlighted on the diagram.

Note:	The Server Model Diagram must be set to view secondary element details before you can select elements such as triggers and indexes.

If a check mark is displayed next to this option, association tracking is on and any subsequent selections, will cause associated columns to be highlighted.


Utilities - Create Arc
Create Arc (Utilities Menu)

Related Topics

Creates an arc to signify that the currently selected foreign key connectors on a Server Model Diagram are mutually exclusive. An arc must contain at least two foreign key connectors. All the foreign key connectors must be from the same element, and be of the same optionality.

Foreign key connectors can be added to or removed from existing arcs using Utilities→ Add to Arc and Utilities→Remove from Arc utilities.


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

Related Topics

Adds the selected foreign key connector to the currently selected arc. An arc must contain at least two foreign key connectors. All the foreign key connectors must be from the same element, and of the same optionality.

Foreign key connectors 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 foreign key connector from the currently selected arc. If you remove a connector from an arc leaving only one foreign key connector in the arc, the arc is displayed across the remaining connector.

Foreign key connectors can be added to existing arcs using Utilities→Add to Arc.


Server Diagram tool palette - Create Relational Table
   Create Relational Table

Related Topics

Creates a new relational table definition in the repository and a representation of the table definition on the diagram.  About

When this button is selected, the cursor shape changes to the table symbol. Clicking on the drawing surface inserts a table on the diagram at the default size. Alternatively, you can position the cursor on the drawing surface at the required position and drag open the table to the size you require. Table details are recorded on a Property Palette or a Property Dialog.

Note:	The Container List shown on the main toolbar, determines the container in which the element will be created.


Server Diagram tool palette - Create Relational View
   Create Relational View

Related Topics

Creates a new relational view definition in the repository and a representation of the view definition on the diagram.  About

When this button is selected, the cursor shape changes to the view symbol. Clicking on the drawing surface inserts a view on the diagram at the default size. Alternatively, you can position the cursor on the drawing surface at the required position and drag open the view to the size you require. View details are recorded on a Property Palette or a Property Dialog.

Note:	The Container List shown on the main toolbar, determines the container in which the element will be created.


Server Diagram tool palette - Create Materialized View
   Create Materialized View

Related Topics

Creates a new materialized view definition in the repository and a representation of the materialized view definition on the diagram.  About

When this button is selected, the cursor shape changes to the materialized view symbol. Clicking on the drawing surface inserts a materialized view on the diagram at the default size. Alternatively, you can position the cursor on the drawing surface at the required position and drag open the materialized view to the size you require. Materialized view details are recorded on a Property Palette or a Property Dialog.

Note:	The Container List shown on the main toolbar, determines the container in which the element will be created.


Server Diagram tool palette - Create Cluster
   Create Cluster

Related Topics

Creates a new cluster definition in the repository and a representation of the cluster definition on the diagram.  About

When this button is selected, the cursor shape changes to the cluster symbol. Clicking on the drawing surface inserts a cluster on the diagram at the default size. Alternatively, you can position the cursor on the drawing surface at the required position and drag open the cluster to the size you require. Cluster details are recorded on a Property Palette or a Property Dialog.

Note:	The Container List shown on the main toolbar, determines the container in which the element will be created.


Server Diagram tool palette - Create Columns
   Create Columns

Related Topics

Creates column definitions for a repository element, e.g. a relational table, and a representation of the column definitions on the diagram.  About

This button is available only when the repository element for which the columns are to be created, is selected on the diagram. When this button is selected, the Fast Create dialog box is displayed for you to enter the required columns. The columns are created in the same container as the element for which they are being created.


Server Diagram tool palette - Create Mandatory Foreign Key
   Create Mandatory Foreign Key

Related Topics

Creates a foreign key definition in the repository, that represents a mandatory many-to-one constraint between two elements. The foreign key is represented on the diagram by a solid-line crowsfoot connector.  About

When this button is selected, the cursor shape changes to a crowsfoot. The foreign key definition is created on the element you first click on; i.e. the element at the many end of the relationship. The cursor is anchored at the many end, enabling you to drag the connector to the referenced element.


Server Diagram tool palette - Create Optional Foreign Key
   Create Optional Foreign Key

Related Topics

Creates a foreign key definition in the repository, that represents an optional many-to-one constraint between two elements. The foreign key is represented on the diagram by a broken-line crowsfoot connector.  About

When this button is selected, the cursor shape changes to a crowsfoot. The foreign key definition is created on the element you first click on; i.e. the element at the many end of the relationship. The cursor is anchored at the many end, enabling you to drag the connector to the referenced element.


Server Diagram tool palette - Create Primary Key
   Create Primary Key

Related Topics

Creates a primary key definition in the repository. A primary key is represented on the diagram by the primary key indicator (#).  About

Because a table can have only one primary key, this option is not available if you attempt to create a primary key on a table that already has one. The primary key is created in the same container as the element for which it is being created.


Server Diagram tool palette - Create Oracle Object Type
   Create Oracle Object Type

Related Topics

Creates a new Oracle object type definition in the repository and a representation of the Oracle object type definition on the diagram.  About

When this button is selected, the cursor shape changes to the Oracle object type symbol. Clicking on the drawing surface inserts an object type on the diagram at the default size. Alternatively, you can position the cursor on the drawing surface at the required position and drag open the object type to the size you require. Oracle object type details are recorded on a Property Palette or a Property Dialog.

Note:	The Container List shown on the main toolbar, determines the container in which the element will be created.


Server Diagram tool palette - Create Oracle Object Attribute
   Create Attribute

Related Topics

Creates definitions of Oracle object type attributes in the repository and a representation of the attribute definitions on the diagram.  About

This button is available only when the Oracle object type for which the attributes are to be created, is selected on the diagram. When this button is selected, the Fast Create dialog box is displayed for you to enter the required attributes. The attributes are created in the same container as the element for which they are being created.


Server Diagram tool palette - Create Embedded Link
   Create Embedded Link

Related Topics

Embeds a single object in a relational table, relational view or Oracle object type. The embedded object is identified on the diagram using an embedded link.

When this button is selected, the cursor shape changes to the embedded link symbol. Click first on the element in which you intend to embed an Oracle object type. The cursor is anchored, enabling you to drag the connector to the Oracle object type that is to be embedded. Then click on the Oracle object type that you want to embed.

In repository terms, this option creates a column/attribute definition and embeds within it with an Oracle object type definition, i.e., creates a single embedded object.


Server Diagram tool palette - Create REF Link
   Create REF Link

Related Topics

Creates a reference to a single object from a relational table, relational view or Oracle object type. The referenced object is identified on the diagram using a referenced link.

When this button is selected, the cursor shape changes to the referenced link symbol. Click first on the element from which the reference is to be created. The cursor is anchored, enabling you to drag the connector to the referenced element. Then click on the Oracle object type that you want to reference.

In repository terms, this option creates a column/attribute definition in the repository from which an Oracle object type is referenced, i.e., creates a REF to an object.


Server Diagram tool palette - Create Embedded Collection Link
   Create Embedded Collection Link

Related Topics

Embeds a collection of objects in a relational table, relational view or Oracle object type. The embedded objects are identified on the diagram using a collection of embedded objects link.

When this button is selected, the cursor shape changes to the collection of embedded objects link symbol. Click first on the element in which you intend to embed a collection of types. The cursor is anchored, enabling you to drag the connector to the collection of types that are to be embedded. Then click on the Oracle object type that you want to embed.


Server Diagram tool palette - Create Collection of REFs Link
   Create Collection of REFs Link

Related Topics

Creates a reference to a collection of objects from a relational table, relational view or Oracle object type. The referenced objects are identified on the diagram using a collection of references link.

When this button is selected, the cursor shape changes to the collection of references link symbol. Click first on the element from which the reference is to be created. The cursor is anchored, enabling you to drag the connector to the referenced element. Then click on the Oracle object type that you want to reference.


Server Model Diagram specific dialog boxes -This topic is for documentation purposes only-


Server Model Diagram - Show/Hide Options dialog box

Related Topics

Allows you to specify which information is to be shown for each of the database object elements that are displayed on a Server Model Diagram.

Dialog box options

Associations

Text

Identifies whether the names of foreign key connectors are displayed next to foreign key links on the diagram. When checked, the names are displayed.

Diagram

Legend

Identifies whether diagram details, such as, when the diagram was created, are displayed on the diagram. When checked the diagram legend is displayed in the top left corner of the diagram.

Annotation

Identifies whether annotations are to be displayed on the diagram. When checked, annotations are displayed on the diagram.

Nodes

Buttons

Identifies whether the additional information buttons are displayed on each diagram element. These buttons identify the secondary elements that exist for an element, they also allow you to quickly create secondary elements, e.g. indexes.

Columns/Attributes

Display Columns/Attributes

Identifies whether all columns are to be shown or hidden from the diagram. When checked all columns/attributes are shown on the diagram.

Attribute Details

Identifies whether the datatype indicator is displayed. When checked the datatype indicator is displayed for all attributes on the diagram.

Display Columns

Lists the types of columns that can be shown or hidden from the diagram. Options against which a check mark is displayed are shown on the diagram. You can use the All Columns option as a shortcut for checking all of the boxes in this list.

Column Details

Lists the types of column indicators that can be shown or hidden from the diagram. Options against which a check mark is displayed are shown on the diagram.

Container Display

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

None	Container names are not displayed 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 any owning containers, next to the element name. This option is useful if your designs contain nested containers.
OK

Changes the options for the duration of the current session.

Cancel

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

Restore

Removes all changes that you have made and returns the last saved settings in their stead. These default values are stored in the Registry. Note that even if you saved the diagram with a set of preferences, these settings will be reset to their default values.

Save

Saves the current display options to the Registry.


Generator Preferences Palette - specific menu options and palette buttons


Preference Palette - Save Preferences
   Save Preferences

Related Topics

Saves any changes that have been made to preference values.

If you attempt to close the Generator Preferences Palette before saving changes, you will be asked if you want to keep the changes.


Edit - Copy Preferences
   Copy Preferences (Edit Menu)

Related Topics

Copies the values of selected preferences to the Preferences Clipboard. You can see the contents of the Preferences Clipboard by choosing View→Copied Preferences.


Edit - Paste Preferences
   Paste Preferences (Edit Menu)

Related Topics

Pastes the values of copied preferences from the Preferences Clipboard. You can see the contents of the Preferences Clipboard by choosing Edit→View Copied Preferences.


Edit - View Copied Preferences
View Copied Preferences (Edit Menu)

Related Topics

Displays the contents of the Preferences Clipboard. You can place preference values in to the Preferences Clipboard using Edit→Copy Preferences.


Preferences - Create As Preference Set
Create As Preference Set (Preferences Menu)

Related Topics

Allows you to create a generator preference set based on the preference values that are set for the element shown in the Generator Preferences Palette.

Enter the name of the preference set that you want to create. A set is created with a copy of all the explicitly set preferences shown in the Generator Preferences Palette.

Note:	The name of the element from which the preference set's values will be derived is displayed below the Set Name field.

Newly created sets are placed under the Preference Sets node on the Navigator.

Only preferences whose values are explicitly set are saved to the new preference set.


View - Show Name/Description
      Show Name/Show Description (View Menu)

Related Topics

The Generator Preferences Palette identifies preferences by displaying their short names or descriptions. You can set the Generator Preferences Palette to use short names or descriptions using either the View menu or the Generator Preferences Palette toolbar.

Short Names   [image]   When the Generator Preferences Palette shows short names, preferences are identified using a six letter acronym. Pressing this button switches the palette to show descriptions.

Descriptions   [image]   When the Generator Preferences Palette shows descriptions, preferences are identified using a descriptive name. Pressing this button switches the palette to show short names.


View - Show/Hide Icons
   Show/Hide Icons (View Menu)

Related Topics

Shows or hides icons on the Generator Preferences Palette. The icons identify the level from which a preference derives its value.

If icons are displayed on the palette, this button is displayed as [image].


View - Show All Values
Show All Values (View Menu)

Related Topics

Displays all modified and default preferences on the Generator Preferences Palette.

If any filters are specified for the Generator Preferences Palette, only preferences within the restrictions of the currently set filters are displayed.


View - Hide Default Values
Hide Default Values (View Menu)

Related Topics

Hides from the Generator Preferences Palette, those preferences that use the factory settings.

If factory settings are already hidden from the Generator Preferences Palette, a check mark is placed next to this menu option.


View - Hide Container Level Values
Hide Container Level Values (View Menu)

Related Topics

Hides from the Generator Preferences Palette, all preferences that have been explicitly set at the container level and any preferences that use the factory settings.

If container level preferences are already hidden from the Generator Preferences Palette, a check mark is placed next to this menu option.


View - Show Modified Values
Show Modified Values (View Menu)

Related Topics

Displays modified preferences only on the Generator Preferences Palette.

This option is available only if Generator Preferences Palette is currently showing all values.

If any filters are specified for the Generator Preferences Palette, only preferences within the restrictions of the currently set filters are displayed.


Preferences - Expand All
Expand All (Preferences Menu)

Related Topics

Expands all of the preference categories in the Generator Preferences Palette, so that their preferences are shown.


Preferences - Collapse All
Collapse All (Preferences Menu)

Related Topics

Collapses all of the preference categories in the Generator Preferences Palette, so that their preferences are hidden.


Preferences - Track Selection
   Track Selection (Preferences Menu)

Related Topics

Identifies whether the contents of the Generator Preferences Palette are refreshed when you select a different design element (to the one shown in the palette). If selections are being tracked (the default), a check mark is displayed next to this menu option and the Generator Preferences Palette toolbar button is pressed in.


Preferences - Locate Inherited Value
Locate Inherited Value (Preferences Menu)

Related Topics

Locates the repository element from which a selected generator preference inherits its value.

Note:	This option is available only if a preference with an inherited value is selected on the Generator Preferences Palette.

Choosing this menu option, updates the content of the Generator Preferences Palette to show the repository element from which a preference value is inherited.


Security - Lock/Unlock Preferences
Lock/Unlock Preferences (Security Menu)

Related Topics

Locks or unlocks the preferences that have been set for a repository element.

When locked the preferences are protected from being accidentally changed by anyone but the user who implements the lock.

If the preferences for the repository element shown in the Generator Preferences Palette are already locked, this option is displayed as Unlock. Locks that have been set by other users are not removed when the Unlock option is used.


Security - Freeze/Unfreeze
Freeze/Unfreeze (Security Menu)

Related Topics

Freezes or unfreezes preferences for the repository element represented in the Generator Preferences Palette. The name of the element is displayed in the palette (above the Product). When preferences are frozen they cannot be changed in any way.

This option is only available to the owner of the container (and users that have administrative privileges on the container) when the element represented in the palette is not frozen.


Logic Editor- specific menu options and palette buttons


Edit - Undo
Undo (Edit Menu)

Related Topics

Undoes the last action performed on the active Logic Editor Code Window, for example, cutting, pasting, or copying text. Certain actions only can be undone. If the last action was performed using Edit→Undo the action can be redone by using Edit→Redo.

This option is not available if the number of actions that can be undone is set to 0 in the Logic Editor Options dialog box.


Edit - Redo
Redo (Edit Menu)

Related Topics

Reverses the action performed by Edit→Undo in the Logic Editor Code Window.


Edit - Delete
Delete (Edit Menu)

Related Topics

Deletes the current selection from the Logic Editor Code Window without overwriting the contents of the Clipboard.


Edit - Select All
Select All (Edit Menu)

Related Topics

Selects the entire contents of the window.

All text is selected, whether or not any text was already selected.


Edit - Find
Find (Edit Menu)

Related Topics

Searches for a specified string in the Logic Editor Code Window.

Dialog box options

What

Identifies the string for which you want to search. A list of the most recent strings for which you have searched is available from this field.

Match whole word only

To search for whole words and not parts of larger words, select this check box.

Match case

To match uppercase and lowercase characters in the spelling of the find string, select this check box.

Direction

Identifies the direction of the search, Up or Down.

Find

Searches for the string entered in the What field. If the string is found, the Code Window is scrolled to the appropriate place.

Mark All

Creates a bookmark against each line of code that contains the search string. You can use Edit→Go to Bookmark to find each bookmark.


Edit - Replace
Replace (Edit Menu)

Related Topics

Searches for and optionally replaces a specified string in the Logic Editor Code Window.

Dialog box options

Find

Identifies the string for which you want to search. A list of the most recent strings for which you have searched is available from this field.

Replace with

Identifies the string that will replace the Find string. A list of the most recent replace strings is available from this field.

Match whole word only

To search for whole words and not parts of larger words, select this check box.

Match case

To match uppercase and lowercase characters in the spelling of the find string, select this check box.

Preserve case

To ensure that the string that is found keeps its case, regardless of the case in the Replace with field, select this check box.

Replace in

Allows you to choose whether you want to search and replace selected text only or the entire Logic Editor Code Window.

Selection

Identifies that the search and replace applies only to text that is selected in the Logic Editor Code Window. This option is not available if no text is selected in the window.

Entire buffer

Identifies that the search and replace applies to all text displayed in the Logic Editor Code Window.

Find Next

Searches the Logic Editor Code Window for the next occurrence of the search string.

Replace

Replaces the last search string found using Find Next with the replacement string.

Replace All

Replaces all occurrences of the search string with the replacement string

Close

Closes the dialog box.


Edit - Go To
Go To (Edit Menu)

Related Topics

Navigates to a specified line in the Logic Editor Code Window.

Dialog box options

Line

Identifies code line number to which you want to navigate.


Edit - Toggle Bookmark
   Toggle Bookmark (Edit Menu)

Related Topics

Places a bookmark at the current position in the Logic Editor Code Window. Only one bookmark at a time can be set.

At a later stage, if you want to return to the bookmark, you can use Edit→Go to Bookmark.


Edit - Go to Bookmark
   Go to Bookmark (Edit Menu)

Related Topics

Automatically scrolls down the Logic Editor Code Window to the next bookmark.


Edit - Record Macro
Record Macro (Edit Menu)

Related Topics

Records one or more keyboard strokes in a Logic Editor Code Window and stores them as a macro.

When you choose this option, all keystrokes that you perform in the Logic Editor Code Window are recorded until you click the Stop button on the Record Macro window. When you have stopped recording a macro a dialog box is displayed for you to specify the keys that start the macro.

It is possible to record up to ten macros for use by the Logic Editor.

Dialog box options

Press New Shortcut Key

Identifies the keys that must be pressed to run the macro.

Save As

Saves the macro to one of ten predefined macro slots.


Edit - Insert Construct
Insert Construct (Edit Menu)

Related Topics

Inserts the selected construct from the Construct Tree into the Logic Editor Code Window.

This option is not available unless a construct is selected in the Construct Tree.


Edit - Import Construct
Import Text (Edit Menu)

Related Topics

Imports the contents of a text file from third-party applications into the Logic Editor Code Window.

The entire contents of the source file are inserted at the current cursor position in the Code Window. Any text that is selected before running the command is replaced with the imported text.

The Open dialog box is displayed, which enables you to specify the location and the filename of the file that contains the text to be imported.


Edit - Export Construct
Export Text (Edit Menu)

Related Topics

Writes the contents of the Logic Editor Code Window to a specified destination file.

The entire contents of the Code Window are exported to a text file, regardless of whether any text is selected before the command is run. If required, the contents of an existing file can be overwritten.

The Save As dialog box is displayed, which enables you to specify the destination file into which the text is to be exported.


View - Construct Tree
Construct Tree (View Menu)

Related Topics

Closes or restores the Logic Editor Construct Tree window.


Utilities - Check Syntax
   Check Syntax (Utilities Menu)

Related Topics

Checks the syntax of the logic stored in the repository. This utility can be used to check the syntax of PL/SQL code that has already been saved.

The syntax checker is invoked from the active Logic Editor Code Window.


Logic Editor palette - Save Logic button
   Save Logic

Related Topics

Saves any changes that have been made to the Logic Editor Code Window, without saving any changes you may have made outside of the Code Window.

If you attempt to close the Logic Editor before saving changes, you will be asked if you want to keep the changes.


Logic Editor palette - Revert Uncommitted Data button
   Revert Uncommitted Data

Related Topics

Cancels any proposed changes made, without canceling any changes you may have made outside of the Code Window. For example, if you have changed several lines of code in the Logic Editor Code Window, but have not saved the changes, selecting this button returns the code to its previous state.


Comment topic:

This file contains all of the DE specific menu topics and toolbar buttons that are not relevant to ODD


DE Navigator Window specific menu options and palette buttons


File - New - Module Diagram
   New Module Diagram (File Menu)

Related Topics

Creates a new untitled Module Diagram. If a module is selected from the Navigator when you choose this option the new diagram is based on that module. If a module is not selected, you can create a new module and a corresponding diagram, or open a diagram for an existing module.

Dialog box options

The list box shows module definitions that exist in the current workarea. For each module in the list, an icon and a language name is shown. These identify the type of application that will typically be generated from each module.

You can optionally create a new module definition by clicking Create. This causes a dialog box to be displayed for you to enter the module name, type, purpose and language.

If you create a new module, it is added to the list of modules in the dialog box.


View - Module Application Guide
Module Application Design (View Menu)

Related Topics

Changes the view of the Navigator to show the Modules tab. If the contents of this tab are already shown, a checkmark is displayed next to this menu option.

Tip: Instead of using this menu option you can click the Modules tab on the Navigator.


View - Display Network Horizontally
Display Network Horizontally (View Menu)

Related Topics

Toggles the Module Network branch (on the Modules tab) to display module networks horizontally or vertically.


View - All Logic
All Logic (View Menu)

Displays all user-defined application logic in all languages for all modules. When this menu option is unchecked (the default), only the application logic that is relevant to the module language is displayed; otherwise all the application logic that has been defined for the module is displayed, including the logic that is not appropriate to the module's language.


Utilities - Default Links
Default Links (Utilities Menu)

Related Topics

Allows you to automatically generate links that specify how the module component table usages in a module definition are to be used in constructing the groups on a generated application.

The type of links that are generated by this utility are referred to as key based links.  About

Note:	This menu option is available only if a module is selected from the Navigator or if a Module Diagram is displayed.

Dialog box options

Parent Links group

Groups together the options that generate key based links between table usages in different module components.

Find Parents checkbox

Determines whether links are created to parent table usages. If checked, the utility searches for parents for each of the table usages. Where a parent is found a link is created between a base table usage and the first base table usage (placed hierarchically above it on the diagram) to which it is related via a foreign key or domain key.

For a join to be considered valid, bound items must already exist in both the child and proposed parent table usages, for each of the key component columns in the proposed foreign key or domain key. If the Lookup Links option is not checked, parents must be base table usages.

Find Second Parents checkbox

Determines whether links are created to more than one parent from a table usage. If checked, the utility searches for links to an additional parent table usage, when the child table usage already has a link to a parent.

For a join to be considered valid, bound items must already exist in both the child and proposed parent table usages, for each of the key component columns in the proposed foreign key or domain key. If the Lookup Links option is not checked, parents must be base table usages.

The key that is used to join a table usage to the first parent, is ignored when looking for a join to the second parent.

Allow Lookup Parents checkbox

Determines whether a lookup table usage can be a parent of a base table usage. If checked, this option allows the Find Parents and Find Second Parents options to include lookup table usages in their search for parents.

Allow Keys against Master Components checkbox

Determines whether links are created between table usages where the parent table usage contains the foreign key or domain key constraint, i.e. an inverted master-detail link.

Keep Existing Links checkbox

Determines whether existing links are removed from a diagram before the default links are created. If checked the existing links are not removed. This option can be used with any of the four prior options.

Lookup Links group

Groups together the options that generate key based links between table usages within a single module component.

Create Table Usages for Descriptor Columns checkbox

Determines whether or not lookup usages that have not been specified on the diagram should be created. If checked, the utility creates lookup table usages for existing table usages, by finding a table to base a new table usage on. The table must have descriptor columns that are not part of the foreign key or domain key. All descriptor columns that are not part of the foreign key are created as displayed bound items. Foreign key or domain key columns are created as non-displayed bound items.

For a foreign key or domain key to be considered, valid bound items must exist for each of the key components in the table usage. A new lookup table usage may only be based upon a table that has descriptor columns defined, that aren't part of the proposed key.

Use Outer Joins checkbox

In report module definitions, this determines whether the outer join operator is added to lookup links and links to Descriptor DTUs (table usages based on tables that contain descriptor columns that are not part of a foreign key column or domain key column.) Outer join operators are used when a column in a foreign key constraint or domain key constraint is defined as optional or when more than one key constraint is defined on one column.

Find Treewalk Links checkbox

In report module definitions, this determines whether treewalk links are created. If checked, a treewalk link is created for each table usage on the diagram that has a single key component recursive foreign key or domain key defined against it.


Utilities - Default Lists of Values
Default Lists of Values (Utilities Menu)

Related Topics

Allows you to automatically create Lists of Values (LOV) components or include reusable LOV components for a selected module, module component base table usage or lookup table usage.

Dialog box options

Context object for which Lists of Values will be created

Identifies the module, module component, sub-component, base table usage or lookup table usage (that is directly connected to a base table usage) for which you want to create default LOV components. The context object's owning container is displayed in brackets.  About

Use Reusable Lists of Values

Defines whether reusable LOV components in the owning container will be used if appropriate, rather than creating new LOV components.

Additional Containers

If you choose to use reusable LOV components, you can specify additional containers in which the utility is to search for the LOV components. Type the names of the containers that you want the utility to search, or Click Browse to select and sequence the required containers.

Reuse existing Lists of Values defined within the module

Determines whether LOV components defined within a module will be used if appropriate, rather than creating new LOV components. Choosing this option allows a single LOV component to provide lists of values for more than one repository item.

This option is checked by default.

Note: If you check this option and check the Use Reusable Lists of Values option, this option is performed first, i.e. the utility searches for suitable specific LOV components before searching for suitable reusable LOV components.

Create Reusable Lists of Values for Reusable Module Components (By default LOVs are created within a module)

Determines whether reusable LOV components are to be created for use by reusable module components and sub-components. If you do not check this option the utility creates LOV components in the owning module.

This option is checked by default.

Create Reusable Lists of Values for Module Components defined within the module (By default the LOVs are created specific to a module)

Determines whether reusable LOV components are to be created for non reusable module components and sub-components. If you do not check this option the utility creates LOV components in the owning module.


Utilities - Validate
Validate (Utilities Menu)

Related Topics

The Validate utility enables you to check application designs recorded in the repository, prior to generation. For example, you can validate an Oracle Forms module before generating the actual form.

This option is available only if a repository module is selected.


Utilities - Copy Menu Structure
Copy Menu Structure (Utilities Menu)

Related Topics

Generates a menu structure for a selected module.

Note:	This option is available only if a module is selected from the Module Network node on the Navigator.

Choosing this option displays a dialog box from which you must select the module to which the menu structure will be copied.


Generate - Generate Module
   Generate Module (Generate Menu)

Related Topics

Generates client applications from information held in the repository. Depending on the language of the module that you want to generate, one of the following dialog boxes is displayed:

Generate Form dialog box

Generate Library dialog box

Generate Report dialog box

Generate Visual Basic dialog box

Generate Web PL/SQL dialog box

This option is available only when a module is selected on the Navigator or a Module Diagram is the active window.


Generate - Generate Module As
Generate Module As (Generate Menu)

Related Topics

Allows you to choose the type of application that is to be generated from the selected module. The type of generated application can be different from the chosen module definition. For example, you can generate a report from an Oracle Forms module.

Choosing this option displays the Generator Module As dialog box, which allows you to choose the type of application that you want to generate. Depending on the option that you choose from this dialog box one of the following dialog boxes is displayed:

Generate Form dialog box

Generate Help System dialog box

Generate Report dialog box

Generate Visual Basic dialog box

Generate Web PL/SQL dialog box

This option is available only when a module is selected on the Navigator or a Module Diagram is the active window.


Generate - Generate Database from Server Model
   Generate Database from Server Model (Generate Menu)

Generates an Oracle database, or database of a different type, from a server model in the repository. Choosing this menu option displays the Generate Database from Server Model dialog box in the context of a single container.

Note:	If the Container List does not display a container name, this option is not available.  About

For more information, see Generating databases.

Dialog box options

The Generate Database from Server Model dialog box is organized into the following tabs:

Generate Database from Server Model - Target

Generate Database from Server Model - Objects


Generate - Generate Database Administration Objects
Generate Database Administration Objects (Generate Menu)

Generates CREATE statements to create database administration objects for an Oracle database. Choosing this menu option displays the Generate Database Administration Objects dialog box.

Note:	If the Container List on the Main Toolbar does not display a container name, this option is not available.  About

Dialog box options

The Generate Database Administration Objects dialog box is organized into the following tabs:

Generate Database Administration Objects Target

Generate Database Administration Objects Objects

Related Topics

Generating databases.


Generate - Generate Table API
Generate Table API (Generate Menu)

Generates PL/SQL packages to perform DML operations on tables. Choosing this menu option displays the Generate Table API dialog box.

Note:	If the Container List on the Main Toolbar does not display a container name, this option is not available.  About

Dialog box options

The Generate Table API dialog box is organized into the following tabs:

Generate Table API - Target

Generate Table API - Objects


Generate - Generate Module Component API
Generate Module Component API (Generate Menu)

Generates PL/SQL packages to perform DML operations on module components. Choosing this menu option displays the Generate Module Component API dialog box.

Note:	If the Container List on the Main Toolbar does not display a container name, this option is not available.  About

Dialog box options

The Generate Module Component API dialog box is organized into the following pages:

Generate Module Component API - Target

Generate Module Component API - Objects


Generate - Generate Reference Code Tables
Generate Reference Code Tables (Generate Menu)

Creates and/or updates a database table with allowable values defined for specified columns, domains or unbound items.

Note:	If the Container List on the Main Toolbar does not display a container name, this option is not available.  About

For more information see, About reference code tables

Dialog box options

The Generate Reference Code Tables API dialog box is organized into the following pages:

Generate Reference Code Tables dialog box - Target tab

Generate Reference Code Tables dialog box - Objects tab


Generate - Generate Capture Design of Form
Capture Design of Form (Generate Menu)

Captures the design of existing Oracle Forms applications to module definitions held in the repository.

Choosing this option displays the Capture Form Design dialog box


Generate - Generate Capture Design of Report
Capture Design of Report (Generate Menu)

Captures the design of existing Oracle Reports applications to module definitions held in the repository.

Choosing this option displays the Capture Report Design dialog box


Generate - Generate Capture Design of Visual Basic
Capture Design of Visual Basic (Generate Menu)

Captures the design of an existing Visual Basic application to module definitions held in the repository.

Choosing this option displays the Capture Visual Basic Design dialog box

Related Topics

Capturing the design of a Visual Basic project


Generate - Generate Capture Design of Library
Capture Design of Library (Generate Menu)

Captures the design of existing Oracle common libraries to module definitions held in the repository.

Choosing this option displays the Capture Library dialog box


Generate - Generate Capture Design of Server Model
Capture Design of Server Model (Generate Menu)

Captures the definitions of database objects from an online database or from DDL scripts. Choosing this menu option displays the Capture Server Model from Database dialog box.

For more information, see Generating a database from a captured design.

Dialog box options

The Capture Server Model from Database dialog box is organized into the following tabs:

Capture Server Model from Database - Source

Capture Server Model from Database - Objects


Generate - Generate Capture Application Logic
Capture Application Logic (Generate Menu)

Captures application logic from an existing application into the repository.

Choosing this option displays one of the following dialog boxes:

Forms Capture Application Logic dialog box

Reports Capture Application Logic dialog box

Visual Basic Capture Application Logic dialog box


Tools - Module Display Wizard
Module Display Wizard (Tools Menu)

Related Topics

Invokes the Module Display Wizard to lead you through the steps of laying out a generated application. The steps that are presented to you by the wizard are determined by the type of application that you are designing.

Note:	This wizard can be used to edit the display related properties of module components, module sub-components and List of Values components. It cannot be used to create these types of components.


Tools - Reusable Component Graphical Editor
Reusable Component Graphical Editor (Tools Menu)

Related Topics

Opens a Reusable Component Diagram based on a selected reusable module component or List of Values component. This menu option is available if a reusable component is selected from the Navigator or a Module Diagram.


Tools - Module Application Guide
Module Application Guide (Tools Menu)

Related Topics

Invokes the Module Application Guide to lead you through the process of designing modules for application generation.

Note:	You can also invoke the Module Application Guide directly from the Welcome Screen at startup.

The Web PL/SQL application design process

The Visual Basic application design process

The MS Help application design process


Tools - Batch Generate
Batch Generate (Tools Menu)

Related Topics

Invokes the Batch Generation tool that allows you to specify generation options and perform generation based on those options.


Tools - Batch Design Capture
Batch Design Capture (Tools Menu)

Related Topics

Invokes the Batch Design Capture tool that allows you to specify design capture options and perform design capture based on those options.


Options - Show/Hide
Show/Hide (Options Menu)

Related Topics

Shows or hides element properties on the diagram.

This option is available if a diagram is the active window.

If a Server Model Diagram is active, the Server Model Diagram - Show/Hide Options dialog box is displayed.

If a Module Diagram is active, the Module Diagram - Show/Hide Options dialog box is displayed.


Options - General Settings
General Settings (Options Menu)

Related Topics

Sets general options within the tool. The settings shown in this dialog box are used as defaults each time the tool is started. For example, you can specify whether the Welcome Screen should be displayed each time you run the tool.

Dialog box options

Show

Welcome Screen

When checked, identifies that the Welcome Screen is to be displayed when the tool is invoked.  About

Default Setting Dialogs

When checked, identifies that the Default Database Implementation Wizard is to be displayed when you create a server model element, e.g. a table definition, in the repository.  About

Dialogs on Drag & Drop

When checked, identifies that the Copy Objects dialog box is displayed when you perform copy operations using the drag and drop method.

Versioning

Auto Check Out

When checked, identifies that if you attempt to edit a checked in repository element it is automatically checked out so that it can be edited.

Note, This option is only available if you have the Version access right for the current workarea. Use the Repository Object Navigator to grant access rights.

If you do choose to use auto check out, you must specify whether you want checked out elements to be locked. Note, if a strict locking policy is in force all check outs are performed with a lock, i.e. the Always Check Out Unlocked option is not available.

By default this option is unchecked, i.e., checked in elements are not automatically checked out when you attempt to edit them.

Default Module Diagram View

Data / Display

Identifies whether Module Diagrams default to Data view or Display view.  About

General

Use Dialogs

When checked, identifies that Property dialog boxes are used as the default interface for creating and editing repository elements, e.g. table definitions. If this box is unchecked, Property Palettes are used by default.  About

Date Format

Identifies the default date format to be used for all dates shown on Property Palettes.

Generation

Warning level for generation

Identifies the types of errors that are reported in the message window during generation and design capture.

Level	Meaning
Information	Displays Information, Warning and Error messages.
Warning	Displays Warning, Error and Fatal messages.
Error	Displays Error and Fatal messages.


Options - Customize
Customize (Options Menu)

Related Topics

Customizes which repository elements are displayed on the Navigator and the order in which they are displayed. In addition, you can specify which property values are to be displayed next to the object name on the Navigator and diagrams.

Dialog box options

Element type list box

Identifies the type of repository element for which customization options are to be specified. The dialog box tabs show customization options for the selected item.

Filter in Navigator tab

Property

Lists the names of the properties that exist for the selected element type.

Condition

Determines which instances, for each element type, are to be filtered from the Navigator, by excluding elements whose property values do not match specified filters. For example, to display only tables that were created by a user 'Fred', enter 'Fred' against the User Created By property.

The wildcard character % can be used.

To display...	Enter...
Element names containing mod	%mod%
Element names starting with mod and ending with set.	mod%set
The filter is not case sensitive, i.e. the filter does not differentiate between FRED and fred.

Sort in Navigator tab

Order by

Identifies the properties that determine the order in which elements are sorted on the Navigator. A check mark is displayed in this list for each property that determines the sort sequence.

Property

Lists the names of the properties that exist for the selected element type.

Desc.

Identifies whether the values for a property value should be sorted in ascending or descending sequence. Properties are, by default, sorted in ascending order, i.e. A through to Z.  If a check mark is displayed for a property then it will be sorted in descending order, i.e. Z through to A.

Resequence buttons

Specifies the order in which properties are to be used when specifying the sequence of elements on the Navigator. These buttons are available only for properties that have a check mark displayed in the Order by list.

An example of when you may want to change the sort order of the element properties is to sort tables, firstly by the date on which they were created and secondly by who created them.

Show Properties tab

Display?

Identifies the properties that are to be shown on the Navigator and diagrams for the chosen element type. A check mark is displayed in this list for each property that is to be displayed on the Navigator.

Default / Module Diagram Display View option

This option is displayed only for elements that can be displayed on Module Diagrams or Reusable Component Diagrams. For example, this option is not visible if Java Class Definitions is selected from the Element type list. It allows you to specify which properties are to be shown for a diagram's Data (Default) or Display view.

Sequence buttons

Specifies the order in which properties are to be displayed on the Navigator and diagrams. These buttons are available for properties that have a check mark displayed in the Display? list only.

Save Settings as Default checkbox

If checked, identifies that the customization options that you set in this dialog box are to be saved for future use. If unchecked the settings are used for this session only.

Apply

Saves the changes you have made, overwriting any previous settings. The dialog box remains open, for you to make further changes and for you to view the results of your changes on the Design Navigator or a diagram. Once you have clicked Apply you cannot undo your changes by clicking Cancel.

OK

Saves the changes you have made, overwriting any previous settings, and closes the dialog box.

Cancel

Cancels changes you have made and closes the dialog box. Any changes made prior to clicking the Apply button cannot be canceled.

Help

Displays help information about the dialog box.


Generator Options - Forms
Form Generator Options (Options Menu)

Specifies the runtime options for generating Form applications. Choosing this option displays the Form Generator dialog box.

Choosing this option displays the Form Generator Options dialog box.


Generator Options - Reports
Report Generator Options (Options Menu)

Specifies runtime options for generating Oracle Reports applications.

Choosing this option displays the Capture Reports Design Options dialog box.

Related Topics

Generating report output


Generator Options - Libraries
Library Generator Options (Options Menu)

Specifies runtime options for generating Oracle common libraries.

Choosing this option displays the Library Generator options dialog box.


Generator Options - Visual Basic
Visual Basic Generator Options (Options Menu)

Specifies runtime options for generating Visual Basic applications.

Related Topics

Setting Visual Basic Generator options


Generator Options - Web PL/SQL
Web PL/SQL Generator Options (Options Menu)

Specifies runtime options for generating Web PL/SQL applications.

Choosing this option displays the Web PL/SQL Generator Options dialog box.


Generator Options - Help System
Help System Generator Options (Options Menu)

Specifies runtime options for generating MS Help applications.

Choosing this option displays the Help System Generator Options dialog box.


Options - Form Design Capture
Form Design Capture Options (Options Menu)

Specifies runtime options for capturing the design of existing Oracle Forms applications.

Choosing this option displays the Forms Design Capture Options dialog box.


Options - Report Design Capture
Report Design Capture Options (Options Menu)

Specifies runtime options for capturing the design of existing Oracle Reports applications.

Choosing this option displays the Reports Design Capture Options dialog box.


Generator Options -Database
Database Generator Options (Options Menu)

Specifies runtime options for generating database objects.

Choosing this option displays the Database Generator Options dialog box.

Related Topics

About database generation


Preferences Palette - specific menu options


Preferences - Inherit
   Inherit (Preferences Menu)

Related Topics

Unsets selected preferences that are explicitly set, to inherit their values from a higher level. For example, a module preference may be unset so that the preference value is inherited from the application level.

When a preference set is used to determine the value of a preference, that preference always reflects the value that has been specified in the preference set. To unset the value of a preference whose value is determined by a preference set, the value must be unset within that set. These preferences are identified on the Generator Preferences Palette by the Referenced Set icon.


Preferences - Cascade Inherit All
Cascade Inherit All (Preferences Menu)

Related Topics

Unsets values of all preferences for the element shown in the Generator Preferences Palette, and any lower level elements. For example, if the palette shows preferences for an application system, all preferences within the whole application system would be unset.


Preferences - Cascade Inherit Selection
Cascade Inherit Selection (Preferences Menu)

Related Topics

Unsets values of selected preferences for the elements below the element displayed in the Generator Preferences Palette. For example, if the palette shows preferences for an application system, the selected preferences would be unset throughout all levels of that application system, so that they inherited their values from the application system.


Module diagram  specific menu options and palette buttons


Edit - Select Same Group
Select Same Group (Edit Menu)

Related Topics

Selects all items that are in the same group as those currently selected on the active Module Diagram or Reusable Component Diagram. This option is only available if one or more items in the same group are selected on the diagram.

Use this option to help identify items in a group from a diagram's Data view, where the items are likely to be spread over more than one table usage.


Utilities - Group Items
   Group Items (Utilities Menu)

Related Topics

Groups selected items, on a module component or sub-component, so that they can be treated as a single layout object in a generated application.


Utilities - Remove From Group
   Remove From Group (Utilities Menu)

Related Topics

Removes one or more selected items from an item group. The selected items can be on more than one module component or sub-component, and can belong to different item groups.


View - Data/Display View
Data View / Display View (View Menu)

Related Topics

Sets a Module Diagram or Reusable Component Diagram to its data or display view.

Data view   [image]   When the diagram is set to data view (the default), this button is displayed on the diagram's tool palette.

Display view   [image]   When the diagram is set to display view, this button is displayed on the diagram's tool palette.


Module Diagram tool palette - Include Module Component
   Include Reusable Module Component

Related Topics

Includes an existing reusable module component, and it's module sub-components, in a module definition.  About

Note:	This option is not available for library modules.

When this button is selected and the cursor is positioned over the module diagram element, the cursor changes shape to the module component symbol. Clicking on the module diagram element causes a standard dialog box to be displayed, from which you must select the required module component.

The included module component is shown on the diagram within the context of the module.


Module Diagram tool palette - Create Component
   Create Specific Component

Related Topics

Creates a specific module component definition in the repository and a representation of the module component on the diagram.  About

Note:	This option is not available for library modules.

When this button is selected and the cursor is positioned over the module diagram element, the cursor shape changes to the module component symbol. Clicking on the module diagram element inserts a module component node on the diagram. Module Component details are recorded on a property palette or a property dialog.


Module Diagram tool palette - Create Sub-component
   Create Sub-component

Related Topics

Creates a module sub-component definition in the repository and a representation of the module sub-component on the diagram.  About

Note:	This option is available only for Oracle Forms modules that contain one or more module component diagram elements.

When this button is selected and the cursor is positioned below a module component or a module sub-component on the diagram, the cursor shape changes to the module sub-component symbol. Clicking on the diagram inserts a module sub-component node on the diagram. Module sub-component details are recorded on a property palette or a property dialog.


Module Diagram tool palette - Include LOV Component
   Include List of Values Component

Related Topics

Includes an existing List of Values (LOV) component in a module definition, and optionally associates the LOV component with a bound or unbound item.  About

Note:	This option is not available for library modules.

When this button is selected include the LOV component by positioning the cursor over the module diagram element, the cursor shape changes to the LOV component symbol.

Note:	If you position the cursor over a bound or unbound item on the module diagram element, the included LOV component will be associated with that item.

Clicking on the module diagram element (or the name of a bound or unbound item) causes a dialog box to be displayed, from which you must select the required LOV component. This includes the LOV component.

The included LOV component is shown on the diagram within the context of the module. Note that LOV components are displayed after all module components and sub-components on Module Diagrams.


Module Diagram tool palette - Create LOV Component
   Create List of Values Component

Related Topics

Creates a specific LOV component definition in the repository and a representation of the LOV component on the diagram. The LOV component may optionally be associated with a bound or unbound item.  About

Note:	This option is not available for library modules.

When this button is selected and the cursor is positioned over the module diagram element, or the name of a bound/unbound item, the cursor shape changes to the LOV component symbol.

Clicking on the module diagram element, or the name of a bound/unbound item, inserts a LOV component node on the diagram, after all module components and sub-components. The LOV component details are recorded on a property palette or a property dialog.


Module Diagram tool palette - Create Table Usage
   Create Table Usage

Related Topics

Creates a table usage definition in the repository and a representation of the table usage on the diagram.  About

Note:	This option is not available for library modules.

When this button is selected and the cursor is positioned over a non-reusable module component, sub-component or LOV component, the cursor shape changes to the table usage symbol. Clicking on the component diagram element causes a standard dialog box to be displayed, from which you must select the required table usage.


Module Diagram tool palette - Create Item
   Create Item

Related Topics

Creates an item definition in the repository and a representation of the item on the diagram.  About

Note:	This option is not available for library modules.

The item definition is represented on the diagram by text, which is automatically created when the definition is created.

When this button is selected, you can:

•	create a bound item, by positioning the cursor over a table usage

•	create an unbound item, by positioning the cursor over a module component, sub-component or List of Values component

Clicking on the drawing surface inserts an item on the diagram.

Note:	If the diagram is set to Display view, you can create unbound items only using this button.


Module Diagram tool palette - Create Action Item
   Create Action Item

Related Topics

Creates a navigation, custom or generator action item definition in the repository, and a representation of the action item on the diagram.  About

Note:	This option is not available for library modules.

When this button is selected the cursor shape changes to the action item symbol. Clicking on a module component, sub-component or window layout element inserts an action item on the diagram. Action item details are recorded on a property palette or a property dialog.

Dialog box options

Navigation action item within the module

Creates a navigation action item, to navigate from a module component or sub-component, to a module component or sub-component. within the same module If you choose this option, a dialog box is displayed for you to choose the required module component or sub-component.

Navigation action item to a different module

Creates a navigation action item, to navigate from a module component or sub-component to a different module. If you choose this option, a dialog box is displayed for you to choose the module to which you want to navigate.

Custom action item

Creates a custom action item, to invoke a custom piece of functionality from a module component or sub-component.

Generator action item

Creates a generator action item, to invoke a standard piece of generator functionality (such as 'Commit') from a module component or sub-component.


Module Diagram tool palette - Create Key Based Link
   Create Key Based Link

Related Topics

Creates a definition for a key based link in the repository and a representation of the link on the diagram.  About

Note:	This option is not available for library modules.

When this button is selected the cursor shape changes to the key based link symbol. Click on a table usage to anchor the connector. Then click on the destination of the link.


Module Diagram tool palette - Create Module Network Link
   Create Module Network Link

Related Topics

Creates a definition for a module network link in the repository and a representation of the link on the diagram.  About

When this button is selected the cursor shape changes to the module network link symbol. To create a calling module click the cursor to the left of the module definition, to create a called module click the cursor to the right of the module definition.

The Create dialog box is displayed for you to choose the modules that are to be part of the network.


Module Diagram tool palette - Create Window
   Create Window

Related Topics

Creates a definition for a window layout element in the repository and a representation of the window on the diagram. Window elements are used by the application generators in the following ways:

Generators	What gets generated...
Form Generator	A window on a form.
Reports Generator	A new report within a report.
Visual Basic Generator	A Visual Basic form on a VB application.
Web PL/SQL Generator	A Web page in a Web PL/SQL application.
Note:	This option is not available for library modules.

When this button is selected the cursor shape changes to the window layout symbol.


Module Diagram tool palette - Create Content Canvas
   Create Content Canvas

Related Topics

Creates a content canvas layout element on the Module Diagram. The layout element represents a content canvas on an Oracle Forms module.

When this button is selected the cursor shape changes to the content canvas layout symbol.

Note:	This option is available for Oracle Forms modules that contain one or more module component or sub-component diagram elements.


Module Diagram tool palette - Create Stacked Element
   Create Stacked Element

Related Topics

Creates a stacked layout element on the Module Diagram. The layout element represents a stacked canvas on an Oracle Forms application or a stacked zone on a Visual Basic application.

When this button is selected the cursor shape changes to the stacked layout element symbol.

Note:	This option is available for Oracle Forms modules and Visual Basic modules that contain one or more module component or sub-component diagram elements.


Module Diagram tool palette - Create Tab Canvas Page
   Create Tab Canvas Page

Related Topics

Creates a tab canvas page layout element on the Module Diagram. The layout element represents a tab page of a tab canvas on an Oracle Forms application.

When this button is selected the cursor shape changes to the tab canvas page layout element symbol.

Note:	This option is available for Oracle Forms modules that contain one or more module component or sub-component diagram elements.


Module Diagram specific dialog boxes - This topic is for documentation purposes only


Create a Link dialog box

Related Topics

Allows you to create a key based link between two table usages on a Module Diagram.  About

This dialog box is displayed when you perform an action that causes a module component (with a base table usage) to be created or included on a Module Diagram and linked to a component already on the diagram. For example, if you drag a table definition to below an existing module component with which it can be linked (this causes a new non-reusable module component to be created ) or if you drag a reusable module component to below an existing module component with which it can be linked (this includes the reusable component in a module).

The dialog box lists the possible key based links that you can create between the new module component and existing diagram components.

Note:	If the name of a constraint is too long to be displayed, an ellipsis is used to identify that the name has been truncated on the dialog box.

The list of potential key based links is determined by:

•	Where the new module component is to be placed on the diagram.  About

•	The foreign key, primary key and domain constraints that exist between the table usage in the new module component and the base table usages in the existing module components.

Note:	If you do not want to create a key based link, choose No Link from the Constraint list and then click OK. Clicking Cancel causes the whole operation to be canceled, i.e. the new element is not created on the Module Diagram.


Create Module Component dialog box

Related Topics

Creates a default module component and table usage for a module definition, when a table is dragged onto a module. The module component is given a default name, based on the table name. In addition, you can specify the table operations that can be performed by the module component in a generated application and the columns that are to be used.

Dialog box options

Select checkbox

Indicates whether QUERY operations are allowed using the module component. If checked QUERY operations are allowed.

Insert checkbox

Indicates whether new records can be added using the module component. If checked, INSERT operations are allowed.

Update checkbox

Indicates whether records can be updated using the module component. If checked, UPDATE operations are allowed.

Delete checkbox

Indicates whether records can be deleted using the module component. If checked, DELETE operations are allowed.

Available columns

Lists the database columns that exist for the tables on which the usages are based.

(Disp) Selected Items

Lists the database columns that are to be used by the module component. If a check mark is displayed next to a column, the column is to be displayed on applications that are generated from this module component.

Note:	The primary key columns are automatically displayed in this list.

Assign Selected buttons

These buttons allow you to move selected items between list boxes.

Assign All buttons

These buttons allow you to move all items from one list box to another.

Resequence buttons

These buttons allow you to resequence the selected items.


Links dialog box

Related Topics

This dialog box allows you to choose the destination of a key based link and is displayed in either of the following circumstances:

•	If you click outside of the module diagram element when creating a link on a Module Diagram.

•	If you create a key based link from the Navigator and there is more than one candidate link.

The OK button remains dimmed until a definition of the correct type is selected in the list box. For example, to create a key based link, you must select a primary key, foreign key or domain constraint name.

The dialog box shows all modules to which a key based link can be created. Click [image] and [image] buttons to navigate to the table usage that is to be the destination of the link.

The following icons are used to identify the type and direction of the link that will be created.

Icon	Key constraint type
	Domain constraint Creates a link, based on the domain constraint, to a usage of a domain table.
	Foreign key Creates a standard master detail type link.
	Foreign key Creates an inverted master detail type link.
	Primary key Creates a link, based on the primary key, to a usage of the same table in a different module component.

For more information, see About key based links


Choose a key to link dialog box
Choose a constraint to link... dialog box

Related Topics

The dialog box displays the names of the constraints that can be used to create a key based link between two table usages. It is displayed only if there is more than one candidate link.

The following icons are used to identify the type and direction of the link that will be created.

Icon	Key constraint type
	Domain constraint Creates a link, based on the domain constraint, to a usage of a domain table.
	Foreign key Creates a standard master detail type link.
	Foreign key Creates an inverted master detail type link.
	Primary key Creates a link, based on the primary key, to a usage of the same table in a different module component.

For information about key based links, see About key based links


Choose a Join Constraint dialog box

Related Topics

Allows you to choose the foreign key constraint or domain constraint that should be used to implement a key based link between two table usages in a module definition.

This dialog box is displayed only where there is more than one appropriate constraint that can be used.

For information about key based links, see About key based links


Module Diagram - Show/Hide Preferences dialog box

Related Topics

Allows you to specify which information is to be shown for diagram elements displayed on a Module Diagram.

Dialog box options

Items

On/Off options

Identifies whether bound and unbound items are be displayed on Module Diagrams. When set to On, items are displayed.

Note:	This option does not cause action items to be removed from Module Diagrams.

Datatype Indicator

Identifies whether datatype indicators are to be displayed next to each item on a Module Diagram. When checked, datatype indicators are to be displayed.

Container Display

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

None	Container names are not displayed 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 any owning containers, next to the element name. This option is useful if your designs contain nested containers.
Links

Name

Identifies whether the link names are to be displayed next to the links on Module Diagrams. When checked, the link names are displayed.

Module Network

Identifies whether module network links are to be shown on Module Diagrams, i.e. whether links to other modules are shown. When checked, links to other modules are shown.

Diagram

Legend

Identifies whether a diagram legend, i.e. who created a diagram, is displayed on Module Diagrams. When checked the diagram legend is displayed.

Annotation

Identifies whether annotations are to be displayed on Module Diagrams. When checked annotations are displayed.

OK

Changes the display options for the duration of the current session.

Cancel

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

Restore

Removes all changes that you have made since the last Save and returns the last saved settings in their stead. These default values are stored in the Registry. Note that even if you saved the diagram with a set of preferences, these settings will be reset to the  values held in the Registry.

Save

Saves the current display options to the Registry, so that future invocations of the Design Editor will use these settings.


Include Module Component / List of Values dialog box

Related Topics

Allows you to include one or more reusable module components or List of Values components in a module.

Dialog box options

Filter control

Allows you to filter the repository elements that are displayed in the list box. The wildcard character (%) is used to represent any character, string of characters or no characters. The Filter button is available only if the wildcard character is entered in the filter field. When this button is pressed, the items in the list box are filtered to match the specified search string.

List box

Lists the existing repository elements from which you can choose.

Identify the elements that are to be selected on the diagram, by selecting one or more entries from this list.

Make Private Copy

When checked, creates a copy of each of the module components or List of Values components in the module, rather than including reusable components.

Select All

Selects all entries in the list box. This button is available only if there is more than one entry in the list box.

Clear All

Unselects all entries in the list box.


Database Navigator dialog box - Not used by Database Designer


Set source for dialog box

This dialog box allows you to specify information about a design capture source when you initiate design capture by dragging existing data onto the Design Navigator.

Dialog box options

The options displayed  for source capture correspond to options on the Capture dialog box. For help about these options, see Capture Server Model dialog box - Source tab

Store all connection details in registry

This option allows you to save the set source capture details in the registry, to provide default values for future use.


Set target for dialog box

This dialog box allows you to specify information about a generation target when you initiate generation by dragging repository elements onto the Database Navigator. The title of the dialog box identifies the generation target type, for example, when setting generation target details, the title may be 'Set Target for Database Administration Objects'.

Dialog box options

The options displayed  for each type of generation target correspond to options on the Generate dialog boxes in the Design Editor. For help about these options see:

•	Generate Table API dialog box - Target tab

•	Generate Module Component API dialog box - Target tab

•	Generate Reference Code Tables dialog box - Target tab

•	Generate Database Administration Objects dialog box - Target tab

•	Generate Database from Server Model dialog box - Target tab

Store all connection details in registry

This option allows you to save the set target generation details in the registry, to provide default values for future use.


Module Diagrams
About Module Diagrams

Understanding Module Diagrams

About Module Diagrams

About Module Diagram views

Module Diagrams - elements and notation

Module Diagrams - Layout elements

Using Module Diagrams to create application designs

Creating and opening Module Diagrams

Changing diagrams between data and display view

Creating module definitions

Creating and including module components

Creating and including List of Values components

Creating table usages

Creating item definitions

Creating action items

Creating key based links

Creating and maintaining item groups

Creating layout elements to define the display structure of a generated application

Creating module network links using Module Diagrams

Editing elements on a Module Diagram

Deleting elements from a diagram

Using Module Diagram features

Showing and hiding Module Diagram details

Positioning components on Module Diagrams

Hints and Tips for using Module Diagrams

Tips, tricks and shortcuts for Module Diagrams

Using drag and drop with Module Diagrams


About Module Diagrams

Related Topics

A Module Diagram is a graphical interface for recording client application designs in the Oracle Repository. You create Module Diagrams from the Design Editor, which is the Oracle Designer tool for performing application design.  About

Each Module Diagram is based on a module definition. Information that you record on a Module Diagram is stored in the repository and is used by the Generator products to generate client applications

Using Module Diagrams you can record the type of data that is to be used by a generated application and how that data is to be presented. These two categories of information are split into Data view and Display view on Module Diagrams.  About When creating your designs, you may identify areas, or components, that are common to more than one application. These reusable components can be designed separately from modules. They can then be included into the required modules. You can include reusable components on Module Diagrams, but you cannot edit them. Instead you must use the Reusable Component Editor.  About For information about the types of repository elements that can be represented on Module Diagrams, see Module Diagrams - elements and notation


About Module Diagram views

Related Topics

When designing an application, you can simplify the process by first identifying the data, e.g. tables and columns, to be used by the application, and then defining the general display structure of the application. Module Diagrams allow you to distinguish between these two activities by presenting two different diagram views. The diagram views are called Data view and Display view. The Module Diagram title bar identifies the view that is currently shown.

Module Diagrams - Data view

This view should be used to define the data that will be used by a generated application, e.g. specifying which tables are to be used by a generated application.

Example of the Module Diagram Data View

You can perform the following tasks when a Module Diagram is set to data view:

• Create and include module components (and sub-components for Forms)	How
• Create and include Lists of Values components	How
• Create table usages	How
• Create items	How
• Create links between components, i.e., key based links	How
• Create module network links	How
Module Diagrams - Display view

This view should be used to define information that affects the layout of a generated application, e.g., defining the groups in which interface elements are to be placed on an application.

Example of the Module Diagram Display View

You can perform the following tasks when a Module Diagram is set to Display view:

• Create and include module components	How
• Create and include Lists of Values components	How
• Create items	How
• Define item groups	How
• Create action items	How
• Define an application's display structure using layout elements, e.g. windows	How


Module Diagram - Data View

Related Topics

Module Diagrams show the following elements when set to Data view:

For information about each of these elements see:

Modules

Module components

Module sub-components

List of Values components

Table usages

Table usage links

Bound items

Unbound items

Module network links

Key based links


Module Diagram - Display View

Related Topics

Module Diagrams show the following elements when set to Display view:

For information about each of these elements see:

Modules

Module components

List of Values components

Bound items

Unbound items

Action Items

Item Groups

Window layout elements

Content Canvas layout elements

Stacked layout elements

Tab canvas page layout elements


Creating module definitions

Related Topics

Module definitions are used to record information for the purpose of generating client applications.  About

Note:	To generate an application, a module definition must use at least one module component.

Use any of the methods below to create a module definition:

• Create module definitions from existing applications, using design capture.	How
• Create default module definitions from functions recorded in the repository, using the Application Design Transformer.	How
• Create a module definition by creating a copy of an existing module definition of the same language.	How
• Create a module definition by creating a copy of an existing module definition of a different language.	How
• Create a module definition from scratch.	How
Note:	To create a module definition that can be used for generation, the module language must be set to one of the predefined languages defined in the System Folder. Therefore, the System Folder must be visible to your workarea when you create module definitions.


Creating module definitions from scratch

Related Topics

To rapidly create application designs in the repository, you capture designs from existing applications or transform functions from the analysis level into default module definitions. However, although methods exist for creating module definitions from existing sources, it is likely that you will also want to create new module definitions from scratch.

To create a new module and display it on a Module Diagram:

1.	From the Design Editor, choose File→New→Module Diagram.

2.	Choose the container in which the module and diagram will be created and click OK.

3.	From the New Diagram dialog box, click Create and enter values for the module type, short name, purpose and language properties.

Note:	To get help about each of the properties from the dialog box, click ? and then click on the appropriate entry box.

4.	(Optional)  Click Next to enter more information about the module.

The additional information that you can specify is determined by the module's Language and Type.

5.	Click Finish to save the module definition in the chosen container.

Note:	If you choose to define more details about the module, e.g., to create or include a component for the module, you must complete a further dialog box.

6.	From the New Diagram dialog box, click OK to open a diagram based on the new module.


Creating and including module components

Related Topics

Module components record details about the main parts of a generated application. For example, a module component represents a block on an Oracle Forms application. Each module component can be specific to one module (non-reusable), or used by many modules (reusable).  About

Note:	Utilities are available to help you switch module components and List of Values components between reusable and non-reusable.  About

Use the methods below to create module components and include them in module definitions:

• Create a new reusable module component that can be included in many modules	How
• Create a new module component that is non-reusable, i.e. specific to a single module definition	How
• Include an existing reusable module component in a module definition	How
• Create a module sub-component (For Form generation only)	How


Creating and including List of Values components
Creating and including List of Values (LOV) components

Related Topics

List of values (LOV) components allow you to model Lists of Values separately from other lookup data.  About

Note:	A non-reusable LOV component can be associated with many items in one module, however, this does not make it a reusable LOV component.

Use the methods below to create LOV components and include them in module definitions:

• Create a new reusable LOV component that can be included in many modules	How
• Create a new LOV component that is non-reusable, i.e. specific to a single module definition	How
• Include an existing LOV component in the module definition	How
• Associate a LOV component with an item	How
• Generate default Lists of Values	How


Creating table usages

Related Topics

A table usage records details about a database table that is used by a generated application. There are different types of table usages, such as base and lookup table usages.  About

Use the methods below to create table usages:

• Create a base table usage	How
• Create a lookup table usage	How
• Create a single row SQL aggregate table usage (For Report generation and Web PL/SQL generation only)	How
• Create a sub-query table usage (For Report generation and Web PL/SQL generation only)	How


Creating item definitions

Related Topics

Item definitions record details about the data that is to be processed by generated applications. Using item definition properties you can specify details, such as whether an item is to be displayed on a generated application. There are two types of item definitions: bound items whose values are derived from a single database column; and unbound items whose values cannot be mapped to a single a database column.  About

The Map Unbound Items utility enables you to change unbound items into bound items.  About

Use the methods below to create items:

• Create a bound item	How
• Create an unbound item	How
Note:	In addition to bound and unbound items, you can also create action items.  About


Creating action items

Related Topics

An action item is used to identify where a user is given the option to take a certain action when using a generated application. The representation of an action item in a generated application is typically a button or a menu option.  About

Use the methods below to create action items:

• Create a navigation action item	How
• Create a custom action item	How
• Create a generator action item (Visual Basic application generation only)	How


Defining the display structure of a generated application

Related Topics

The layout of a generated application can be quickly changed by changing the sequence of module components on the Display view of a Module Diagram. Diagram layout elements can be used to further refine the layout of a generated application. Once the layout elements have been created, their size and position can be edited.  About

Note:	Layout elements can be accessed from the Display view only of Module Diagrams.

•    Create a window layout element	How
•    Create a content canvas layout element (Oracle Forms modules only)	How
•    Create a stacked layout element (Oracle Forms modules and VB applications)	How
•    Create a tab canvas page layout element (Oracle Forms modules only)	How
•    Create an item group	How


Creating module networks for client applications

Related Topics

If a generated application is made up of several modules you may need to further define the display structure of the application by setting up a module network.  About

From the Design Editor you can define module networks for client applications in the following ways:

• From the Module branch on the Navigator, you can specify which existing modules are called from a chosen module, by expanding the branch for the chosen module and then creating Called Modules.	How
• From a Module Diagram, you can create module network links to define which existing modules call, and are called by, the module on which the diagram is based.	How
• From the Navigator Modules tab, Module Network node: Add existing modules in a module network. Create new modules and add them to a module network.	How How


Creating and opening Module Diagrams

Related Topics

Each Module Diagram is based on a module definition that is recorded in the repository. Changes that you make to a module definition using a Module Diagram are automatically made in the repository. For example, if you change a module's data usages the updates are made to the repository, regardless of whether you save the diagram. Therefore, in most cases you only need to create a diagram for the duration of the session (using File→New), and then close it without saving when you have finished.

The title bar of each Module Diagram displays the module name and identifies whether the diagram is set to Data view or Display view. In addition, saved diagrams display the diagram name and the container in which the diagram exists.

Note:	If the diagram is not saved to the repository, i.e., it does not have a name, the title bar displays "Untitled # ", where # is a number incremented by 1 each time a new diagram is created during the current session. You can either accept the default name when you save the diagram, or assign a more meaningful name.

To create a new Module Diagram use drag and drop or:

1.	From the Design Editor, choose File→New→Module Diagram.

2.	From the New Diagram dialog box, choose the container in which the diagram and module will be created.

3.	(Optional)  Create a new module definition by clicking Create and completing the Create Module dialog box.

4.	From the New Diagram dialog box, select the module definition on which the diagram is to be based.

To open an existing Module Diagram use drag and drop or:

1.	From the Design Editor, choose File→Open→Module Diagram.

2.	Select the required diagram and click OK.


Changing diagrams between data and display view

Related Topics

When you use a Module Diagram or a Reusable Component Diagram it displays one of two views, Data View or Display View. Each of these views allows you to perform specific tasks. The diagram title bar identifies whether Data or Display view is shown.

Note:	When bound and  unbound items are shown in Display view, by default they are represented by their prompt names rather than their item names.

To set the diagram view for a displayed diagram:

•	From the Design Editor, do one of the following:

−	If the diagram shows the Data view, click [image] to switch to Display view.

−	If the diagram shows the Display view, click [image] to switch to Data view.

To set which diagram view should be displayed by default:

•	From the Design Editor, choose Options→General Settings and set the "Default Diagram Display" to Data or Display.


Creating elements on a Module Diagram

Related Topics

Using a Module Diagram you can record designs for the applications that you want to generate.

Creating and including module components

Creating and including List of Values components

Creating table usages

Creating item definitions

Creating action items

Creating key based links

Creating and maintaining item groups

Creating layout elements to define the display structure of a generated application

Creating module network links using Module Diagrams


Creating non-reusable module components using Module Diagrams

Related Topics

When you record application designs in the repository, the main parts of the design are recorded as module components. This helps you to reuse common functionality. However, where an area of functionality is specific to a single application and cannot be reused, it should be recorded in the repository as a Specific, i.e., non-reusable, component.  About

To create a non-reusable module component:

1.	From the Design Editor, open a Module Diagram.  How

2.	Click [image].

3.	Position the cursor where you want to place the module component and click the mouse.

Note:	The cursor changes to a [image] if it is incorrectly positioned to create a module component. When the cursor is correctly positioned to place the component on the diagram, a snap line is displayed. Components are always placed below the snap line.

4.	Enter the name and title, then select the required language for the module component.

5.	Follow the wizard instructions to record the definition in the repository. To get help about a dialog box field click ? and then click on the field.


Creating reusable module components

Related Topics

As you record application designs in the repository, you may find that some areas of functionality are common to more than one application. Instead of creating multiple copies of the same module component, you can create a single reusable component that can be included into the appropriate module definitions.  About

To create a reusable module component:

1.	From the Design Editor Navigator, choose the Modules tab.

2.	In the Navigator, expand the container in which the component will be created and select the Reusable Module Components node.

3.	Click [image].

A property palette or property dialog box is displayed.  About

4.	To create the module component in the repository, do one of the following:

•	If a property dialog box is displayed, follow the instructions on the dialog box.

•	If a property palette is displayed, enter a name and choose the required language. Optionally, change the default settings for the displayed properties. Then click [image] to record the definition in the repository.

To edit reusable module components use the Reusable Component Editor. About


Including reusable module components using Module Diagrams

Related Topics

Reusable module components are defined independently of module definitions. Therefore, to make use of a reusable module component you must include it in a module definition.  About

Note:	Reusable components can be displayed, but not edited from Module Diagrams. Instead they can be edited from the Navigator, or from Reusable Component Diagrams.

To include a reusable module component use drag and drop or:

1.	From the Design Editor, open a Module Diagram.  How

2.	Click [image].

Note:	This button is available when reusable module components are visible to the current workarea.

3.	Position the cursor where you want to include the module component and click the mouse.

Note:	The cursor changes to a [image] if it is incorrectly positioned to create a module component. When the cursor is correctly positioned to place the component on the diagram, a snap line is displayed. Components are always placed below the snap line.

If the module component is to be a child of a component that already has children, you must follow a few simple rules when positioning the cursor.  About

4.	From the Include Module Component dialog box, select the module component that you want to include on the diagram and click OK.

Note:	If you want to create a copy of the reusable module component that is specific to the module, check the Make Private Copy box.

If there is a choice of links that can be created for the module component, the Create a Link dialog box is displayed, allowing you to choose the required link.
If there is only one link that can be implemented, it is created automatically.


Creating module sub-components

Related Topics

Before using Form Generator to generate a multi-region block, you must first create a repository module sub-component.  About

To create a module sub-component:

1.	From the Design Editor, do one of the following:

•	If the sub-component is to be created for a non-reusable module component, open a Module Diagram.  How

Note, the Module Diagram must contain a module component with which the sub-component can be associated. If a module component is not shown, create one.  How

•	If the sub-component is to be created for a reusable module component, open a Reusable Component Diagram.  How

2.	Set the diagram to the Data view.  How

3.	Click [image].

4.	Click the cursor below the module component for which the sub-component is to be created.

Note:	The cursor is displayed as [image] if it is not correctly positioned to create a sub-component. When the cursor is correctly positioned to place the component on the diagram, a snap line is displayed. Components are always placed below the snap line.

5.	Enter the name and title of the sub-component. The language defaults to that of the module component with which the sub-component is associated.

6.	Follow the wizard instructions to record the definition in the repository. To get help about a dialog box field click ? and then click on the field.


Creating non-reusable LOV components using Module Diagrams
Creating non-reusable List of Values components using Module Diagrams

Related Topics

When you record application designs in the repository, Lists of Values (LOVs) are stored as LOV components. Where an area of functionality is specific to a single application and cannot be reused, it should be recorded as a Specific, i.e., non-reusable, component.  About

You can associate a single LOV component with multiple items.

Note:	You can use the Generate default Lists of Values utility to automatically create LOV components.  How

To create a non-reusable LOV component:

1.	From the Design Editor, open a Module Diagram.  How

2.	Click [image].

3.	Do one of the following:

•	Create the LOV component and associate it with a bound or unbound item, by clicking the cursor on the name of the item with which the LOV component is to be associated.

•	Create the LOV component without associating it with an item, by clicking on the module definition diagram element.

Note:	The cursor changes to a [image] if it is incorrectly positioned to create a LOV component.

4.	Enter the name and title, then select the required language for the LOV component.

5.	Follow the wizard instructions to record the definition in the repository. To get help about a dialog box field click ? and then click on the field.

LOV components are displayed in alphabetical order after all module components on a Module Diagram.

When you have created a LOV component you can make use of it by including it in a module definition.  How


Creating reusable LOV components
Creating reusable List of Values components

Related Topics

As you record application designs in the repository, you may find that some areas of functionality are common to more than one application. Instead of creating multiple copies of the same LOV component, you can create a single reusable LOV component that can be included into the appropriate module definitions.  About

Note:	You can use the Generate default Lists of Values utility to automatically create LOV components.  How

To create a reusable LOV component:

1.	From the Design Editor Navigator choose the Modules tab.

2.	In the Navigator, expand the container in which you want to create the component then select the Reusable Lists of Values node.

3.	Click [image].

A property palette or property dialog box is displayed.  About

4.	To create the LOV component in the repository, do one of the following:

•	If a property dialog box is displayed, follow the instructions on the dialog box.

•	If a property palette is displayed, enter a name. Optionally, change the default settings for the displayed properties. Then click [image] to record the definition in the repository.

When you have created a LOV component you can make use of it by including it in a module definition.  How

To edit reusable LOV components use the Reusable Component Editor. About


Including reusable LOV components using Module Diagrams
Including List of Values components using Module Diagrams

Related Topics

Both reusable and non-reusable (i.e., specific to the module) List of Values (LOV) components can be included in a module definition.  About

A List of Values component can be included into the same module more than once.

To include a LOV component use drag and drop or:

1.	From the Design Editor, open a Module Diagram.  How

2.	Click [image].

Note:	This button is not available if there are no reusable LOV components, and no non-reusable LOV components for the module, in the repository.

3.	Do one of the following:

•	Include the LOV component and associate it with a bound or unbound item in a single operation, by clicking the cursor on the name of the item with which the LOV component is to be associated.

•	Include the LOV component without associating it with an item, by clicking on the module definition diagram element. You can associate the LOV component with an item later.  How

Note:	The cursor changes to a [image] if it is incorrectly positioned to include a LOV component.

4.	From the Include List of Values dialog box, select the LOV component that you want to include on the diagram and click OK.

Note:	If you want to create a copy of the reusable LOV component that is specific to the module, check the Make Private Copy box.

LOV components are displayed in alphabetical order after all module components on a Module Diagram.


Associating List of Values components with items

Related Topics

List of values components can be associated with bound and unbound items. If when you create or include a LOV component the item with which it should be associated does not exist, you can associate the LOV component with the item at a later date.  About

On Module Diagrams, a LOV inclusion diagram element is displayed to the left of each LOV component. If the LOV component is not associated with an item, the label <Unassociated> is displayed on the LOV inclusion. If the LOV component is associated with an item, the name of the item is shown on the LOV inclusion.

To associate a LOV component with an item:

1.	From the Design Editor, open a Module Diagram.  How

2.	Double click on the LOV inclusion (displayed to the left of the LOV component) that you want to associate with an item.

Note:	If the LOV inclusion is <Unassociated> a new association will be created. If the LOV inclusion is already associated with an item, i.e., it has a name, an additional association to a different item will be created.

A property palette or property dialog box is displayed.  About

3.	To associate the LOV component with an item, do one of the following:

•	If a property dialog box is displayed, click the Usage tab. Choose the item with which the LOV component is to be associated and optionally change other settings on the dialog box page. Click Finish to record the association in the repository.

•	If a property palette is displayed, use the Item property to choose the item with which the LOV component is to be associated. Optionally change the settings of the Filter Before Display property and the Used For property. Then click [image] to record the association in the repository.


Creating base table usages using diagrams

Related Topics

Base table usages can be created for module components, LOV components and sub-components.  About

To create a base table usage use drag and drop or:

1.	From the Design Editor, do one of the following:

•	If the table usage is to be created for a non-reusable component, open a Module Diagram.  How

•	If the table usage is to be created for a reusable component, open a Reusable Component Diagram.  How

2.	Set the diagram to the Data view.  How

3.	Click [image].

4.	Move the cursor over the component for which the usage is to be created.

Note:	The cursor is displayed as [image] if it is not correctly positioned to create a table usage.

5.	When the cursor is in the required position, click the mouse button.

A dialog box listing the tables that exist for the application system is displayed.

Note:	A component can contain one base table usage only. If the component already contains a table usage, a property palette or dialog box is displayed for you to create a different type of table usage.

6.	Choose the table that is to be referenced by the base table usage.


Creating lookup table usages using diagrams

Related Topics

A lookup table usage, provides lookup, or additional information to a base table usage or another lookup table usage. Before you can create a lookup table usage, a base table usage must already exist in the component.  About

To create a lookup table usage use drag and drop or:

1.	From the Design Editor, do one of the following:

•	If the table usage is to be created for a non-reusable component, open a Module Diagram.  How

•	If the table usage is to be created for a reusable component, open a Reusable Component Diagram.  How

2.	Set the diagram to the Data view.  How

3.	Click [image].

4.	Position the cursor over, or to the right of, the table usage for which the lookup is to be created.

Note:	The cursor is displayed as [image] if it is not correctly positioned to create a table usage.

When the cursor is correctly positioned to create a lookup, a snap line is displayed as an indicator of where the lookup table usage will be created. Lookup table usages are always created to the right of the snap line.

Example

5.	When the cursor is in the required position, click the mouse button.

If the Design Editor is set to use property palettes, a dialog box listing the available tables is displayed. Otherwise a property dialog is displayed.  About

6.	Do one of the following to record the lookup table usage definition in the repository:

•	If a property dialog is displayed, follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a list box is displayed, choose the required table and click OK. Enter values for all mandatory properties (colored red by default) and optionally change any of the default property values. Click [image] to save the changes.


Creating single row SQL aggregate table usages using diagrams

Related Topics

A single row SQL aggregate table usage is used to define a SELECT statement that returns a single result for every row queried in the master (base) table. This type of table usage is used for Report generation and Web PL/SQL application generation.  About

To create a single row SQL aggregate table usage use drag and drop or:

1.	From the Design Editor, do one of the following:

•	If the table usage is to be created for a non-reusable component, open a Module Diagram.  How

•	If the table usage is to be created for a reusable component, open a Reusable Component Diagram.  How

2.	Set the diagram to the Data view.  How

3.	Click [image].

4.	Move the cursor over, or below, the table usage for which the usage is to be created.

Note:	The cursor is displayed as [image] if it is not correctly positioned to create a table usage.

When the cursor is correctly positioned to create a single row SQL aggregate usage, a snap line is displayed as an indicator of where the table usage will be created. Single row SQL aggregate usages are always created below the snap line.

Example

5.	When the cursor is in the required position, click the mouse button.

If the Design Editor is set to use property palettes, a dialog box listing the available tables is displayed. Otherwise a property dialog is displayed.  About

6.	Do one of the following to record the single row SQL aggregate table usage definition in the repository:

•	If a property dialog is displayed, choose to create a Single Row Summary, then click Next and choose the table on which the SQL aggregate summary is to be based. Optionally, click Next to enter further details. To get help about a dialog box field click ? and then click on the field.

•	If a list box is displayed, choose the required table and click OK. A further dialog box is displayed from which you must choose the Single Row Summary Aggregate option. Click OK to display a Property Palette where you can specify the WHERE clause of the Query and optionally change any of the default property values. Click [image] to save the changes.


Creating sub-query table usages using diagrams

Related Topics

A sub-query table usage is used to define a SELECT statement that is nested within another SELECT statement. This type of table usage is used for Report generation and Web PL/SQL generation.  About

To create a sub-query table usage use drag and drop or:

1.	From the Design Editor, do one of the following:

•	If the table usage is to be created for a non-reusable component, open a Module Diagram.  How

•	If the table usage is to be created for a reusable component, open a Reusable Component Diagram.  How

2.	Set the diagram to the Data view.  How

3.	Click [image].

4.	Move the cursor over the component for which the usage is to be created.

Note:	The cursor is displayed as [image] if it is not correctly positioned to create a table usage.

When the cursor is correctly positioned to create a sub-query usage a snap line is displayed as an indicator of where the table usage will be created. Sub-query usages are always created below the snap line.

Example

5.	When the cursor is in the required position, click the mouse button.

If the Design Editor is set to use property palettes, a dialog box listing the available tables is displayed. Otherwise a property dialog is displayed.  About

6.	Do one of the following to record the sub query table usage definition in the repository:

•	If a property dialog is displayed, choose to create a Subquery, then click Next and choose the table on which the Subquery is to be based. Optionally, click Next to enter further details. To get help about a dialog box field click ? and then click on the field.

•	If a list box is displayed, choose the required table and click OK. A further dialog box is displayed from which you must choose the Subquery option. Click OK to display a Property Palette where you can specify the WHERE clause of the Query and optionally change any of the default property values. Click [image] to save the changes.


Creating bound items using diagrams

Related Topics

Bound items identify which database columns are to be used by a generated application.  About

To create a bound item use drag and drop or:

1.	From the Design Editor, do one of the following:

•	If the bound item is to be created for a non-reusable component, open a Module diagram.  How

•	If the bound item is to be created for a reusable component, open a Reusable Component Diagram.  How

2.	Set the diagram to the Data view.  How

3.	Click [image].

4.	Move the cursor over the table usage for which you want to create a bound item and click the mouse.

A snap line is displayed on the component as an indicator of where the item will be created. Bound items are always created below the snap line.

If the Design Editor is set to use property palettes, a dialog box listing the available columns is displayed. Otherwise a property dialog is displayed.  About

5.	Do one of the following:

•	If a property dialog is displayed, follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a list box is displayed, choose the required column and click OK.


Creating unbound items using diagrams

Related Topics

Unbound items provide information that cannot be mapped to  a single database column column, to a generated application. For example, totals and summary fields can be implemented using unbound items.  About

To create an unbound item:

1.	From the Design Editor, do one of the following:

•	If the unbound item is to be created for a non-reusable component, open a Module Diagram.  How

•	If the unbound item is to be created for a reusable component, open a Reusable Component Diagram.  How

2.	Click [image].

3.	Move the cursor over the component for which the item is to be created.

Note:	If the diagram is set to Data view, ensure that the cursor is not positioned over a table usage, as this will cause a bound item to be created.

A snap line is displayed on the component as an indicator of where the item will be created. Unbound items are always created below the snap line.

4.	When the cursor is in the required position, click the mouse button.

A property palette or property dialog box is displayed.  About

5.	Do one of the following:

•	If a property dialog is displayed, follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a property palette is displayed, enter the name and select the Unbound Type. Optionally, enter or change the other property values. Click [image] to save the changes.


Creating custom action items using Module Diagrams

Related Topics

Custom action items provide the capability to execute a specific piece of user defined code from a generated application.  About

To create a custom action item:

1.	From the Design Editor, open a Module Diagram.  How

2.	Set the diagram to the Display view.  How

3.	Click [image].

4.	Move the cursor over the module component, sub-component or window for which the item is to be created.

Note:	The cursor is displayed as [image] if it is not correctly positioned to create an action item. A snap line is displayed on the module component as an indicator of where the item will be created. Action items are always created below the snap line.

5.	When the cursor is in the required position, click the mouse button.

6.	From the list of action item types, choose Custom action item.

Note:	The list of action item types is displayed on either a property dialog box or an interim list box from which a property palette is displayed.  About

7.	Do one of the following:

•	If a property dialog is displayed, follow the instructions on the property dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a property palette is displayed, enter the action item name. Optionally enter or change the other property values. Click [image] to save the changes.


Creating generator action items using Module Diagrams

Related Topics

Generator action items provide the capability to execute a piece of standard generator functionality, e.g., Commit or Next Block. These types of action items are used by generated Visual Basic applications only.  About

To create a generator action item:

1.	From the Design Editor, open a Module Diagram.  How

2.	Set the diagram to the Display view.  How

3.	Click [image].

4.	Move the cursor over the module component or sub-component for which the item is to be created.

Note:	The cursor is displayed as [image] if it is not correctly positioned to create an action item. A snap line is displayed on the module component as an indicator of where the item will be created. Action items are always created below the snap line.

5.	When the cursor is in the required position, click the mouse button.

If the Design Editor is set to use property palettes, a dialog box listing the types of action items that can be created is displayed. Otherwise a property dialog is displayed.  About

6.	From the list of action item types, choose Generator action item.

Note:	The list of action item types is displayed on either a property dialog box or an interim list box from which a property palette is displayed.

7.	Do one of the following:

•	If a property dialog is displayed, follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a property palette is displayed, enter an action item name. Optionally, specify the Generator Item Type and any other property values. Click [image] to save the changes.


Creating navigation action items using Module Diagrams

Related Topics

Navigation action items provide the capability to navigate to a specific module component in the same module or to a different module. When navigating to a different module, it is not possible to navigate to a specific module component within that module.  About

To create a navigation action item:

1.	From the Design Editor, open a Module Diagram.  How

2.	Set the diagram to the Display view.  How

3.	Click [image].

4.	Move the cursor over the module component, sub-component or window for which the item is to be created.

Note:	The cursor is displayed as [image] if it is not correctly positioned to create an action item. A snap line is displayed on the module component as an indicator of where the item will be created. Action items are always created below the snap line.

5.	When the cursor is in the required position, click the mouse button.

6.	From the list of action item types, choose Navigation action item.

Note:	The list of action item types is displayed on either a property dialog box or an interim list box from which a property palette is displayed.  About

7.	Do one of the following:

•	If a property dialog is displayed, follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a property palette is displayed, enter the action item name. Optionally, enter or change any of the other property values. Click [image] to save the changes.


Creating key based links using Module Diagrams

Related Topics

A key based link represents a link between table usages in different module components. There are several types of key based links, e.g., master-detail links.  About

Note:	You can use the Generate Default Links utility to automatically create key based links. How

To create a key based link:

1.	From the Design Editor, open a Module diagram.  How

2.	Set the diagram to the Data view.  How

3.	Click [image].

4.	Click on one of the module component table usages that are to be part of the link.

5.	Do one of the following to complete the link:

•	Create a master-detail link or a same table link, by clicking on a table usage in a different module component.

•	Create a different module link, by clicking on the space surrounding the module diagram element. A dialog box is then displayed, for you to choose the required module and table usage.


Creating module network links using Module Diagrams

Related Topics

Module networks describe relationships between modules. From a Module Diagram, you can identify the modules that call, and are called by, the module on which the Module Diagram is based.  About

Note:	Alternatively, use the Module Network node on the Navigator Modules tab for defining module networks.  About

To create a module network link:

1.	From the Design Editor, open a Module Diagram.  How

2.	Click [image].

3.	Do one of the following to define a module network for the module represented by the Module Diagram:

•	To define one or more modules that are to call the module, click on the space to the left of the module definition diagram element.

•	To define one or modules that are to be called by the module, click on the space to the right of the module definition.

A dialog box is displayed, for you to choose a module.

4.	Choose a module definition to complete the module network link.


Creating item groups using diagrams

Related Topics

An item group is a collection of items that have an associated prompt, which is treated as a single layout element on a generated application. Item groups can be created for module components and module sub-components.  About

To create an item group:

1.	From the Design Editor, do one of the following:

•	If the item group is to be created for a non-reusable module component, open a Module Diagram.  How

•	If the item group is to be created for a reusable module component, open a Reusable Component Diagram.  How

2.	Set the diagram to Display view.  How

3.	From the diagram, select one or more bound items, unbound items or item groups. The selected items must all exist in a single module component.

Note:	Action items cannot be placed in item groups.

4.	Click [image].

A property palette or a property dialog box is displayed.  About

5.	Do one of the following:

•	If the Design Editor is set to use property dialog boxes, a dialog box is displayed. Follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If the Design Editor is set to use property palettes, the item group is created immediately, with a default name. A property palette is displayed for you to optionally change the item group's properties.


Creating window layout elements using Module Diagrams

Related Topics

Window layout elements are used to specify the general display structure of a generated application. You can create window layout elements from the Design Editor using either the Navigator or Module Diagrams. On Module Diagrams these elements can be viewed and defined from the Display view only.  About

To create a new window layout element on a Module Diagram:

1.	From the Design Editor, open a Module Diagram.  How

2.	Set the diagram to Display view.  How

3.	Click [image].

4.	Hold down the mouse button and drag the rubberband box to create a boundary around the module components and sub-components that are to be included in the window layout diagram element.

If the module components and sub-components are already in a window element, they are removed from that window element and placed in the new one.

Note:	A window element can be drawn directly on the Module Diagram element, without including any components.

To combine the contents of two windows:

•	Resize a window layout element to encompass another window element. The contents of both windows are placed into the window that you resized. The empty window element remains on the diagram.


Creating content canvas layout elements using Module Diagrams

Related Topics

Content canvas layout elements are a graphical way of identifying how data is split into content canvases on a generated form. On Module Diagrams these layout elements can be defined and viewed from the Display view only.  About

Note:	You can specify a size and position for the generated canvas using a property palette or a property dialog box.  About

To create a content canvas layout element:

1.	From the Design Editor, open a Module Diagram.  How

2.	Set the diagram to Display view.  How

3.	Click [image].

4.	Hold down the mouse button and drag the rubberband box to create a boundary around the module components and sub-components that are to be included in the content canvas. At least one module component must be included in the selection.

If the module components and sub-components are already in a content canvas element, they are removed from that element and placed in the new one.

To combine contents of two canvases:

•	Resize a content canvas layout element to encompass another content canvas element. The contents of both elements are placed into the content canvas element  that you resized. The empty content canvas element remains on the diagram.


Creating stacked layout elements using Module Diagrams

Related Topics

Stacked layout elements are a graphical way of identifying how data is displayed on stacked canvases and zones on generated applications. On Module Diagrams these layout elements can be defined and viewed from the Display view only.  About

Note:	You can specify a size and position for a stacked element using a property palette or a property dialog box.  About

To create a stacked layout element:

1.	From the Design Editor, open a Module Diagram.  How

2.	Set the diagram to the Display view.  How

3.	Click [image].

4.	Hold down the mouse button and drag the rubberband box to create a boundary around the module components and sub-components that are to be included in the stacked layout element. At least one module component must be included in the selection.

If the module components and sub-components are already in a stacked element, they are removed from that element and placed in the new one.


Creating tab canvas page layout elements using Module Diagrams

Related Topics

Tab canvas page layout elements are a graphical way of showing how Form Generator will place blocks in a generated form on different tab canvas pages. On Module Diagrams these layout elements can be defined and viewed from the Display view only.  About

Note:	You can specify a size and position for the generated tab canvas page using a property palette or a property dialog box.  About

To create a tab canvas page layout element:

1.	From the Design Editor, open a Module Diagram.  How

2.	Set the diagram to Display view.  How

3.	Click [image].

4.	Hold down the mouse button and drag the rubberband box to create a boundary around the module components and sub-components that are to be included on the tab canvas page. At least one component must be included in the selection. If more than one component is to be used, the components must be displayed within the same window layout element.


Creating domain key constraints

Related Topics

Domain key constraints allow generated applications to access a specific range of domain values from a table containing multiple domains.  About

To create a domain key constraint:

1.	From the Design Editor Navigator, choose the Server Model tab.

2.	In the Navigator, expand the container node in which you want to create the constraint.

3.	Expand the relational table, view or materialized view node for which you want to create the domain key constraint, then select the Domain Key constraints node.

4.	Click [image].

If the Design Editor is set to use property palettes, a dialog box listing the available tables, views and materialized is displayed. Otherwise a property dialog is displayed.  About

5.	To create the constraint in the repository, do one of the following:

•	If a property dialog box is displayed, choose the join table (the table containing the domain values) and specify the domain key constraint name. Optionally, click Next to enter further details or click Finish to create the constraint with minimal details. To get help about a dialog box field click ? and then click on the field.

•	If a list box is displayed, choose the required table, view or materialized and click OK. Default values are displayed for all mandatory properties (colored red by default). Optionally change any of the default property values, then click [image] to save the changes.


Editing elements on a Module Diagram

Related Topics

Module Diagrams are designed for the purpose of defining module definitions. Most of the tasks that you can perform using a Module Diagram can also be performed using the Navigator. However, these tasks can usually be performed more easily using the graphical interface provided by the diagram.

Note:	The only diagram elements that you can resize on a Module Diagram are layout elements.  About

Each of the definitions that you record in the Oracle Repository has a set of associated properties. For example, module definitions have properties to identify their names, languages and types. You can edit the properties of a definition when the definition is displayed on a diagram.

Reusable components cannot be edited from Module Diagrams. Instead they must be edited using Reusable Component Diagrams.

To edit an element's properties from a diagram:

1.	From the diagram, double click on the element for which you want to change property values.

A property palette or property dialog box is displayed.  About

2.	Do one of the following:

•	If a property dialog is displayed, follow the instructions on the dialog box. To get help about a dialog box field click ? and then click on the field.

•	If a property palette is displayed, enter values for all mandatory properties (colored red by default) and optionally change any of the default property values. Click [image] to save the changes.


Positioning components on Module Diagrams

Related Topics

When you create or include module components on a Module Diagram the position of the snap line on the diagram identifies where the component will be placed in relation to other diagram elements. You can easily position a new component below a component that does not have links to other components. However, if you want a component to be linked to a component that already has child components, you must follow a few simple rules.

The diagram below illustrates how a component can be created as a child of another component. The diagram assumes that all of the components (numbered 1 to 5) contain base table usages, and that key constraints exist between those usages and the base table usage in the new component.

Snap line	How the potential key based links are determined
a	If the snap line is positioned here, the dialog box lists key constraints that exist between the base table in the new component and the base tables in components 1 and 2. You can choose to create the new component either as the last child of component 1, or as the first child of component 2.
b	If the snap line is positioned here, the dialog box lists key constraints that exist between the base table in the new component and the base tables in components 2 and 3. You can choose to create the new component either as a child of component 3 or as a child of component 2, that is sequenced after component 3.
c	If the snap line is positioned here, the dialog box lists key constraints that exist between the base table in the new component and the base tables in components 2 or 4. You can choose to create the new component either as a child of component 4 or as a child of component 2, that is sequenced after component 4.
d	If the snap line is positioned here, the dialog box lists key constraints that exist between the base table in the new component and the base tables in components 1, 2 or 5. You can choose to create the new component: - as a child of component 5. - as a child of component 2, sequenced after component 5. - as a child of component 1, sequenced after component 2.


Deleting elements from a diagram

Related Topics

Each element on a Module Diagram or Reusable Component Diagram represents an element in the Oracle Repository. Therefore, if you delete an element from a diagram the underlying element is removed from the workarea and placed in the wastebasket. Depending on the underlying constraints in the repository, deleting an element may cause dependent elements also to be placed in the wastebasket. For example, deleting a module component also deletes its associated table usages.

Note:	You can retrieve deleted elements from the wastebasket using the Repository Object Navigator.

To delete an element from a diagram:

1.	From the diagram, select one or more elements that you want to delete.

Note:	If a Module Diagram is not displayed, you can delete the element from the Navigator.

2.	Choose Edit→Delete from Repository.

3.	Optionally, remove elements from the list by selecting them and clicking Remove From List.

4.	Click Delete to delete all of the elements listed in the dialog box.


Creating and maintaining item groups

Related Topics

Item groups record how interface elements are to be grouped on a generated application. Module Diagrams and Reusable Component Diagrams enable you to clearly see how groups of items will be displayed on generated applications. Item group information can be seen on Module Diagrams and Reusable Component Diagrams when they are set to the Display view only.

Creating item groups using diagrams

Removing Items from a group on a diagram

Selecting items in the same group on a diagram


Removing items from a group on a diagram

Related Topics

You can remove one or more items from the item groups to which they belong using a Module Diagram, a Reusable Component Diagram or the Navigator. Diagrams clearly show the item groups that are defined for a module component and the items within those groups.

To remove items from an item group use drag and drop or:

1.	From the Design Editor, do one of the following:

•	If the item group is in a non-reusable component, open a Module Diagram.  How

•	If the item group is in a reusable component, open a Reusable Component Diagram.  How

2.	Set the diagram to Display view.  How

3.	Select the items that you want to remove from the item group.

You can select items on different module components and sub-components.

Tip:	You can select all items in the same group by first selecting an item in the required group and then choosing Edit→Select Same Group.

4.	Click [image].


Selecting items in the same group on a diagram

Related Topics

You can select all members of an item group in one action, instead of individually clicking on each member of that item group. This feature is particularly useful when a Module Diagram or Reusable Component Diagram is set to Data View because although items may be grouped together for display purposes they may not be derived from the same table usages.

To select all items in an item group:

1.	From the Design Editor, do one of the following:

•	If the item group is in a non-reusable component, open a Module Diagram.  How

•	If the item group is in a reusable component, open a Reusable Component Diagram.  How

2.	Select one of the members of the item group for which you want to select all members.

3.	Choose Edit→Select Same Group.


Showing and hiding Module Diagram details

Related Topics

You can show or hide information for links and items on Module Diagrams. For example, you may choose to simplify the appearance of a diagram, by hiding all links to other modules, i.e. module networks.

To show/hide Module Diagram details:

1.	From the Design Editor, open a Module Diagram.  How

2.	Choose Options→Show/Hide.

3.	From the Show/Hide Preferences dialog box, set the options that you require.

For a description of each of the dialog box options, click Help on the dialog box.

4.	(Optional)  Click Save to keep the settings for future invocations of the Design Editor.


Module Diagrams - elements and notation

Related Topics

Module Diagrams can be set to one of two views, Data or Display. The conventions used for each of the Module Diagram views are shown in the examples below.

Note:	The diagram title bar identifies whether Data view or Display view is shown. It also identifies the container in which the diagram exists.

Both views are based on a single module definition (colored dark green by default). For information about Module Diagram views and how to use them, see About Module Diagram views.

For information about each of the elements that can be shown on Module Diagrams see:

Both views	Data view only	Display view only
Modules	Key based links	Item Groups
LOV components	Module network links	Window layout elements
LOV inclusions	Table usage links	Content canvas layout elements
Module components	Table usages	Stacked layout elements
Module sub-components (Forms only)		Tab canvas page layout elements
Bound items		Action Items
Unbound items


Module Diagrams - Layout elements

Related Topics

The order in which module components are positioned on a Module Diagram affects the display structure of the application that is generated from the module definition. In addition, layout elements and item groups can be used to further define the display structure of the generated application.

The types of layout elements that can be shown on a Module Diagram are:

•	Windows

•	Content canvas elements

•	Stacked elements

•	Tab canvas page layout elements

The following table shows the layout elements that the generators use, and what they represent in a generated application. For example, a stacked layout element represents a stacked zone in a Visual Basic application.

	Window Layout Element	Content canvas  Layout Element	Stacked  Layout Element	Tab Canvas Page  Layout Element
Form	Window	Content Canvas	Stacked Canvas	Tab Canvas/Page
Report	New Report	Not used	Not used	Not used
Visual Basic application	Form	Not used	Stacked Zone	Not used
Web PL/SQL application	Web Page	Not Used	Not Used	Not Used


Module Diagrams - Content canvas layout elements

Related Topics

Content canvas layout elements are used to place one or more blocks in a specified content canvas on a generated form. Each content canvas layout element always exists within a window layout element. You can define more than one content canvas within a window.

Note:	This type of layout element is valid for form generation only.

Content canvas layout elements are represented on Module Diagrams as red boxes drawn around one or more module components or sub-components. They can be created and viewed from the Display view only.

Table usages that exist within the same content canvas layout element on a Module Diagram exist within the same content canvas on forms that are generated from that diagram.


Module Diagrams - Stacked layout elements

Related Topics

Stacked layout elements are represented on Module Diagrams as blue boxes drawn around one or more module components or sub-components. They can be created and viewed from the Display view of Module Diagrams only. The following table shows which generators use stacked layout elements and what they represent on generated applications:

Generators	What gets generated...
Form Generator	A stacked canvas on a form.
Visual Basic Generator	A stacked zone on a VB application.
The Generators can determine the number of canvases/zones, and their contents, that will exist in a generated application from the stacked layout elements that have been defined for a module.


Module Diagrams - Tab canvas page layout elements

Related Topics

Tab canvas page layout elements are used to place blocks in a generated form. Each tab canvas page layout element always exists within a content canvas layout element.

Note:	This type of layout element is valid for form generation only.

Tab canvas page layout elements are represented on Module Diagrams as black boxes drawn around one or more module components or sub-components. They can be created and viewed from the Display view only.


Hints and tips for Module Diagrams and Reusable Component Diagrams

Related Topics

This topic lists the tips and shortcuts that are available when you use Module Diagrams and Reusable Component Diagrams.

Module Diagrams and Reusable Component Diagrams

•	Open diagrams by dragging repository elements from the Navigator onto the work surface. For example, open a Module Diagram, by dragging the module definition onto the work surface, and open a Reusable Component Diagram, by dragging a component definition onto the work surface.

For information about other drag and drop operations on diagrams, see Using drag and drop.

•	To identify the name of a diagram element when the diagram is too small to read the text, position the cursor over the element. The name and type of the diagram element are displayed in a popup window.

•	Display additional property information about diagram elements, by choosing Options→Customize. For example, you may want to display the width and height of window elements on a Module Diagram.

•	If you find it difficult to select a link on a diagram, move the cursor over the link until the popup tooltip is displayed. Then click the mouse button to select the element.

•	Use drag and drop to create and resequence diagram elements.

For more  information, see Using drag and drop.

•	Use the Default Links utility to automatically generate default links for a module definition.  How

•	Differentiate between different element types by using different colors to represent the component types on a diagram. To change the colors choose Options→Color/Font/Style.

•	To quickly navigate from a bound or unbound item to its associated List of Values component, position the cursor over the LOV name in the module component and click the right mouse button, then choose the Navigate to List of Values option. Similarly, to navigate from a List of Values component to the item with which the LOV is associated, position the cursor over the List of Values inclusion element and from the right mouse button menu, choose the Navigate to Item option.


Using drag and drop with Module Diagrams

Related Topics

You can perform many of the tasks associated with Module Diagrams and Reusable Component Diagrams, by dragging and dropping repository elements instead of using menus and buttons.

Using drag and drop to create and open diagrams

Source Object (Navigator)	Target	Meaning
Module	Design Editor work surface	Opens a new untitled Module Diagram based on the module
Module Diagram	Design Editor work surface	Opens a previously saved Module diagram.
Reusable module component or LOV component	Design Editor work surface	Opens a new untitled Reusable Component Diagram based on the component
Reusable Component Diagram	Design Editor work surface	Opens a previously saved Reusable Component diagram.
Using drag and drop from the Navigator onto a diagram

Tip: 	From the Design Editor, open a Module Diagram by dragging a module definition from the Navigator on to the work surface.

Source Object (Navigator)	Target Object	Meaning
Reusable module component	Base module on Module Diagram	Includes a reusable module component in the module
LOV component	Base module on Module Diagram	Includes a LOV component, but does not associate it with an item
LOV component	Item	Includes LOV component and associates it with an item
Table, view or materialized view	Base module on Module Diagram	Creates a module component and a table usage
	Module component, sub-component or LOV component	Creates a table usage
Column	Table usage	Creates a bound item
Tip:	You can also drag table, view, materialized view and column definitions from Server Model Diagrams onto Module Diagrams.

Using drag and drop within a diagram

The main purpose of drag and drop on Module Diagrams is to simplify sequencing, copying and parenting of items. If you hold down the Control key when the element is dropped on the diagram, then a copy will be performed rather than a move. The table below lists some examples of how to use drag and drop within a Module Diagram.

Source Object	Target Object	Meaning
Item	Item	Resequence Items
	Item group	Add Item to item group (with sequence)
	Same module component	Resequence Item within module component
	Outside item group	Removes item from group
Item group	Item group	Create nested item groups
Table usage	Within same module component	Creates one of the following table usages: lookup, sub-query, single row SQL aggregate or base table usage in different module component
	Outside current table usage	Changes lookups into master-detail, master-detail into lookups, etc.
Module component	Module component	Resequences module components within the module.
Module component	Window	Moves components between windows


Reusable Component Diagrams
About Reusable Component Diagrams

Understanding Reusable Component Diagrams

About the Reusable Component Graphical Editor

About reusable component diagram views

Reusable component diagrams - elements and notation

Using Reusable Component Diagrams to create repository components

Opening reusable component diagrams

Changing diagrams between data and display view

Creating table usages

Creating item definitions

Creating and maintaining item groups

Deleting elements from a diagram

Hints and Tips for using Reusable Component Diagrams

Tips, tricks and shortcuts for Reusable Component Diagrams


About the Reusable Component Graphical Editor

Related Topics

The Reusable Component Graphical Editor is a Design Editor tool for designing reusable blocks, or components. These reusable components can be included in module definitions, which in turn can be used to generate client applications. Reusable Component Diagrams are provided for you to graphically specify details about reusable components. Each Reusable Component Diagram represents either a List of values component or a module component. Module components may optionally have links to sub-components.

The picture below illustrates how a reusable module component that is represented by a Reusable Component Diagram can also be included in a Module Diagram.

Note:	You cannot use the Reusable Component Graphical Editor to edit non-reusable components, i.e., those that are specific to a single module. Instead, non-reusable components can be edited in the context of a module, using a Module Diagram.  About

Using Reusable Component Diagrams you can record which data is to be used by part of a generated application, and how that data is to be presented. These two categories of information are split into two different diagram views. The views are referred to as Data view and Display view. The diagram title bar always indicates which view is shown.  About

The Reusable Component Editor is an editing tool only, i.e., it cannot be used to create components. Existing reusable components can be opened as diagrams and edited. However, these diagrams simply represent a view of the data held in the Oracle Repository and cannot be saved as named diagrams.

All of the information that you can specify using the Reusable Component Editor can be entered directly from the Navigator, without the need for a diagram. However, in most cases it is easier to work with a component definition on a diagram rather than the Navigator. If a reusable component is updated, any diagrams that show that component are refreshed to reflect the changes.

In addition to defining the data and display requirements for a component, you can use Reusable Component Diagrams to define application logic and text against a component's elements.


About Reusable Component Diagram views

Related Topics

When you define a reusable component definition for application generation, you can simplify the process by first identifying which data, e.g., tables, are to be used by the component, and then defining the display structure of the component. Reusable Component Diagrams allow you to distinguish between these two activities by presenting two different diagram views called Data view and Display view. The Reusable Component Diagram title bar identifies the view that is currently shown.

Data view

This view should be used to define and view the data that will be used by a generated application, e.g., specifying which tables are to be used by a generated application.

Example of Reusable Component Diagram - Data view

You can perform the following tasks when a Reusable Component Diagram is set to Data view:

• Create table usages	How
• Create items	How
Display view

This view should be used to define and view information that affects the layout of a component. For example, this view allows you to define how items should be grouped.

Example of Reusable Component Diagram - Display view

You can perform the following tasks when a Reusable Component Diagram is set to Display view:

• Create unbound items	How
• Create item groups	How


Reusable Component Diagram - Data view

Reusable Component Diagrams show the following elements when set to Data view:

For information about each of these elements see:

Lists of Values components

Module components

Module sub-components

Table usages

Table usage links

Bound items

Unbound items


Reusable Component Diagram - Display view

Reusable Component Diagrams show the following elements when set to Display view:

For information about each of these elements see:

Lists of Values components

Module components

Module sub-components

Item Groups

Bound items

Unbound items


Opening Reusable Component Diagrams

Related Topics

When you define modules for application generation, it is likely that some of the modules will have common functionality. You can graphically specify the areas of common functionality using Reusable Component Diagrams.  About

To open a Reusable Component Diagram use drag and drop or:

1.	From the Modules tab on the Navigator, select the reusable module component or LOV component that you want to edit.

Note:	The Reusable Component Editor cannot be used to create components. Therefore, if a reusable component does not exist already you must create one.  How

2.	Choose Tools→Reusable Component Graphical Editor.


Creating elements on Reusable Component Diagrams

Related Topics

Reusable Component Diagrams allow you to work with a subset of the diagram elements that can be accessed on a Module Diagram. Using a Reusable Component Diagram you can create the following repository elements for a module component, sub-component or List of values component.

Creating table usages

Creating item definitions

Creating and maintaining item groups


Reusable Component Diagrams - elements and notation

Related Topics

Reusable Component Diagrams can be set to one of two views, Data or Display. The conventions used to define module components for each view are shown in the examples below. Both views are based on a single module component definition (colored gray by default).

Note:	The Reusable Component Diagram title bar identifies whether Data view or Display view is shown.

Example Reusable Component Diagram - Data view

Example Reusable Component Diagram - Display view

For information about Reusable Component Diagram views and how to use them, see About Reusable Component Diagram views.


Generating default links during application design

Related Topics

You can automatically generate links between the table usages in a module using the Default Links utility. This utility uses the design information in the repository, specifically the foreign key constraints and descriptor columns, and the options that you specify in the Generate Default Links dialog box to generate a default set of links. The type of links that are generated by this utility are referred to as key based links.  About

To generate default links:

1.	From the Design Editor, choose Utilities→Default Links.

Note:	This menu option is available only if a module is selected from the Navigator or if a Module Diagram is displayed.

2.	From the Generate Default Links dialog box check the appropriate options:

•	Check Find Parents to create a link between base table usages and parent table usages.

•	Check Find Second Parents to create the second link for a table usage that has two or more parent table usages.

•	Check Allow Lookup Parents to allow lookup table usages to be regarded as parents of base table usages.

•	Check Allow Keys against Master Components to allow "master" information to be provided for "detail" records., i.e. inverted master-detail links. These types of links represent an unusual structure and are therefore rarely used.

•	Check Keep Existing Links to keep links that are already displayed on the diagram. If this option is checked, the utility will not remove all links from the diagram before the default links are generated.

•	Check Create Table Usages for Descriptor Columns to generate lookup table usages that have not been specified on the diagram. Lookup table usages will be created for any table that contains descriptor columns that are not part of the foreign key.

•	If you are generating a Reports report, check Use Outer Joins to add the outer join operator to lookup links and links to Descriptor Table Usages (table usages based on tables that contain descriptor columns that are not part of a foreign key column.) Outer join operators are used when a column in a foreign key constraint is defined as optional or when more than one foreign key constraint is defined on one column.

•	If you are generating a Reports report, check Find Treewalk Links to create treewalk links for any table usage that contains a bound item for a recursive foreign key constraint.


Generating default Lists of Values
Generating default Lists of Values (LOVs)

Related Topics

You can automatically create LOV components and make use of existing LOV components for your module designs, using the Default List of Values utility. This utility uses the design information in the repository, specifically lookup table usages, foreign key constraints and domain key constraints, and the options that you specify in the Default List of Values dialog box to create default Lists of Values components.

You can run the utility in the context of a module, a module component, a sub-component or a table usage. An LOV component is created or reused for lookup table usages that meet the following criteria:

•	The lookup table usage must be within a module component or a module sub-component. Note, the lookup usage must not be within a SQL query set.

•	The lookup table usage's owning module component or sub-component must not be a Multi-Row SQL Aggregate (MRSA) component, i.e. the component must either not contain any unbound items of type SQL Aggregate, or if it does, it must contain a Single Row SQL Aggregate table usage.

•	The lookup table usage must be directly linked to a base table usage.

•	An enterable item with which an LOV component can be associated must exist. An enterable item is an item whose Display Type is set to TEXT (or null) and for which the Select?, Insert? or Update? Flags are set. The utility associates the LOV component with the first enterable item in the list of items for the key between the base and the lookup table usage, when ordered by display sequence. If there is no suitable item, an LOV component is not created or included for the lookup table usage

If any of the criteria above are not met, the utility moves to the next lookup table usage included in the selection.

To create default LOV components:

1.	From the Design Editor, select a module, a module component, a sub-component or table usage (within a module component or sub-component) for which you want to generate default LOV components.

2.	Choose Utilities→Default Lists of Values.

3.	From the Default Lists of Values dialog box check the appropriate options:


Changing components between reusable and non-reusable

Related Topics

As you develop application designs you may find that module components or List of Values (LOV) components that were originally specific to a single module should now be reused by several modules. Similarly, you may find that reusable module components and reusable LOV components that are included in module definitions, require customizing and therefore should be copied as module specific components.

Note:	Module sub-components are included when you perform a make reusable, or make non-reusable, operation for a module component.

To make a non-reusable component reusable:

1.	From the Design Editor, display the non-reusable component's popup menu, by positioning the cursor over the component and pressing the Right Mouse button.

2.	From the popup menu, choose Make Reusable.

To make a module specific copy of a reusable component:

1.	From the Design Editor, display the reusable component's popup menu, by positioning the cursor over the component and pressing the Right Mouse button.

Note:	The module component that you choose, must be within the context of a module.

2.	From the popup menu, choose Make Private Copy.


The Module Network Viewer

Understanding the Module Network Viewer

About the Module Network Viewer

Using the Module Network Viewer

Viewing module networks

Adding new modules to a module network

Adding existing modules to a module network

Changing the structure of module networks

Copying menu structures

Viewing top level modules from the Module Network Viewer


About the Design Editor Module Network Viewer

Related Topics

The Module Network Viewer in the Design Editor allows you to define the menu structures and calling sequences for generated applications.

You can perform the following tasks using the Module Network Viewer:

•	Add existing modules to a module network

•	Add new modules to a module network

•	Change the structure of module networks

•	Copy menu structures

•	View module networks

•	Set the Module Network Viewer to display top level modules

The Module Network Viewer can be displayed vertically (as shown above) or horizontally (shown below). The horizontal view is particularly useful for viewing menu structures.

Note:	The Module Network Viewer is available from the Modules view of the Navigator.

The Module Network node has a root level entry for every module in the application system that is not called by other modules and every module for which the Top Level? property is set to Yes. This is illustrated in the diagram above, where FORMA, FORMB and MOD50 are not called by other modules. Notice how modules that are called from FORMA and FORMB are not shown at the root level.

Note:	If you define a network where, for example, ModuleA calls ModuleB and ModuleB calls ModuleA, these modules will not be displayed from the Module Network node, because they are both 'called' modules. To display ModuleA on the Module Network Viewer, set it's Top Level? property to Yes.

The names of menu modules are dimmed to distinguish them from other types of modules.


Viewing module networks in the Design Editor

Related Topics

You can view client module networks from the Design Editor using the Module Network Viewer.  About

Note:	You can also view which modules call and are called by a chosen module, by displaying that module on a Module Diagram.  About

To display the Module Network Viewer:

1.	Click the Modules tab on the Navigator.

2.	From the Navigator, expand the Module Network node.

3.	(Optional)  Set the Design Editor to display the module networks horizontally, by choosing View→Display Network Horizontally.

Note:	This menu option is available only if the Navigator is the active window.


Adding existing modules to a module network

Related Topics

From the Design Editor, you can identify which modules are to call and be called by a chosen module using the Module Network Viewer.  About

Note:	You can also identify calling and called modules using Module Diagrams.  How

To add an existing module definition to a module network:

1.	Display the Module Network Viewer.  How

2.	Expand the Module Network node.

3.	Expand the module network to which you want to add existing modules.

4.	Do one of the following:

•	Select the module definition that is to be called from the network and drag it to the required position in the module network. Hint text, identifying how the network will be updated, is displayed at the bottom of the Design Editor window.

Note:	To force the dragged module to be a child of the destination module you should hold down the SHIFT key.

•	Position the cursor over the module for which the called module is to be created, then click the Right Mouse button to display a popup menu. Choose the Called Modules popup menu option to display a dialog box from which you can choose the called module.


Adding new modules to a module network

Related Topics

From the Design Editor, you can create new module definitions and add them to a module network in a single operation. This is particularly useful when creating a menu structure.  About

To create a module and add it to a module network:

1.	Display the Module Network Viewer.  How

2.	(Optional)  If you intend to create menu modules you should set the Design Editor to use Property Palettes, because they will automatically set the module type of the new modules to MENU.  How

3.	Expand the module network for which you want to create new modules.

4.	Identify where the new module is to exist in the network, by selecting the module below which the new module is to be placed. For example, in the picture below, to create a child for MENU10 you must select MENU10.

Note:	If you want to create a new module network, select the Module Network node.

5.	Do one of the following:

•	Click the Right Mouse button to display a popup menu. Then choose to either Create Entry Below or Create Entry Right.

Note:	If the Module Network node is selected in the Navigator, choose the Create Module Network option.

•	Click

Note:	To create a child module hold down the SHIFT key.

6.	Do one of the following:

•	If the Design Editor is set to use Property Palettes, optionally change the default module name and type (the type defaults to MENU).
If you are creating a menu module, use the appropriate Title property to enter a menu caption (different types of generated applications derive their menu captions from different Title properties).

•	If the Design Editor is set to use Property Dialogs, specify the Module Type, Short Name and Language, then click Finish.


Changing the structure of module networks

Related Topics

As you develop module networks, it is likely that you will want to change the order in which modules are called. Using the Module Network Viewer in the Design Editor you can easily change the calling sequence of modules by dragging and dropping modules within a network.

Here are some points to note when dragging and dropping modules within a network:

•	To make a module a child of a node that is not expanded (i.e. has a [image] displayed next to it) you must hold down the SHIFT key while dragging.

•	To force a module to be a child of the module below which it is dragged you must hold down the SHIFT key while dragging.

•	Hint text is displayed at the bottom of the Design Editor to indicate the result of the drag and drop operation.


Copying menu structures

Related Topics

You can quickly copy a menu structure from one module to another using the Module Network Viewer in the Design Editor.

To copy a menu structure:

1.	Display the Module Network Viewer.  How

2.	Expand the module network for which you want to create new modules.

3.	Select the menu structure that you want to copy.

4.	Choose Utilities→Copy Menu Structure.

5.	Choose the module to which you want to copy the menu structure.

The menu structure is copied. Each module in the structure is given a default name with the prefix MOD_. This name can be overwritten.


Viewing top level modules from the Module Network Viewer

Related Topics

From the Design Editor you can set the Module Network Viewer to show modules whose Top Level ? property is set to Yes, in addition to all modules that are not called by other modules.

Note:	In previous releases if you defined a network where modules called each other, for example, ModuleA called ModuleB and ModuleB called ModuleA, these modules could not be displayed from the Module Network node, because both were 'called' modules.

To view top level modules:

1.	Display the Module Network Viewer.  How

2.	Right click on the Module Network node.

3.	Choose Show Top Level Modules.


About the Relative Tab Stops Editor

Related Topics

The Design Editor's Relative Tab Stops Editor is a graphical interface for specifying relative tab stops for items, item groups and their prompts .Although you can specify relative tab stop options using properties and preferences, the Relative Tab Stops Editor gives you a graphical indication of the relative positions of items and prompts.  About

The Relative Tab Stops Editor has:

•	a tool palette	About
•	a drawing area	About

Using the Relative Tab Stops Editor you can:

•	view the relative tab stops for a module component, sub-component or reusable module component  How

•	set properties, e.g., the Tab Stop Scope property  How

•	set the Block Vertical Fill (BLKVFL) preference  How


Relative Tab Stops Editor - elements and notation

Related Topics

1. Tool palette	5. Item prompt
2. Start/End tab stop indicators	6. Item group
3. Tab ruler	7. Item
4. Tab line	8. Item expansion
1. Tool palette

The tool palette enables you to perform tasks such as, change the magnification of the display and show or hide details about a component's relative tab stops.  About

2. Start and end tab stop indicators

The tab stop indicators identify where the Start Tab Stop property and the End Tab Stop property are specified for items and item groups.

3. Tab ruler

A tab ruler is displayed when the Tab Stop Scope property is set to Parent or Local for the component, or an item group. There may be one or more tab rulers displayed in the Relative Tab Stops Editor window, depending on the number of elements for which the Tab Stop Scope property is set.

Note:	The Tab Stop Scope property must be set to Parent or Local for the component, or one of its item groups before the Relative Tab Stops Editor can display tab stop indicators and tab lines.

4. Tab line

The tab settings that are specified within a component are identified using vertical tab lines. Each tab line is connected to a tab ruler.

5. Item prompt

Where prompts are specified, they are displayed alongside their associated items. A prompt alignment indicator is displayed next to each item, whose prompts are to be aligned to the left, i.e., when the item's Align Prompt ? property is set to Yes.

6. Item group

Simple and stacked item groups are represented as boxes drawn around items.

7. Items

The Relative Tab Stops Editor shows bound items and unbound items whose Display? property is set to Yes. The display type of each item is identified using an icon.

Note:	The Relative Tab Stops Editor does not display action items.

8. Item expansion

When an item is expanded beyond its intended display width, i.e., so that it aligns with an end tab stop, the Relative Tab Stops Editor identifies the amount by which the item has been expanded.


Relative Tab Stops Editor - tool palette

Related Topics

	Increases the magnification of the display.
	Decreases the magnification of the display.
	Adjusts the magnification of a selected part of the display so that the entire selection is visible. If the entire selection is visible before you click this button, the magnification of the selection is increased.
	Increases the magnification of a selected area. Note, you define the area that is to be magnified, by clicking this button and then dragging the cursor over the required area.
	Displays the entire content of the window at the maximum size that fits the window.
	Reverses certain commands.
	Reverses the action of Undo.
	Sets the window to Select Mode, i.e., allows you to select elements.
	Selects items, item groups or the component if they are within the selection area. Note, you define the selection area by clicking this button and then dragging the cursor over the required area.
	Selects the component, all item groups and all items.
	Shows or hides details of the tab stops and alignment details.
Start	Specifies the Start Tab for a selected item or group. If more than one Start Tab is included in the selection, this box shows ###.
End	Specifies the End Tab for a selected item or item group. If more than one Start Tab is included in the selection, this box shows ###.
Align?	Identifies whether the prompt of a selected item or group is to be aligned with other prompts.


Displaying and using the Relative Tab Stops Editor

Related Topics

The Relative Tab Stops Editor is always started from a Module Diagram or a Reusable Component Diagram.

To display and use the Relative Tab Stops Editor:

1.	Do one of the following:

•	open a Module Diagram, that contains the required module component or sub-component  How

•	open a Reusable Component Diagram based on the required reusable component  How

Note:	If you start the Relative Tab Stops Editor for a reusable component from a Module Diagram rather than a Reusable Component Diagram, the actions you can perform are restricted to setting the Tab Stop Scope for that module component.

2.	Click the Right Mouse button over the required component, then choose Relative Tab Stops Editor from the popup menu.

3.	Use the Relative Tab Stops Editor tool palette to change display settings, e.g. the magnification of the window.  How

4.	Set properties to control relative alignment.  How

5.	Set the Block Vertical Fill (BLKVFL) preference.  How


Setting properties with the Relative Tab Stops Editor

Related Topics

From the Relative Tab Stops Editor you can set the following properties:

•	Tab Stop Scope for a component and its item groups

•	Start Tab Stop and End Tab Stop for items and item groups

•	Align Prompt? for items

•	Orientation and Stacked? for item groups

Note:	Before setting relative tab stop properties, display the Relative Tab Stops Editor.  How

To set the Tab Stop Scope property:

1.	From the Relative Tab Stops Editor, select the component or the item group for which you want to set the Tab Stop Scope.

2.	Display the popup menu, then choose Scope:Self or Scope:Parent.

To set the Start Tab Stop and End Tab Stop properties:

1.	From the Relative Tab Stops Editor, select the items or item groups for which you want to set the tab stop properties.

2.	Specify new tab stops or choose tab stops that are already used in the component by doing one of the following:

•	enter or choose Start and End Tab Stop values on the Relative Tab Stops Editor tool palette

•	drag the item’s Start Tab Stop indicator or End Tab Stop indicator to line up with another tab ruler

To set the Align Prompt property:

1.	From the Relative Tab Stops Editor, ensure the items whose prompts you want to align are on the same tab stop.

2.	Select the items whose prompts you want to align.

3.	From the Relative Tab Stops Editor tool palette, choose Yes to align the prompt to the left.

To set the Orientation property:

1.	From the Relative Tab Stops Editor, select the item group for which you want to set the Orientation property.  How

2.	Display the popup menu, then choose Orientation:Vertical or Orientation:Horizontal.

To set the Stacked property:

1.	From the Relative Tab Stops Editor, select the item group for which you want to set the Stacked property.

2.	Display the popup menu, then choose Stacked ?


Setting the Block Vertical Fill preference with the Relative Tab Stops Editor

Related Topics

To set the Block Vertical Fill (BLKVFL) preference:

1.	Display the Relative Tab Stops Editor.  How

2.	From the Relative Tab Stops Editor, select the component.

3.	Display the popup menu, then choose the required Block Vertical Fill (BLKVFL) preference setting.


About the Generator Preferences Palette

Related Topics

The Generator Preferences Palette displays and maintains generator preferences.  How

The Generator Preferences Palette comprises:

Tool palette	Status bar
Product dropdown list	Filter box
Preference set dropdown list	Preference list box
Generator PreferencesTool Palette

The tool palette provides you with quick access to perform the following tasks:

	Save generator preference settings
	Revert generator preference settings
	Unset a preference to use an inherited value
	Copy generator preferences
	Paste generator preferences
	Show and hide preference icons
	Display long or short names for preferences
	Set the Generator Preferences Palette to track selections
Product dropdown list

Identifies the product for which preference values will be set. You can change the Product by choosing from this list. This option is not available if the Generator Preferences Palette is displayed for a preference set. When you change the Product, notice how the preference categories and their underlying preferences are updated in the Preference list box.  About

Preference set dropdown list

Identifies whether preference set values are applied to the currently selected repository element. This option is not available if the Generator Preferences Palette is displayed for a preference set. If preference set values are applied, the name of the preference set is shown here. If a preference set is not used, you can select one from this list.  About

Note:	Server Generator does not use preference sets, therefore this field is not applicable if Server Generator is chosen from the Product list.

Status bar

The status bar is for information purposes. It identifies the repository element for which preferences are being set.

Filter box

This box allows you to filter preferences from the preference list box.  How

Preference list box

Displays the preferences that can be set for the chosen repository element and selected product. If this box is empty, then preferences cannot be set for the chosen combination (i.e. repository element and Product).  About

The preferences that can be set for a repository element are divided into preference categories. These categories are shown on the palette and can be expanded to show the preferences they contain.

Three default colors are used when displaying preference names. You can change these default colors by choosing Color/Font/Style from the Options menu.

Default Color	Meaning
Red	The preference is mandatory, and displays its default value
Black	The preference is optional, and displays its default value
Blue	The preference value has been modified

Default icons are used to supply additional information about preferences, some examples are:

Icons	Description
	Preference value is inherited.
	Preference is frozen.
Alternatively, you can set the Generator Preferences Palette to show preference level icons.  How

Some example preference level icons are shown below, they identify the level from which a preference value is inherited.  About

Icons	Description
	Factory level icon for preference values that have not been explicitly set.
	Preference set icon for preference values that are inherited from preference sets.

From the Generator Preferences Palette, you can:

• Specify the values that should be used for generation	How
• Define preference sets	How
• Create references to preference sets	How
• Freeze and unfreeze preference values	How
• Lock and unlock preferences	How

By default, the palette tracks the selections that you make, showing the preference values that have been specified for a selected element.  About


Setting generator preferences
Setting generator preferences : step by step

Related Topics

Preference values can be explicitly set for elements in the repository by either:

•	setting values directly against a repository element

•	referencing a preference set from a repository element

•	using copy and paste

To set generator preference values directly against a repository element:

1.	Display the Generator Preferences Palette.  How

Note:	The palette title bar identifies the repository element for which preferences are being set.  About

2.	(Optional) Change the product, using the drop-down list provided.

Note:	This option is not available if the palette is displayed for a preference set.

3.	From the Generator Preferences Palette, select the preference that you want to set.

If you do not know the category to which the preference belongs, use the Search facility.  How

Note:	If the selected preferences are associated with shared elements or have been frozen, they cannot be changed and are therefore dimmed.

4.	Change the value of the selected preference as follows:

•	If the preference value field has stepper arrows, either click on the arrows to change the value, or type in the new value.

•	If the preference value field has a drop-down arrow, either click on it to display the available values and select the required one, or use the left and right arrow keys to select the required value.

•	If the preference value field does not have stepper or drop-down arrows, type in the new value.

Tip:	If the preference has a list of available values, double clicking on the preference name will pick the next value from the list.

Attention:	To set an explicitly set preference back to its default value, you must unset the preference value.  How

5.	Save the preference values by clicking the Save button [image] or by moving focus away from the Generate Preferences palette.

To set generator preference values using a preference set:

1.	Display the Generator Preferences Palette.  How

Note:	The palette must not be displayed for a preference set when creating a reference to a preference set.

2.	(Optional) Create a preference set.  How

3.	Ensure the Generator Preferences Palette is displayed for the repository element from which you want to reference a preference set.

Note:	The palette title bar identifies the name and type of repository element for which preferences are being set. About

4.	(Optional)  Select a preference set to be applied to the element. If no preference sets exist you can create one.  How

5.	Save the preference values by clicking the Save button [image] or by moving focus away from the Generate Preferences palette.


Displaying the Generator Preferences Palette

Related Topics

In order to set preference values, you must display the Generator Preferences Palette.

To display the Generator Preferences Palette:

1.	From the Navigator, select the repository element for which you want to view or set preferences.

2.	Click [image] on the main toolbar.

Tip:	Alternatively, use the Right Mouse button to display a popup menu and choose the Generator Preferences option

The Generator Preferences Palette is displayed. If it is already displayed, the contents are changed to reflect the current selection in the Navigator.


Creating and deleting generator preference sets

Related Topics

You can create sets of preferences with or without the aid of the Generator Preferences Palette. To see the generator preference sets that are owned by a container, expand the Preference Sets node on the Navigator.

You can also create a preference set for a container by copying an existing set.

Note:	After you have created a preference set, to make use of it you must create a reference.  How

To create a generator preference set with the Generator Preferences Palette displayed:

1.	Ensure that the Generator Preferences Palette is the active window and that some of the preference values shown are explicitly set.

2.	Choose Preferences→Create As Preference Set.

3.	Enter the name of the preference set and click OK.

A set is created with a copy of all the explicitly set preferences shown in the Generator Preferences Palette, i.e. inherited preference values are not included in the set.

To create a generator preference set without the Generator Preferences Palette displayed:

1.	Do one of the following:

•	select the Preference Sets node

•	expand the Preference Sets node and select the type of product for which you want to create a preference set

2.	Click [image].

3.	Enter the name of the generator preference set and choose the type of product for which you want to create a preference set.

4.	Click [image] on the Property Palette.

A set is created with the factory default settings. Before using the preference set you must specify preference values for the set.  How

To delete a generator preference set:

1.	From the Navigator, select the required preference set.

2.	Click [image].

3.	Click Delete to delete the generator preference set.

The generator preference set is deleted. Any references to the preference set are also deleted.


Referencing generator preference sets

Related Topics

To use preference values stored in a generator preference set, a reference to the preference set must exist. The preference set that you reference may be frozen. When the preference settings from a generator preference set are no longer required, you can remove the reference. When the reference is removed, the set is not deleted and remains available to the container.

To reference a preference set:

1.	Display the Generator Preferences Palette.  How

2.	From the Navigator, select the element from which you want to create a reference to a preference set.

The selected element may be frozen.

3.	From the Generator Preferences Palette, Preference Set list, select the required preference set.

4.	Click [image] on the Generator Preferences Palette.

To remove a reference to a preference set:

1.	Display the Generator Preferences Palette.  How

2.	From the Preference Set list box, choose No Preference Set Used.

3.	Click [image].


Unsetting a preference to use an inherited value

Related Topics

It is possible that a preference value that you have set against a repository element is no longer required and that you want the element to inherit its preference value. A preference is not regarded as being unset, i.e., using its factory value or inheriting its value, if you simply change its value in the Generator Preferences Palette.

To unset selected preferences:

1.	Display the Generator Preferences Palette.  How

2.	Do one of the following:

•	To unset the preferences selected in the Generator Preferences Palette only, select the preferences and then click [image] (Preferences→Inherit from the Main toolbar).

•	To unset all preferences for the elements shown below the element in the Generator Preferences Palette, choose Preferences→Cascade Inherit All. For example, if the palette shows preferences for a container, all preferences within the container would be unset to inherit from the container.

•	To unset selected preferences for the elements shown below the element in the Generator Preferences Palette, choose Preferences→Cascade Inherit Selection. For example, if the palette shows preferences for a container, the selected preferences would be unset throughout all levels of that container, so that the preference settings were inherited from the container.

The values of the chosen preferences that are not frozen or shared, are unset. The icons displayed next to each preference are updated to show where their value is being inherited from.


Copying and pasting generator preferences

Related Topics

You can set generator preferences using copy and paste. Preferences are copied to the Preferences Clipboard. The preferences stored on the Preferences Clipboard are applied to a repository element when you use paste.

To copy preferences to the Preferences Clipboard:

1.	Display the Generator Preferences Palette.  How

2.	From the Generator Preferences Palette, select the preference or preferences whose values you want to copy.

Attention:	Only preferences that have been explicitly set can be copied.

3.	Click [image].

The preferences within the selection that have been explicitly set, are copied to the Preferences Clipboard.

Note:	Choosing Edit→Copy Properties overwrites the contents of the Preferences Clipboard; you cannot merge copied properties.

To paste the contents of the Preferences Clipboard:

1.	From the Generator Preferences Palette, select the preference or preferences whose values are to be overwritten by the contents of the Preferences Clipboard.

2.	Click [image].

The preference items on the Preferences Clipboard overwrite the values of any corresponding selected preferences.

To display the contents of the Preferences Clipboard:

1.	Display the Generator Preferences Palette.  How

2.	Choose Edit→View Copied Properties.

To access this menu option, the palette must be the currently active window.

The Copied Values dialog box is displayed, showing the most recently copied preferences.

Note:	You can delete preferences from the Preferences Clipboard by selecting them from the Copied Values dialog box and then clicking the Delete button.


Locking and unlocking generator preferences

Related Topics

If you do not want preference values that have been set for a repository element to be accidentally changed, you can lock the preferences. Locked preferences cannot be changed by other users, until they are unlocked.

You cannot lock preferences that are already locked or frozen. Use the palette icons to determine whether a preference is locked or frozen.  About

If preferences are locked for an element and that element references a preference set, the reference is locked too. The content of the referenced preference set is not locked, but the reference cannot be removed until the element is unlocked.

To lock preferences for a chosen repository element:

1.	Display the Generator Preferences Palette.  How

Note:	The palette identifies the repository element for which preferences are to be locked.

2.	Choose Security→Lock Preferences.

To access this menu option, the palette must be the currently active window.

To unlock preferences for a chosen repository element:

1.	Display the Generator Preferences Palette.  How

Note:	The palette identifies the repository element for which preferences are to be unlocked.

2.	Choose Security→Unlock Preferences.

To access this menu option, the palette must be the currently active window.

To remove all preference locks implemented by the current user:

•	If the Generator Preferences Palette is displayed, choose Security→Remove Locks.

•	If the Generator Preferences Palette is not displayed, ensure the Navigator is active, then choose Utilities→Unset Preference Security→Remove Current User Locks.

To remove all implemented preference locks:

This option is available to the container owner (and users that have administrative privileges on the container) only.

•	If the Generator Preferences Palette is displayed, choose Security→Remove All User Locks.

•	If the Generator Preferences Palette is not displayed, ensure the Navigator is active, then choose Utilities→Unset Preference Security→Remove All User Locks.


Freezing and unfreezing generator preferences

Related Topics

Freezing and unfreezing generator preferences can be performed by the owner of a container only. If you do not want preferences that have been set for a repository element to be overridden, you can freeze the preferences for that repository element. The preferences remain frozen, i.e., they cannot be changed, until they are unfrozen by the container owner.

Note:	If you are not the owner of the container, you can lock preference values instead. How

You cannot freeze preferences that are already locked or frozen. Use the palette icons to determine whether a preference is locked or frozen.  How

When preferences are frozen for a repository element, the preferences for lower level repository elements of the same product are also frozen.

If a reference to a preference set exists from a frozen repository element, that reference is frozen, i.e., it cannot be removed until the repository element is unfrozen. However, the contents of the referenced preference set is not frozen.

To freeze preferences for a repository element:

1.	Display the Generator Preferences Palette.  How

Note:	The Generator Preferences Palette identifies the repository element for which preferences are to be frozen.

2.	Choose Security→Freeze.

All of the preferences that are displayed in the palette are frozen and the Frozen icon is displayed next to them.

To access this menu option, the palette must be the currently active window.

To unfreeze preferences for a repository element:

1.	Display the Generator Preferences Palette.  How

Note:	The Generator Preferences Palette identifies the repository element for which preferences are to be unfrozen.

2.	Choose Security→Unfreeze Preferences.

To access this menu option, the palette must be the currently active window.

To unfreeze preferences for all repository elements in a container:

•	If the Generator Preferences Palette is displayed, choose Security→Unfreeze All.

•	If the Generator Preferences Palette is not displayed, ensure the Navigator is active, then choose Utilities→Unset Preference Security→Unfreeze All.


Saving and reverting generator preference settings

Related Topics

When you change the preference values that are used during generation, you must save the changes that you have made. Any changes that you have made to preference sets also affect which preference values are used.

Changes that you make to preference values can be reverted independently of other changes that you may have made to the repository, by clicking the Revert button on the Generator Preferences Palette tool palette.

Note:	If you have set the Generator Preferences Palette to track selections, changing the selection in the Navigator, or a diagram, will automatically commit the changes.

To save changes to preference values:

1.	Display the Generator Preferences Palette.  How

2.	Change preference values.

3.	Click [image] on the Generator Preferences Palette tool palette to save only changes to preference values. To save changes that you have made outside the Generator Preferences Palette, click the Save button on the main toolbar.

To revert changes to preference values, do one of the following:

•	Click [image] on the Generator Preferences Palette tool palette, to revert changes to preference values, without reverting any other changes that you may have made, e.g. changes to the properties of a repository element.

•	Click [image] on the main toolbar, to revert all changes that have been made since the last save, including changes to preference values.


Setting the Generator Preferences Palette to track selections

Related Topics

You can specify whether the content of the Generator Preferences Palette is automatically refreshed in response to repository elements that you select. When selections are being tracked, changing the selection on the Navigator, or diagrams causes the content of the palette to be updated. This, in turn, automatically saves any changes that you make to preference values in the palette. The name and type of the element for which you are setting preferences, is displayed in the palette title bar.

Track selections (Default)	The palette is refreshed when a new element selection is made on a component, e.g. the Navigator. The palette is refreshed only if preferences can be set for a selected element. For example, if the Generator Preferences Palette shows preference values for a container, and you then select a different container from the Navigator, the palette shows preference values for the new selection.
Not track selections	The palette shows preference values for the element for which the palette was displayed only. The content of the palette is not refreshed if a new element selection is made. For example, if the Generator Preferences Palette is invoked for a container and you then select a different container, the palette does not show preference values for the new selection.
To specify whether the Generator Preferences Palette tracks selections:

•	Click [image] on the Generator Preferences tool palette.

If the button is pressed in, the palette will track selections, otherwise selections are not tracked.


Locating inherited preference values

Related Topics

Preferences that inherit their values can be identified on the Generator Preferences Palette using icons.  How

These icons identify the level from which a preference value is inherited, however, they do not identify a specific repository element from which a value is inherited.

To identify exactly where a preference inherits it value from:

1.	Display the Generator Preferences Palette.  How

2.	Select the preference for which you want to identify where the value is inherited from.

3.	Choose Preferences→Locate Inherited Value.

The Generator Preferences Palette is updated to show the repository element from which the preference inherits its value.


Showing and hiding preferences on the Generator Preferences Palette

Related Topics

The Generator Preferences Palette provides you with a number of ways of showing or hiding preferences.

To show all or modified preferences:

1.	Ensure the Generator Preferences Palette is the active window, by clicking on its title bar.

2.	Do one of the following:

•	To show all preferences that can be set for a repository element, choose View→Show All Values.

•	To show only preferences whose values are explicitly set, choose View→Show Modified Values.

A check mark is displayed next to the menu option that is currently in use.

To hide preferences that use factory settings:

1.	Ensure the Generator Preferences Palette is the active window, by clicking on its title bar.

2.	Choose View→Hide Default Values.

Any preferences that use factory settings are removed from the Generator Preferences Palette.

To hide preferences whose values are set at container level:

1.	Ensure the Generator Preferences Palette is the active window, by clicking on its title bar.

2.	Choose View→Hide Container Level Values.

Any preferences that use factory settings, or which are set at container level, are removed from the Generator Preferences Palette.

To filter preferences:

1.	Display the Generator Preferences Palette.  How

2.	In the Filter field, enter the search string for which matches are to be found.

The wildcard character % can be used to widen the search.

To show only...	Enter...
Preference names starting with com	com%
Preference names starting with com and containing ing.	com%ing%
3.	Click Filter.

The Generator Preferences Palette is filtered to display only the preference items that match the filter string.

To remove the filter:

Remove all text from the Filter field and click Filter.


Showing or hiding generator preference icons

Related Topics

The Generator Preferences Palette displays the following icons by default.

Icons	Description
	Preference not set, default value is used.
	Preference is set for this element.
	Preference value is inherited.
	Preference is locked by the current user.
	Preference is locked by another user.
	Preference is frozen.

Instead of displaying the default icons, you can set the Generator Preferences Palette to show icons that identify the level at which preferences have been set, e.g.

Icons	Description
	Factory level icon for preference values that have not been explicitly set.
	Preference set icon for preference values that are inherited from preference sets.
The preference level icons are particularly useful for identifying the level from which a preference value is inherited.  About

To show or hide generator preference icons:

1.	Display the Generator Preferences Palette.  How

2.	Do one of the following:

•	To display icons next to each preference in the palette, click [image].

•	To hide the icons from the palette, click [image].


Displaying generator preference names

Related Topics

You can specify whether names or descriptions are shown for generator preferences on the Generator Preferences Palette.

Tip:	You can view the description of the currently selected preference by looking at the status bar.

To display generator preference names or descriptions:

1.	Display the Generator Preferences Palette.  How

2.	Do one of the following:

•	To replace descriptions with names, click [image].

•	To replace names with descriptions, click [image].


This file contains dialog box descriptions

This topic is for documentation purposes only. It contains DE dialog box descriptions that do not have a one to one mapping with a menu option.

Dialog boxes that are specific to Modules/Module Diagrams are stored in DWFMDD so they do not appear in ODD doc.

General DE

Choose container dialog box

Resolve diagram and workarea dialog box

Create Elements 1 dialog box

Create Elements 2 dialog box

Set target for dialog box

Set source for dialog box

Default Database Implementation Wizard

Foreign key dialog box

Search Path dialog box

Database Navigator

Database Navigator Properties dialog box


Choose container dialog box

Related Topics

When you create a new diagram this dialog box is displayed to allow you to specify the container in which the diagram is created.

Dialog box options

Container list

Displays the containers that are visible to the workarea.


Resolve diagram and workarea dialog box

Related Topics

This dialog box is displayed when you open a diagram containing elements that are not visible to the workarea. For example, the workarea configuration may have changed to no longer include the required container.

Dialog box options

Remove missing elements from the diagram

Removes from the diagram all missing diagram elements, and associations that start or end at the missing elements. The diagram elements are permanently removed from the diagram.

Include missing elements from the workarea

Displays the List External References dialog box, from which you can include the missing elements into the workarea. When the missing elements have been included the diagram is opened. You must include all missing elements before the diagram can be opened.

Copy available elements to a new diagram

Opens a new diagram based on the original diagram, but without the missing diagram elements. The new diagram is not associated with the existing diagram, i.e. any changes that you make to the new diagram are not reflected on the existing diagram.


Create <elements> dialog box

Related Topics

Creates associations between repository elements. For example, associations are created when you specify which columns are to be part of a primary key.

Note:	The title and labels for this dialog box change according to the type of association that is to be created.

Dialog box options

Left list box

Shows the existing repository elements from which you can choose. The displayed elements are usually in the context of the element that was selected when this dialog box was displayed. For example, when creating columns for a primary key, all columns that have been defined for the primary key's table are listed.

Right list box

Shows the repository elements to which references are to be made. There must be one or more elements shown in this list box to create an association.

Assign Selected buttons

Moves selected items between list boxes.

Assign All buttons

Moves all items from one list box to another. They are displayed only if moving all items from one list box to another is a valid operation.

Resequence buttons

These buttons are displayed only if the order of the chosen elements is of importance, such as, the order of the columns in a primary key.

Show unassigned

When checked identifies that chosen elements remain listed in the left list box. By default, chosen elements are displayed in the right list box only. This option is displayed only if multiple assignments are allowed.


Create Elements dialog box
Create <elements> dialog box

Related Topics

Allows you to create an association between two repository elements. For example, an association is created when you specify the tables on which a view is to be based.

Note:	The title and labels for this dialog box change according to the type of association that is to be created.

Dialog box options

Filter control

Allows you to filter the repository elements that are displayed in the list box. The wildcard character (%) is used to represent any character, string of characters or no characters. The Filter button is available only if the wildcard character is entered in the filter field. When this button is pressed, the items in the list box are filtered to match the specified search string.

List box

Lists the existing repository elements from which you can choose.

Identify the elements that are to be selected on the diagram, by selecting one or more entries from this list.

Select All

Selects all entries in the list box. This button is available only if there is more than one entry in the list box.

Clear All

Unselects all entries in the list box.


Default Database Implementation Wizard

This wizard allows you to specify the database and database user for which a database object is to be created. Choosing to assign a database object to a database will not cause the database object to be implemented on an online database immediately. Instead, the details are recorded in the repository and subsequently used during database generation.

For more information, see About user-specific database objects.

Note:	You can see which database implementation details are recorded in the repository, by displaying the Database Administration tab on the Navigator.

You can specify whether this wizard is to be used by default from the General Settings dialog box.  How

Default Database Implementation (page 1 of 2)

The options on this page allow you to specify whether implementation details are to be specified for this database object definition and any database object definitions that you create subsequently.

The options are

Assign this database object and subsequent database objects to a default.

Just assign this database object to a database/user and display this wizard again.

Do not assign this database object to a database, and display this wizard again.

Do not assign database objects to databases.

Default Database and User (page 2 of 2)

This page allows you to choose the Oracle database and user for which the database object is to be implemented.

Target Container

Default Database

Database Type

Default User


Choose this option to assign the database object definition to a database and user. In addition, any database object definitions that you create subsequently will also be assigned to the same database and user. If you choose this option you must then click Next to specify the name of the required database and user.

Note:	If this option is chosen, this wizard will not be displayed in future for elements in the container because the implementation details supplied for this database object definition are used as default values for future database object definitions.


Choose this option to assign the database object to a database and user, and to ensure that this wizard is displayed the next time you create a database object. If you choose this option you must then click Next to specify the name of the required database and user.

Note:	Choosing this option ensures that this wizard will be displayed the next time you create a database object, allowing you to specify a different database and user for each database object definition that you create.


Choose this option if you do not want to record implementation details in the repository for this database object.

Note:	Choosing this option ensures that this wizard will be displayed the next time you create a database object, allowing you to specify a different database and user for future database object definitions that you create.


Choose this option if you do not want to record implementation details in the repository for this database object, or any database objects that you subsequently create.

Note:	If this option is chosen, this wizard will not be displayed in future, and none of the database object definitions that you create will be assigned to a database or user.


Identifies the container of the database and database user for which the database object is to be implemented. The available values for the Default Database and Default User are determined by the container you choose here.


Identifies the database on which the database object is to be implemented. The dropdown list shows the database definitions that are recorded in the repository. You can choose an existing database definition or you can record a new one in the repository, by typing its name in this box.

Only Oracle database definitions are created from this option.


Identifies the version of the database on which the database object is to be implemented, e.g., Oracle7.3 database server, Oracle8 database server.


Identifies the database user for which the database object is to be implemented. The dropdown list shows the database user definitions that are recorded in the repository. This list shows database users that exist for the chosen database definition only. You can choose an existing database user definition or you can record a new one in the repository, by typing its name in this box.


Foreign key dialog box
Foreign Key Columns dialog box

Allows you to specify which columns are to be used by a foreign key constraint. Each column in the left list should map to a column of the same datatype, length and transferability in the right list.  About

Dialog box options

Columns in current table

Lists the columns that exist for the table on which the foreign key is defined. Choose a column from the dropdown list, or enter a new one.

Columns in join table

Lists the columns for the table that is referenced by the foreign key. Choose a column from the dropdown list, or enter a new one. If you enter a new column name in this list, the column is created with the same properties as its mapped column in the left list.

Add button

Inserts a new grid row, above the selected column, into which you can enter a column name. You can use the down arrow to display a list from which you can choose an existing column name.

Delete button

Deletes the selected column from the foreign key.

Resequence buttons

Specifies the order in which the columns are to appear in the foreign key. To resequence a column, select it and click the appropriate sequence button.


Select Collection Type dialog box

Related Topics

Enables you to choose or create the Oracle collection type that specifies a reference to a collection of Oracle object types.  About

Dialog box options

The selection box shows Oracle collection types that exist in the repository. Select the Oracle collection type you require or click Create Collection Type to define a new one.

Create Collection Type button

Displays the Create Collection Type dialog box. If you create a new Oracle collection type, it is automatically selected in the Select Collection Type dialog box.


Generic Select Object dialog box

Displays a list of objects from which you can choose. The title of this dialog box depends on the context in which it is displayed.

Filter field

Enables you to enter a filter condition for the list.

 button

Entering a name, or part of a name, and clicking this button restricts the list to those objects whose names match the filter condition.

List box

Lists the objects that are available for selection.

Select All button

Selects all the objects listed.

Clear All button

Deselects all the objects listed.


Search Path dialog box

Allows you to choose the additional containers in which to locate repository elements that are referenced by the captured design.

Candidate Containers

Lists the containers that are visible to the workarea, but which are not included in the Search Path.

Search Path

Lists the containers that are part of the Search Path, in the order in which they are used.

Assign Selected buttons

Moves selected items between list boxes.

Assign All buttons

Moves all items from one list box to another. They are displayed only if moving all items from one list box to another is a valid operation.

Resequence buttons

Changes the order of chosen containers in the Search Path.


Database Navigator - This topic is for documentation purposes only - The following dialog boxes are used by the Database Navigator only


Database Navigator Properties dialog box

Related Topics

Displays the online database properties for a chosen online database object. You can use this dialog box to compare values stored in the repository with values on an online database object.

Name

Identifies the properties that are recorded in the repository for the chosen element type.

Value

Identifies the values that are held on the database for the online database object. A <Null> value is shown when there is no corresponding online database property for a listed repository property, or when no value has been defined for the property on the online database.

Note:	The values shown in this column are those which will be recovered into the repository if you use the Design Capture utility.

Text

Displays the text that is defined for a property on the online database. This button is available only if a Text type property is selected.


Displaying the Design Navigator

Related Topics

A Design Navigator is displayed automatically when you start the tool. However, you may need to display more than one Design Navigator, e.g., to drag and drop repository elements between different views.

To display a new Design Navigator, choose File→New→Navigator.


Creating containers from the Design Editor

Related Topics

Containers provide you with a way of organizing information in the repository. The types of container you use in the Design Editor are application system and folder. You must have the Manage Container repository privilege before you can create containers.

To create a container from the Design Editor:

1.	From the Design Navigator, do one of the following.

•	create a root level container, i.e., a container without a parent container, by selecting the workarea node

•	create a child container, by selecting an existing container node

2.	Click [image].

3.	In the Property Palette, enter the container name.

4.	Click [image] on the Property Palette to create the container in the repository.


Creating repository elements

Related Topics

Creating an element in the repository is typically part of a larger process, e.g., you create a table as part of creating a database design. You can create repository elements using guides, diagrams and the Design Navigator.

The guides assist you through the major design processes, ensuring that your designs are as complete as possible. As you become familiar with the product, you will find that instead of using the guides, you can quickly perform the same tasks using the design components, e.g. the Design Navigator. The components do not attempt to lead you through related tasks, instead, they allow you to decide the order in which you perform your design tasks.

Note:	Before you can create a repository element, a container must be visible to your workarea. If a container is not visible you can create one if you have the Manage Container repository privilege.  How

To create repository elements from the Design Navigator:

1.	Click on the required Design Navigator tab.

Each Design Navigator tab presents a set of repository elements.  About

2.	From the Navigator, expand the container in which you want to create a repository element.

3.	Select the node that identifies the type of element that you want to create. For example, to create a relational table definition select the Relational Table Definitions node on the Server Model tab.

Note:	If you want to create a secondary element, such as a column on a table, you must expand the table node for which the column is to be created and then select the Column node.

4.	Click [image].

If the container in which you want to create the repository element is checked-in, you are prompted to check out the container before creating the element. If you choose not to check out the container the create operation is canceled.

A Property Palette or Property Dialog box is displayed.  About

Note:	If you are creating an association, e.g., the base tables of a view, a dialog box is displayed from which you must choose the required repository element.

5.	To record the element in the repository, do one of the following:

•	If a Property Dialog box is displayed, follow the instructions on the dialog box.

•	If a Property Palette is displayed, enter all mandatory property values (colored red by default) and optionally change the remaining property values. Then click [image] to record the element in the repository.


Editing repository elements

Related Topics

You can use the Design Navigator, rather than opening a diagram, to quickly edit repository elements.

Note:	If the element whose properties you want to edit is already shown on a diagram, you do not need to perform steps 1 and 2 below. Instead, simply double-click on the diagram element to display the Property Dialog box or Property Palette, from which you can edit the repository element.

To edit repository elements from the Navigator:

1.	Click on the required Navigator tab.

2.	From the Navigator, expand the container for which you want to edit a repository element.

3.	Select the element that you want to edit. For example, if you want to edit a table, select its name.

On the navigator, you may need to expand a node by one or more levels to see the element that you want to select. For example, expand the Relational Table Definitions node to see relational table elements.

3.	Choose Edit→Properties.

A Property Palette or Property Dialog box is displayed.  About

4.	To edit the element's properties, do one of the following:

•	If a Property Dialog box is displayed, find the properties you want to edit, by clicking the tabs or using the Next and Previous buttons. When you have edited the properties, click Finish to record the changes in the repository.

•	If a Property Palette is displayed, edit the displayed properties and click [image] to record the changes in the repository.


Deleting repository elements

Related Topics

You can delete a non-versioned object, or a checked-in versioned object. The elements you delete are placed in the workarea wastebasket, which you can empty using the Repository Navigator.

There are other methods of removing elements from the repository, such as Force Delete, Purge and Force Purge.

Note:	If the element that you want to delete is shown on a diagram, click on the diagram element then choose Edit→Cut to remove the element from the diagram only or Edit→Delete From Repository if the element is to be removed from the diagram and the repository.

To delete repository elements:

1.	In the Navigator locate the objects you want to delete.

2.	From the Navigator, expand the container from which you want to delete a repository element.

3.	Expand the node that identifies the type of element that you want to delete. For example, e.g., th Relational Table Definitions node on the Server Model tab, and select the required elements

4.	Click [image].

5.	From the Delete From Repository dialog box, click Delete to place the element in the wastebasket.

6.	(Optional)  If you want to remove the objects from the repository completely, empty the wastebasket using the Repository Object Navigator. Note that doing so also removes any other objects in the wastebasket.

Alternatively, you can use the Repository Object Navigator to restore the objects from the wastebasket.


Tracking diagram selections on the Navigator
Tracking diagram selections on the Design Navigator

Related Topics

When diagrams are open you can ensure that any selections that you make are reflected on the Design Navigator.

Note:	The Design Navigator must be set to the tab that displays the types of elements shown on the diagram.

The Design Navigator automatically expands the appropriate nodes to show the elements that you select on a diagram. For example, if you select a column on a Server Model Diagram, but the navigator shows only the name of the table to which the column belongs, the table node is expanded to show the name of the table's columns.

To track diagram selections:

•	From the Design Navigator tool palette, click [image].


Fast creating repository elements

Related Topics

The Fast Create facility allows you to quickly create multiple repository elements of the same type, by specifying minimal details only. The repository elements are created with default property values that you can change at a later date.

To create repository elements using Fast Create:

1.	From the Navigator, select the node that identifies the type of the repository element you want to create. For example, if you want to create Domains, select the Domains node.

2.	Choose Edit→Fast Create.

If elements, such as tables, are to be created the Fast Create dialog box is displayed, for you to enter required properties.

Note:	For each repository element that is to be created, you must enter a value for every property shown on the dialog box.

If associations, such as usages of relational tables by a relational view, are to be created, a dialog box from which you can select elements is displayed.

3.	Click OK to create the elements in the repository.


Customizing the Design Navigator

Related Topics

You can use filters to customize the Design Navigator.

•	Use filters to determine which elements are displayed on the Navigator, and the order in which they are displayed, by choosing Options→Customize. This option also allows you to specify which property values are to be displayed next to the object name on the Navigator and diagrams.

•	Clear filters by choosing Navigator→Clear Selected Filters or Clear All Filters.

•	Change the colors and fonts of text shown on the Navigator, by choosing Options→Color/Font/Style.

You can also customize the Design Navigator views.

•	Change the Navigator view, by clicking on the required Navigator tab.

•	Hide the Navigator views by choosing Navigator→Show/Hide Tabs.

•	Set the Navigator views to be identified by text or icons, by choosing Navigator→Show Icons on Tabs/Show Text on Tabs.

•	Reposition the Navigator views, by choosing Navigator→Horizontal/Vertical tabs


THIS TOPIC IS FOR INFORMATION ONLY

The following topics provide context help from the Navigator, for nodes that are not derived from the repository


PL/SQL Composition

Related Topics

The PL/SQL Composition node is a heading that is displayed from the Server Model view of the Navigator.

The purpose of this node is to allow you to see the structure of the PL/SQL definitions in a container, i.e., which elements call other elements. PL/SQL definitions that are called from other PL/SQL definitions are referred to as sub program units.

Note:	The PL/SQL definitions that are displayed at root level are those that are not called by any other PL/SQL definitions.

This node also allows you to print the structure of the PL/SQL definitions.

Note:	When printing from the PL/SQL structure, you must ensure that the required nodes are fully expanded on the Navigator to display everything that is to be printed.

Tip:	Use the Right Mouse button as a short cut for creating additional sub program units and for printing from this node.


Server Model Definitions
Server Model Elements

Related Topics

The Server Model Definitions node is a heading that is displayed from the Database Administration view of the Navigator. It  groups together repository elements for which database implementation details can be defined, e.g. tables and views. The purpose of this node is to allow you to see which database elements are recorded in the repository, without switching to the Server Model view. It also allows you to drag and drop selected database elements within the context of the Database Administration tab.

Note:	This node does not display the repository elements that are related to the database elements. For example, columns are not shown for tables. Instead you must access this type of information from the Server Model tab.

For information about the repository elements that can be accessed from this part of the Navigator, see:

Clusters

Object Tables

Object Views

PL/SQL Definitions

Sequences

Materialized views

Tables

Views


Replicated Objects
Replicated Objects branch - Navigator

Related Topics

The Replicated Objects node is a heading that is displayed from the Distribution view of the Navigator. It displays database objects that are to be replicated for a particular schema on an Oracle database. The types of database objects that can be replicated are tables, views and PL/SQL definitions.

Below the Replicated Objects node, the tables, views and PL/SQL definitions are grouped under separate headings. The entries below these headings identify database elements (that belong to replication groups on other databases) that are to be replicated on the database for which the Replicated Objects node is displayed.

Note:	The replication group to which each table, view and PL/SQL definition belongs can be identified from the Replication Group property. This property can be seen from the Property Palette.

For information about the repository elements that can be accessed from this part of the Navigator, see:

Replication groups

Replication group propagations


Schema Objects
Schema Objects branch - Navigator

Related Topics

The Schema Objects node is a heading that is displayed from the Database Administration view of the Navigator. It displays the database elements that are to be implemented for a particular schema, e.g., tables and views.

For information about schema objects, see About user specific database objects.

A Schema Objects node exists for each database user that is defined in the repository. The types of database objects that can be implemented for a database user are determined by whether that user is defined for an Oracle database, or for a different type of database. For example, materialized views can be implemented on Oracle databases only.

For information about the repository elements that can be accessed from this part of the Navigator, see:

Database users


Storage
Storage branch - Navigator

Related Topics

The Storage node is a heading that is displayed from the Database Administration view of the Navigator. It displays elements that are used to record storage information for a database in the repository, i.e., the tablespaces, datafiles, logfiles and rollback segments.

The storage information that can be recorded from this node is determined by whether it is displayed in the context of an Oracle database. For example, for databases that are not Oracle databases, you can record tablespaces and datafiles only.

For information about the repository elements that can be accessed from this part of the Navigator, see:

Datafiles/Logfiles

Directories

Rollback segments

Tablespaces


About the Database Navigator

Related Topics

The Database Navigator displays online database objects, for a specified database user. The database on which the database objects are located may be an Oracle database or another type of database.

You can use the Database Navigator to:

•	Compare online databases with the contents of the repository.

In addition to comparing databases with the repository, you can also compare different online databases, or different users on online databases by opening a different Database Navigator for each database user.  How

•	View the properties that are associated with an online database object.

For each database object you can view how the associated properties are stored in the database, e.g., the format or type of the actual database values.  How

•	Run the Server Generator.

When generating database objects, you can start the Server Generator from a menu or the toolbar. However, starting the generator in either of these ways means that you must complete the Generate dialog box. Instead, you can perform server generation, without the need to complete or confirm a dialog box, by dragging repository server model elements from the Design Navigator onto the Database Navigator.  How

•	Run the Capture Server Model utility.

You can use the Database Navigator to identify which database objects you want to capture into the repository, and to start the design capture process.  How

When you generate database objects, by dragging them from the Design Navigator onto the Database Navigator, the Database Navigator contents are automatically refreshed. However, if a database is updated using a different method, and it is represented by a Database Navigator, you must refresh the Database Navigator manually.  How

Note:	The information shown in the Database Navigator cannot be directly edited, e.g. you cannot use the Navigator to delete any of the online database objects or to edit any values.


Opening the Database Navigator

Related Topics

The Database Navigator enables you to view online database details for specified database users. The Database Navigator's title bar displays the name of the online database to which the Database Navigator is connected.

To open the Database Navigator:

1.	Choose Tools→Database Navigator.

2.	Do one of the following:

•	To view database details for an Oracle database, choose the Oracle option and enter the user, password and database.

The connect string for Oracle databases defaults to the connection used to invoke the tool.

•	To view database details for databases other than Oracle databases, choose the ODBC option and enter the data source and type.


Viewing properties of online database objects

Related Topics

The Database Navigator uses a tree structure to display the database objects that exist for a database user. Each of the database objects has associated properties that you can view.

Note:	For each database column, the name, datatype, length and precision properties are displayed on the Database Navigator. Mandatory columns are displayed in red, by default. To change the default color, choose Options→Color/Font/style.

To view properties of an online database object:

1.	Open the Database Navigator.  How

2.	From the Database Navigator, select the required database object.

3.	Choose View→Properties.

A list of property names and read-only values is displayed in a dialog box. An alternative method for displaying a database object's properties is to double click on the object's name.


Refreshing the Database Navigator contents

Related Topics

If the information displayed by the Database Navigator does not reflect the current state of the database, you must close the Database Navigator and then reopen it to display the current database status.

Note:	Dragging repository elements that are to be generated, from the Design Navigator on to the Database Navigator, automatically starts the Server Generator and refreshes the Database Navigator.


Generating databases using the Database Navigator

Related Topics

When the Database Navigator is displayed, you can generate database objects from your server model quickly, by dragging and dropping selected elements between the Design Navigator and the Database Navigator.

To generate database objects, using the Database Navigator:

1.	Display the Database Navigator.  How

2.	Do one of the following:

•	Generate base database objects, by selecting the elements that you want to generate from the Server Model tab on the Navigator. For example, elements such as tables and views.

•	Generate database objects tailored for a specific user, by selecting database objects tailored for a specific user (from  the DB Admin tab).  First select the user, then one or more of the database object implementations you have defined.

3.	Drag the selected elements onto the Database Navigator.

The Database Navigator is automatically refreshed to reflect the changes to the online database.


Capturing database designs using the Database Navigator

Related Topics

When the Database Navigator is displayed, you can capture database objects from the online database quickly, by dragging and dropping selected elements between the Database Navigator and the Design Navigator.

To start the Design Capture utility from the Database Navigator:

1.	Display the Database Navigator for the required database.  How

2.	On the Database Navigator, select the database objects that you want to capture into the repository.

Note:	You can capture either database user objects or database administration objects. Either type (but not both) can be captured in a single operation.

3.	Do one of the following:

•	Choose Generate→Capture Design of→Server Model.

The Capture Server Model from Database dialog box is displayed, allowing you to specify error handling conditions, e.g. whether design capture should stop when an error is encountered.

Note:	If no repository database users are visible to the workarea, an error message is displayed, telling you that you must create one.

•	Use the drag and drop method, making sure you understand the considerations for positioning the cursor.

Considerations for positioning the cursor

The position of the cursor when you drop the selection, determines whether new database and database user definitions are created in the repository. The possible cursor positions are:

• If the cursor is positioned on empty space and there is not a repository database definition visible to the workarea with the same name as the online database, a new database and a new user are created in the repository. The names of these new repository elements are derived from the online database and user.

• If the cursor is positioned on empty space and there is a repository database definition visible to the workarea with the same name as the online database, the repository database definition is used. If the repository database definition does not have a user of the same name as the online database user, a new user is created in the repository. The name of the new repository user is derived from the online database user.

• If the cursor is positioned over a database definition and that database definition does not have a user of the same name as the online database user, a new user is created in the repository. The name of the new repository user is derived from the online database user.

• If the cursor is positioned over a user then that database user, and the database within which it is defined, are used.

Performing the drag and drop operation

Drag the selected database objects from the Database Navigator onto the DB Admin tab of the Navigator that shows repository elements


The Logic Editor

Understanding the Logic Editor

About the Logic Editor

Using the Logic Editor to define code

Creating, editing and checking logic - step by step

Displaying the Logic Editor

Importing and exporting code in the Logic Editor

Inserting constructs in the Logic Editor Code Window

Selecting, finding and replacing code

Recording macros for use in the Logic Editor

Checking the syntax of code in the Logic Editor

Undoing and redoing actions in the Logic Editor

Customizing the Logic Editor

Changing fonts and colors in the Logic Editor

Setting indentation options in the Logic Editor

Assigning shortcut keys to commands in the Logic Editor

Enabling or disabling color syntax highlighting in the Logic Editor

Hints and tips for using the Logic Editor

Tips, tricks and shortcuts for the Logic Editor


About the Logic Editor

Related Topics

The Logic Editor provides a graphical environment for developing:

•	PL/SQL functions, packages and procedures (server-side procedural logic)

•	Java source programs

•	application logic or custom code that can be embedded within generated applications

•	application logic in database triggers and commit time server-side procedures

The Logic Editor comprises a Construct Tree Window and Code Windows. A read-only Construct Tree is provided for each programming language, containing syntactically correct constructs that can be copied into the Logic Editor Code Window, making it easier and faster to construct logic. Code Windows enable you to enter, copy, cut and paste code. Code can also be copied to the Windows Clipboard and pasted into third-party applications.

When to use the Logic Editor

The Logic Editor assists the developer in building programming code for the deployment environment.

Use the Logic Editor to:

•	define PL/SQL code against PL/SQL definitions that have been created in the repository

•	define Java source code against Java definitions that have been created in the repository

•	customize the Table API and the Module Component API logic by defining your own event code segments

•	define your own code that can be embedded within generated applications

Logic Editor features

Using the Logic Editor you can:

•	Enter and edit logic. This enables you to build code both by copying predefined constructs from the Construct Tree and by entering code directly.  How

The Logic Editor provides the following text editing facilities:

−	Drag and drop editing  The process of defining logic is simplified by the ability to drag and drop predefined constructs from the Construct Tree. Thus code can be built without the need for full knowledge of the syntax. In addition, design level data (e.g. tables, views) can be copied to supply data values in program code.

−	Syntax checking  A Check Syntax utility, is available for checking PL/SQL code stored in the repository.

−	Text formatting capabilities, Features such as automatic indentation and color syntax highlighting of keywords, comments, and strings are applied to code typed directly into the Logic Editor Code Window.

−	Customizable keyboard mappings  Keystrokes can be added and removed.

−	Keystroke macros  You can record a series of keystrokes and assign a keystroke to play back the keystrokes repeatedly. Up to 10 macros may be recorded.

•	Import and export code. This enables you to reuse or modify code defined using other applications. You can import code stored in text files into the Logic Editor, and either store it in the repository, or, having edited the code using the text editing facilities, write the code back to a text file .  About


Creating, editing and checking logic - step by step

Related Topics

When using the Logic Editor you have the choice of typing in each line of code yourself, or using features that are supplied to help reduce the amount of typing that you have to do. For example, rather than typing in each construct you can insert template constructs that you then complete.

To create, edit and check logic code:

1.	Display the Logic Editor.  How

2.	(Optional)  Change the options that affect how code will be displayed in the Logic Editor Code Window, e.g., the color of comments.  How

3.	(Optional)  Import existing code created using other tools.  How

4.	Create and edit code, optionally performing the following tasks:

•	Inserting template constructs from the Construct Tree.  How

•	Recording macros.  How

•	Navigating to, replacing and bookmarking code.  How

5.	(Optional) Check the syntax (PL/SQL logic only).  How

6.	Save the code.


Displaying the Logic Editor

Related Topics

The Logic Editor comprises a read-only Construct Tree for each supported language and Code Windows in which you define code. You can copy syntactically correct template constructs from a Construct Tree Window into a Code Window.

To display the Logic Editor Code Window:

1.	From the Navigator, select the repository element for which you want to define logic.

For example, if you want to define logic for a PL/SQL procedure definition, select the procedure from the Navigator.

2.	Click [image] on the main toolbar.

Tip: 	Alternatively, use the Right Mouse button to display a popup menu and choose the Edit Logic/Edit PL/SQL option.

The Logic Editor is displayed. If the Logic Editor is already displayed, a new Logic Editor Code Window is opened.

To display or close the Construct Tree Window:

•	Choose View→Construct Tree.


Importing and exporting code in the Logic Editor

Related Topics

If you have defined code in text files using third-party applications, you can import the code in these files into the active Logic Editor Code Window. The code can then be edited as required using the drag and drop editing facilities, and the code can be stored in the repository.

Likewise, code defined using the Logic Editor can be written to a text file and used in another application.

To import a text file into the Logic Editor Code Window:

1.	Display the Logic Editor.  How

2.	Position the cursor in the Logic Editor Code Window where you want to insert text, or select the text you want to replace.

3.	Choose Edit→Import Text.

4.	In the Open dialog box, specify the path and filename of the source file and click OK.

To export the contents of the Logic Editor Code Window to a text file:

1.	Display the Logic Editor.  How

2.	(Optional)  Select the text to be exported to a text file. If no selection is made, the entire contents of the Logic Editor Code Window are exported.

3. 	Choose Edit→Export Text.

4.	In the Save As dialog box, specify the path and filename of the destination file and click OK.


Inserting constructs in the Logic Editor Code Window

Related Topics

Logic is defined in a Logic Editor Code Window associated with an instance of a repository object.

You can insert code in a Logic Editor Code Window by dragging and dropping constructs from the Construct Tree.

To insert constructs into the Logic Editor Code Window:

1.	Display the Logic Editor.  How

2.	From the Construct Tree, select the construct to be inserted and press and hold down the mouse button.

3	Drag the selection to the required insertion point in the Logic Editor Code Window.

4.	Release the mouse button.

The drag-and-drop pointer will appear when it is possible to drop the selection.

The construct is dropped immediately after the insertion point.


Recording macros for use in the Logic Editor

Related Topics

You can record up to ten macros for use within the Logic Editor Code Window. You run a macro by pressing the shortcut keys that you assigned to the macro when you created it.

To record a sequence of keys for a macro:

1.	Click the cursor at the position from which you want to start recording keyboard actions.

2.	Choose Edit→Record Macro.

A popup Record Macro window is displayed and the cursor changes to show that the Logic Editor is recording.

3.	Perform the actions that you want to be recorded using the keyboard.

For example, to record a macro that change lines of code into comment lines:

Press [Home]

Type /*

Press [End]

Type */

4.	Stop recording the macro by clicking on the Stop button in the Record Macro popup window.

5.	Enter the Shortcut keys that you want to use to run the macro, e.g., [Shift]+[Ctrl]+[F4].

Use the [Shift] and [Ctrl] keys as the first two keys of each shortcut command, e.g., [Shift]+[Ctrl]+[F4], to avoid duplication with other shortcut keys in the tool.

If your shortcut keys are already assigned to another macro a message is displayed in the dialog box.

Note:	Take care not to overwrite the existing shortcut keys supplied with the Logic Editor. Validation for duplicate keys is performed against the ten user editable macros only, therefore you are not informed if the shortcut keys you enter are already used elsewhere. You can view the existing shortcut key assignments for the Logic Editor Code Window from the Keyboard tab of the Logic Editor Options dialog box. Where the shortcut keys are defined for the tool they will be used rather than those specified for the Logic Editor Code Window.

6.	Assign the macro to one of the ten available macro slots by choosing a value from the Save As list.

You can verify the shortcut keys that you have assigned to macros by viewing the PlayMacro commands from the Keyboard tab of the Logic Editor Options dialog box.


Selecting, finding and replacing code in the Logic Editor

Related Topics

To select the entire contents of the Logic Editor Code Window:

1.	Click in the Logic Editor Code Window.

2.	Choose Edit→Select All.

To select vertical columns in the Logic Editor Code Window:

1.	On the Misc tab of the Logic Editor Options dialog box, check the Allow Column Selection box.

2.	Position the cursor at the start of the column that you want to select, hold down the ALT key and drag the mouse.

To navigate to a specific line of code in the Logic Editor Code Window:

•	Choose Edit→Go To.

•	Use bookmarks.  How

To find a text string in the Logic Editor Code Window:

1.	In the Logic Editor Code Window, position the cursor where you want the search to start.

2.	Choose Edit→Find.

3.	Enter the text for which you want to search or choose a previous search string from the list.

4.	(Optional)  Specify additional conditions for search, e.g., whether the direction of the search should be up or down.

5.	Click Find to locate a match for the search string. The next string that contains a match for the specified string is highlighted in the Logic Editor Code Window.

To find and replace a text string in the Logic Editor Code Window:

1.	In the Logic Editor Code Window, position the cursor where you want the search to start. Alternatively, if you want to search and replace part of the code only, select that part of the code.

2.	Choose Edit→Replace.

3.	Enter the text for which you want to search and replace, or choose a previous string from the list.

4.	Enter the replacement text or choose a replacement string from the list.

5.	(Optional)  Specify additional conditions for the search, e.g., whether the search is case sensitive.

6.	(Optional)  If text is selected in the Logic Editor Code Window, choose whether you want to search the selected text only (Selection) or all text in the window (Entire buffer).

7.	Click the Find Next and Replace buttons to search down the code for matching strings and optionally replace them.


Using bookmarks in the Logic Editor

Related Topics

To set a bookmark:

1.	Click the cursor on the line that you want to bookmark.

2.	Choose Edit→Toggle Bookmark.

To bookmark all lines that contain a specific search string:

1.	Choose Edit→Find.

2.	Enter the text for which you want to search or choose a previous search string from the list.

3.	(Optional)  Specify additional conditions for the search, e.g., whether the search is case sensitive.

4.	Click Mark All to insert bookmarks at the start of each line that contains a match for the specified string.

To jump to a bookmark:

•	Choose Edit→Go to Bookmark.


Checking the syntax of code in the Logic Editor

Related Topics

You can check the syntax of PL/SQL code in the active Logic Editor Code Window using the syntax checker.

To check the syntax of logic:

1.	Display the Logic Editor.  How

2.	If the Logic Editor Code Window displays a package in two panes, click on the pane that you want to check.

Note:	Packages are displayed in two panes if the Free Format Declaration property is set to Yes..

3.	Run the syntax checker, by choosing Utilities→Check Syntax.

During syntax checking the Messages window is opened, reporting any errors found. This window remains open so that you can see the error descriptions if you need to change the code.

If there are no errors, a "The Syntax Checker passed with no errors" message is displayed.

4.	Do one of the following:

•	If there are errors, click [image].

If available, the source of the error is displayed.

•	If no errors are reported, close the Messages Window.


Customizing Logic Editor settings

Related Topics

Use the Logic Editor options to customize your use of the Logic Editor. Any modifications are applied to the current session and they are automatically enabled in subsequent sessions.

Changing fonts and colors

Setting indentation options

Assigning shortcut keys to commands

Enabling or disabling color syntax highlighting

Specifying the number of actions that can be undone

For information about other ways in which you can customize the Logic Editor, see Tips, tricks and shortcuts.


Changing fonts and colors in the Logic Editor

Related Topics

You can choose the color in which each category of information is displayed in the Logic Editor Code Window. Any modifications are applied to the current session and they are automatically enabled in subsequent sessions.

To change the font/color:

1.	Display the Logic Editor.  How

2.	Choose Options→Logic Editor Options.

3.	Select the Color/Font tab.

4.	Change the colors of information categories by selecting each item and updating the assigned colors as required.

5.	Change the font for all code displayed in the Logic Editor Code Window by clicking the Change button and choosing new settings from the Font dialog box.

6.	In the Logic Editor Options dialog box do one of the following:

•	To see the effect of the changes before closing the dialog box, click Apply. When you are happy with the changes, click OK.

•	To change the settings (without first seeing the effect of your proposed changes) for this session and subsequent sessions, click OK.


Setting indentation options in the Logic Editor

Related Topics

You can choose the indentation style and specify tab settings for code in the Logic Editor Code Window. Any modifications are applied to the current session and they are automatically enabled in subsequent sessions.

To change the indentation style and tab settings:

1.	Display the Logic Editor.  How

2.	Choose Options→Logic Editor Options.

3.	Select the Language/Tabs tab.

4.	Choose whether you want automatic indentation and if so whether it should follow the scope of the language or simply follow the indentation of the previous line.

5.	Specify the size of tabs in the Tab Size field, using spaces as the unit of measure.

6.	Identify whether tabs are to be converted to spaces as you type.

7.	In the Logic Editor Options dialog box do one of the following:

•	To see the effect of the changes before closing the dialog box, click Apply. When you are happy with the changes, click OK.

•	To change the settings (without first seeing the effect of your proposed changes) for this session and subsequent sessions, click OK.


Assigning shortcut keys to commands in the Logic Editor

Related Topics

Default shortcut keys are assigned for some of the commands available in the Logic Editor. You can change these key assignments and assign new key assignments where none have been defined.

To assign shortcut keys to commands:

1.	Display the Logic Editor.  How

2.	Choose Options→Logic Editor Options.

3.	Select the Keyboard tab.

4.	Select the command for which you want to view or edit shortcut keys. A short description of the command is displayed at the bottom of the tab.

5.	To assign shortcut keys to a command, enter the key sequence in the New Key Assignment field. If the key sequence is already assigned to another command, the assignment will not take place.

6.	To remove a key assignment, select the entry in the Key Assignments field and click Remove.

7.	To return keyboard shortcuts for all commands back to their default, click Reset.


Enabling or disabling color syntax highlighting in the Logic Editor

Related Topics

Within the Logic Editor Code Window, syntax is recognized and can be highlighted with predefined colors.

To enable or disable color syntax highlighting:

1.	Display the Logic Editor.  How

2.	Choose Options→Logic Editor Options.

3.	Select the Misc tab.

4.	To turn color syntax highlighting on, check Color Syntax Highlighting.

5.	Do one of the following:

•	To see the effect of the changes before closing the dialog box, click Apply. When you are happy with the changes, click OK.

•	To change the settings (without first seeing the effect of your proposed changes) for this session and subsequent sessions, click OK.


Undoing and redoing actions in the Logic Editor

Related Topics

You can undo the most recent graphical action, such as cutting, pasting or copying text, carried out in the Logic Editor Code Window.

Note:	You can specify the number of actions that can be undone from the Logic Editor Options dialog box.

To undo the last editing action:

•	Choose Edit→Undo.

To redo the last editing action:

•	Choose Edit→Redo.

To set the number of actions that can be undone:

1.	Choose Options→Logic Editor Options.

2.	Select the Misc tab.

3.	Specify whether the number of actions that can be undone is unlimited or specify the number of actions that can be undone.


Hints and tips for the Logic Editor

Related Topics

•	Open the Logic Editor Code Window for a specific piece of logic code, by dragging the name of the code branch from the Navigator onto the work surface.

•	Data displayed in the Navigator can be copied directly into the Logic Editor Code Window (e.g., table names, column names). You can copy more than one value at a time by holding down the CTRL key while searching. A comma is entered between each value.

•	Use the Cut, Copy and Paste options from the Edit menu (or their equivalent shortcut keys) to edit text in Logic Editor Code Windows.

•	Use the Undo and Redo options from the Edit menu (or their equivalent shortcut keys). You can specify the number of actions that can be undone within the Logic Editor from the last tab of the Options dialog box.

•	You can check existing shortcut key assignments from the Keyboard tab of the Logic Editor Options dialog box.

•	Check what macros exist from the Keyboard tab of the Logic Editor Options dialog box. The macro shortcut keys are assigned to the PlayMacro commands.

•	If the Allow Column Selection option is enabled on the Logic Editor Options dialog box, you can select required columns across multiple lines, without selecting entire lines.  How

•	If the Allow Drag and Drop option is enabled on the Logic Editor Options dialog box, you can drag and drop code within the Logic Editor Code Window.

•	Assign shortcut keys to commands that you use frequently instead of using the menu options.  How

•	From the Logic Editor Options dialog box you can specify settings for the Logic Editor Code Window scrollbars and specify whether Code Windows should be split into panes.

•	If the Free Format Declaration property is set to Yes for a package, Logic Editor Code Windows are split into two panes.

•	When recording macros use the [Shift] and [Ctrl] keys as the first two keys of each shortcut command, e.g., [Shift]+[Ctrl]+[F4], to avoid duplication with other shortcut keys in the tool.


Application logic and the Design Editor

About application logic, the Design Editor, and the Oracle Designer Generators

Different types of application logic

About generatable application logic and the Design Editor

About user-defined application logic and the Design Editor

About events and event code and the Design Editor

Entering event code using the Design Editor

About named routines and the Design Editor

Entering named routines using the Design Editor


About application logic, the Design Editor, and the Oracle Designer Generators

Related Topics

Application logic is the name given to code included in applications that have been created using the Oracle Designer Generators. The term application logic applies both to code created by the Oracle Designer Generators and code you enter by hand.

The code created by the Oracle Designer Generators in generated applications is designed to meet most requirements. However, in some cases you might have particular business requirements that the generated code does not satisfy. In these cases, you can create your own application logic to extend the generated application to fully meet your requirements. Creating your own application logic might involve:

•	entering code in the repository for inclusion by the Generator in the generated application (the code you enter can be included instead of or as well as the code the Generator normally includes)

•	entering code outside the repository in templates or object libraries that the Generator will include in the generated application during generation

•	modifying code in the generated application (and optionally capturing that code back into the repository so that it can be used during future generations)

How a Generator uses application logic depends on where the application logic is entered and stored. Different names are used to precisely identify these different types of application logic. Note that not all types of application logic are relevant for all Generators.

Application logic is written in the appropriate programming language for the generated application's target environment. Clearly different languages have different terms for similar concepts, so the Design Editor presents these concepts generically as follows:

•	event code - code that executes in response to particular events

•	named routines - code that is called by event code


Different types of application logic

Related Topics

There are several main categories of application logic:

•	Application logic common to all Oracle Designer Generators.

•	Application logic derived from templates and libraries.

•	Application logic captured from generated applications.

Types of application logic common to all Oracle Designer Generators

Three different types of application logic are common to all of the Oracle Designer Generators that support application logic:

Type of application logic common to all Generators	Generators	Description
generatable application logic	Form Web PL/SQL Report Visual Basic	Outline code that a Generator may or may not generate depending on the requirements of that particular module. You can view generatable event code (but not generatable named routines) in the Design Editor, but the code is not saved in the repository. For more information, refer to About generatable application logic.
user-defined application logic	Form Web PL/SQL Report Visual Basic	Event code and named routines you define using the Design Editor and save in the repository.  You can override code that the Generator will generate (i.e. generatable application logic) with your own code. For more information, refer to About user-defined application logic.
generated application logic	Form Web PL/SQL Report Visual Basic	Event code and named routines in the generated application that have been created by the Generator from generatable application logic.
These different types of application logic can be represented graphically as follows:

Application logic from templates and libraries

Those Oracle Designer Generators that use templates and libraries during generation can include the following types of application logic in generated applications:

Type of application logic used by Generators	Generators	Description
template application logic	Form Report Visual Basic	Code in a template file (created in the target design time environment) that a Generator includes in the generated application.
object library application logic	Form	Code in an object library file (created in the target design time environment) that a Generator includes in the generated application.
These different types of application logic can be represented graphically as follows:

Capturing application logic from generated applications

Those Oracle Designer Generators that provide design capture functionality also support the following types of application logic:

Type of application logic captured by Generators into the repository	Generators	Description
user-modified generated application logic	Form Report Visual Basic	Modifications to generated code made using the target design-time environment. Captured and saved in the repository as user-modified generated application logic.
user-modified user-defined application logic	Report	Modifications to generated code made using the target design-time environment. Captured and saved in the repository as user-defined application logic.
hand-coded application logic	Form Report Visual Basic	New code added into the generated application using the target design-time environment. Captured and saved in the repository as additional user-defined application logic.
These different types of application logic can be represented graphically as follows:


About generatable application logic and the Design Editor

Related Topics

Generatable application logic is the term used to describe code that a Generator may or may not generate for a module. Whether the Generator does actually include a piece of generatable application logic in a generated module depends on the specific requirements of that module. Generatable application logic comprises two types of code

•	generatable named routines

•	generatable event code

Neither generatable named routines nor generatable event code are stored in the repository, instead they are units of code specific to the type of application that is to be generated.

The names of generatable event code are displayed in the Design Editor to show you what a Generator will generate, and to give you the opportunity to override the generatable event code with user-defined code.

Generatable named routines are never displayed in the Design Editor.


About user-defined application logic and the Design Editor

Related Topics

User-defined application logic is code that is stored in the repository and included in generated applications. User-defined application logic comprises two types of code:

•	user-defined named routines

•	user-defined event code

You can create user-defined application logic in two ways:

•	within the Design Editor you can use the Logic Editor to create event code and named routines

•	within the design environment for the generated application, you can add extra event code and named routines to the generated application and then capture the additions into the repository

If you enter user-defined application logic using the Design Editor, you have the option to override event code that the Generator will generate (i.e. generatable application logic) with your own event code.


About events and event code and the Design Editor

Related Topics

About events

In the context of a running application, an event is an operation that causes a piece of code to execute. For example, a user clicking the mouse in a new record might initiate the execution of code to validate changes made to a previous record.

The different target environments for generated applications do not necessarily recognize the same events. Even when they do recognize the same event, the event might be given a different name. For example, Oracle Forms applications, Visual Basic applications and Web PL/SQL applications recognize a mouse click as a WHEN-MOUSE-CLICK event, a CLICK event, and an ONCLICK event respectively.

About event code

Event code is the name given to code that executes in response to a particular event.

About generatable event code

Generatable event code is the term used to describe event code that a Generator may or may not generate for a module. Generatable event code is not stored in the Repository but is created during generation. Whether the Generator does actually create a piece of generatable event code in a generated module depends on the specific requirements of that module.

The names of pieces of generatable event code (but not the actual code itself) that a particular Oracle Designer Generator might include in a generated application are shown in the Design Editor. Exposing the generatable event code in this way enables you to:

•	override the generatable event code with your own user-defined event code

•	sequence your own user-defined event code within the event code generated by a Generator

Generatable event code is represented by the [image] icon.

About user-defined event code

User-defined event code is event code that is stored in the repository and included in generated applications.

You can create user-defined event code in two ways:

•	within the Design Editor using the Logic Editor

•	within the design environment for the generated application, you can add extra event code to a generated application and then capture the additions into the repository

If you enter user-defined event code using the Design Editor, you have the option to override code that the Generator will generate (i.e. generatable event code) with your own code.

User-defined event code is represented by the [image] icon.

About user-modified generated event code

User-modified generated event code is the term used to describe code included in a generated application that you have modified after generation.

Having modified the generated code, you can capture the user-modified generated event code into the repository to retain it during future generations.

User-modified event code is represented by the [image] icon.


Entering event code using the Design Editor

Related Topics

Using the Design Editor you can enter and modify event code for generated applications.

To enter user-defined event code:

1.	On the Navigator, from the Modules tab expand the Application Logic node for the appropriate element.

2.	Select the Events branch.

3.	Click [image].

4.	Select the event to which you want to add code and click Next.

Only events that are applicable to the selected element are displayed. Press F1 for Help on an events.

5.	Do one of the following:

•	Click Add to enter new user-defined event code, enter a Name for the event code, and use the Up and Down arrows to define the sequence of the event code relative to other code that may be generated for the same event.

•	Click Override (if available) to replace generatable event code with user-defined event code (if you  subsequently decide you do want the generatable event code included in the generated application, use the Revert button to discard the user-defined event code).

6.	Click Next and then select Create the definition and open the Logic Editor.

A construct tree for the appropriate language (PL/SQL or JavaScript) is displayed.

7.	Enter the code for the selected event, using the Logic Editor.

Within the event code you can make use of any native function and procedure provided by the language. You can also call named routines defined in the repository.  How

8.	Click [image] to save.


About named routines and the Design Editor

Related Topics

About named routines

A named routine is typically code to perform a particular function and which is called by several different pieces of event code.

About generatable named routines

A generatable named routine is a named routine that a Generator may or may not generate for a module. Generatable named routines are not stored in the Repository but are created during generation. Whether the Generator does actually create a generatable named routine in a generated module depends on the specific requirements of that module.

Unlike generatable event code, the names of generatable named routines are not shown in the Design Editor.

About user-defined named routines

A user-defined named routine is code to perform a particular function that is stored in the repository and included in generated applications. Typically, you will call a user-defined named routine from other user-defined application logic.

You can enter user-defined named routines in two ways:

•	within the Design Editor you can use the Logic Editor to create named routines

•	within the design environment for the generated application, you can add extra named routines to the generated application and then capture the additions into the repository

User-defined named routines are represented by the [image] icon.

If you change the language of a module, any associated named routines will remain visible only if the language type supports named routines.  However, a named routine that is no longer visible has not been deleted:  if you change the language of the module to one that supports named routines, the named routine will become visible again.

About user-modified generated named routines

A user-modified generated named routine is a named routine included in a generated application that you have modified after generation.

Having modified the generated named routine, you can capture the user-modified generated named routine into the repository to retain it during future generations.

User-modified generated named routines are represented by the [image] icon.


Entering named routines using the Design Editor

Related Topics

Using the Design Editor you can enter named routines for generated applications.

To enter a user-defined named routine

1.	On the Navigator, from the Modules tab expand the Application Logic node for the appropriate element.

2.	Select the Named Routines branch.

3.	Click [image].

4.	Enter a Name for the routine.

5.	Set any other options as appropriate.

6.	Click Next and select Create the definition and open the Logic Editor and click Finish.

A construct tree for the appropriate language (PL/SQL or JavaScript) is displayed.

7.	Enter the code for the named routine, using the Logic Editor.

8.	Click [image] to save.


About Table API logic

Related Topics

Generated Oracle Designer applications can call Table Application Programming Interface (API) procedures to insert, update, delete and lock rows in the application tables.  About

If your applications call the Table API, you can optionally define your own event code segments to perform additional operations on a table at pre-defined event points within the generated code. For example, you might define event code to record auditing information after a row is inserted or updated in a table.  How

Event code segments are units of PL/SQL and SQL logic that you write for an event on a specific table.


About Module Component API logic

Related Topics

Generated Oracle Designer applications can call generated Module Component Application Programming Interface (API) procedures to perform queries and DML operations on the application tables.  About

If your applications call the Module Component API, you can define your own event code segments to perform additional operations on a table at pre-defined event points within the generated code.  How


About user-defined event code and Server API

Related Topics

A user-defined event code is code you enter into the repository using the Logic Editor.

You can create your own event code segments for:

•	Table Application Programming Interface (API) procedures and triggers, to perform additional operations on tables before and after a row is inserted, updated, deleted or locked via the Table API.

•	Module Component Application Programming Interface (API) procedures, to perform additional operations on tables before and after queries and DML operations are performed on your application tables.

User-defined event code is represented in the Design Navigator by the [image].

Related Topics

Customizing the Module Component API

Customizing the Table API


DIALOG BOXES


Create Application Logic dialog box

Related Topics

Allows you to create application logic in the Design Editor. Application logic is the name given both to code created by the Oracle Designer Generators and code you enter by hand that the Generators include in the applications they generate.

Application logic comprises event code segments (code that executes in response to particular events) and named routines (code that is called by event code segments). Event code segments are usually associated with particular objects in a generated application, whereas named routines are typically called by several event code segments.

Dialog box options

The title for this dialog box changes according to the type of logic that is to be created (events or named routines):

•	Create Application Logic : Events

•	Create Application Logic: Named Routines


Create Application Logic : Named Routines dialog box

Related Topics

If you are creating a new named routine, this dialog box comprises both of the pages shown below. However, if you are editing an existing named routine, only the Named Routines page is displayed.

Named Routines page

Name

Type of routine

Target location (For Visual Basic/Web PL/SQL applications only)

Language (For Web PL/SQL events/routines only)

Public (For PL/SQL named routines only)

Private(For PL/SQL named routines only)

Exclude from generation

Last page

Create the logic definition with the information provided

Create the definition and open the Logic Editor to enter the logic code


The name of the routine.


The type of routine that can be referenced within user-defined events e.g. Function. This field is not applicable to Web PL/SQL named routines.


Defines the location of the generated logic.

Visual Basic applications- defines which Visual Basic form the routine should be added to during generation. This property is only applicable when defining application logic against module components and items. It enables you to define a different action on each type of form that can be generated for a single zone i.e. a single item may be displayed on a Query dialog, Property dialog, as well as the Main Form.

Web PL/SQL applications with language JavaScript- defines which HTML form the routine should be added to during generation. This property is only applicable when defining application logic against module components and items. It enables you to define a different action on each type of form that can be generated for a single module component i.e. a single item may be displayed on a Query Form, Record List, View Form and Insert Form.


(For Web PL/SQL events/routines only) Specifies the language of the logic. You can enter application logic that will sit alongside generated:

•	PL/SQL code running on the server

•	JavaScript code running in the client browser.


Choose this option if you want to declare this routine as a public routine, i.e. the routine is added to the package specification.


Choose this option if you want to declare this routine as a private routine, i.e. the routine is added to the start of the package body.


Excludes this user-defined logic from the generation process. This may be useful if you have not yet fully defined or tested the logic.


Creates the logic definition simply as a node in the Navigator, with no code defined.


Creates the logic definition as a node in the Navigator and opens the Logic Editor to enter the required code.


Create Application Logic : Events dialog box

Related Topics

If you are creating a new event this dialog box comprises all of the pages shown below. However, if you are editing an existing event, e.g., adding logic to the event, then only the Logic page is displayed.

Events page

Event box

Show expert level events

Execution Hierarchy (For Oracle Forms applications only) (Not displayed at module level)

Logic page

Name

Event code list

Show code group descriptions

Add button

Delete button

Override button

Revert button

Exclude from generation

Target location (For Visual Basic/ Web PL/SQL applications only)

Comment

Last page

Create the logic definition with the information provided

Create the definition and open the Logic Editor to enter the logic code


The name of the event to which you want to add code.


The name of the code segment for this event.


Lists the event code segments defined for this event. If this list is empty, no generatable event code, user-defined event code or user-modified event code exists.  About


Displays all events that are applicable to the selected element. Otherwise, only the most common events are displayed for that element.


Specifies whether the event (an Oracle Forms trigger) is to execute before or after an event with the same name at a higher level in the form, rather than simply overriding it:

Override	Specifies that the current trigger fires instead of any trigger by the same name at any higher scope
Before	Specifies that the current trigger fires before firing the same trigger at the next-higher scope
After	Specifies that the current trigger fires after firing the same trigger at the next-higher scope

Note, Execution Hierarchy is not applicable at module level.


Forms Generator only. Displays the event code groups by their full textual description rather than code group name.


To enter user-defined event code, click this button


To delete the selected user-defined/modified event code, click this button


To override event code that is automatically generated by an Oracle Designer Generator with your own code (user-defined application logic), select the code group and click this button.


To revert back to the original code generated by an Oracle Designer Generator, select the code group and click this button


A comment or brief description about this user-defined event code.


Application Logic for element dialog box
Application Logic for <element> dialog box

Related Topics

Allows you to view all existing user-defined and user-modified application logic for the selected element. You can also create new application logic, and edit or delete existing logic from this dialog box.

Dialog box options

List box

Lists the existing user-defined/modified application logic from which you can choose.

Close button

To close the dialog box, click this button.

Add... button

Invokes the Create Application Logic : Events dialog box where you can enter new user-defined logic or modify generated application logic.

Edit Logic button

Invokes the Logic Editor where you can define your own code that can be embedded within generated applications.

Note:	 This button is only active when an existing user-defined/modified logic definition is selected from the List box.

Properties button

Depending on the selected entry, the following Edit dialog box is displayed:

•	For an event code segment, the Edit Application <name of event code segment> dialog box is displayed.

•	For a named routine, the Edit Application Logic <name of routine> dialog box is displayed.

The dialog boxes allow you to change various application logic properties e.g., name.

Note:	 This button is only active when an existing user-defined/modified logic definition is selected from the List box.

Delete button

Invokes the Confirm Delete dialog box where you can delete the selected application logic code from the repository.

Note:	 This button is only active when an existing user-defined/modified logic definition is selected from the List box.


Create API dialog box

You can create your own event code segments for:

•	Table API procedures and triggers to perform additional operations on tables before and after a row is inserted, updated, deleted or locked via the Table API.  About

•	Module Component API procedures, to perform additional operations on tables before and after queries and DML operations are performed on your application tables.  About

Dialog box options

The title for this dialog box changes according to the type of logic that is to be created:

Create Trigger/API Code : Trigger/API Code

Create Module Component API Code : Trigger/API Code


Create Trigger/API Code : Trigger/API Code dialog box

This dialog box is displayed when you choose to define Application Programming Interface (API) code for a relational table.  About

API Code (first page)

Triggers/API Code

Logic (second page)

Name

Add button

Delete button

Exclude from generation

Comment

Last (last page)

Create the logic definition with the information provided

Create the definition and open the Logic Editor to enter the logic code


Create Module Component API Code : Trigger/API Code dialog box

This dialog box is displayed when you choose to define Application Programming Interface (API) code for a module component.  About

API Code (first page)

API Code

Logic (second page)

Name

Add button

Delete button

Exclude from generation

Comment

Last (last page)

Create the logic definition with the information provided

Create the definition and open the Logic Editor to enter the logic code


The name of the trigger or API code for which you want to define additional operations.


Internal Comments:

This file contains dialog box context sensitive help that is used by the Design Editor and its components


Action Item dialog -  -This is a  heading to improve readability of this document only.


 Each of the types of action item represents an interface object, typically a menu option or a button, on a generated application.

Action Item Type	Description
Navigation within the module	Allows navigation within a generated application.
Navigation to a different module	Allows navigation to another generated application.
Generator	Allows a standard piece of generator functionality (such as Commit) to be invoked.
Custom	Allows a specific piece of user defined code to be executed.


Lists the module components to which the navigation action item can be linked i.e. module components that are specific to the module and reusable module components that are referenced by the module. By default, this list shows only those module components whose language is the same as the module for which the item is being defined.
Identify the module component to which the item is to navigate, by selecting it from this list.


Identifies whether all module components (within the definition of the module) are shown in the list. When this box is checked, all module components are shown. When the box is unchecked (the default) only module components whose language is the same as the module for which the item is being defined are shown.


Lists the modules to which the navigation action item can be linked. By default, this list shows only those modules whose language is the same as the module for which the item is being defined.
Identify the module to which the item is to navigate, by selecting it from this list.


Identifies whether all modules are shown in the list. When this box is checked, all module are shown. When the box is unchecked (the default) only modules whose language is the same as the module for which the item is being defined are shown.


Choose whether you want to create the link to another module by creating a new module network or by using an existing module network. The existing module networks from which you can choose are displayed below.


Lists the module networks that you can use to implement the navigation action item link. This can be used only if you choose to base the link on an existing module network.


Lists the events that can be associated with the custom action item. By default, this list does not show expert level events.
Identify the events that are to be associated with the custom action item, by selecting them from this list.


 Identifies whether expert level events are shown in the list of events. When checked, expert level events are shown. The default is not to show expert level events, i.e., the box is unchecked.


 Choose this option to create the navigation action item definition and close the dialog box.


 Choose this option to create the navigation action item definition and then automatically display the Module Network dialog box to define a module network.


 Choose this option to create the custom action item definition and close the dialog box.


 Choose this option to create the custom action item definition and then automatically open the Logic Editor to define logic.


Check Constraint dialog -  -This is a  heading to improve readability of this document only.


 Lists the existing columns. Select a column from the dropdown list and click Add to Condition to place the column name in the condition.


Click this button to add the chosen column to the check constraint condition.


Cluster dialog -  -This is a  heading to improve readability of this document only.


The name of the cluster column for which you want to create a mapping to a clustered table's column.


Determines the container from which you want to choose columns for the cluster key column. Choose from the list of containers you have already used, or click the List of Values button to access more containers.


Lists the repository tables and materialized views that are available to the workarea. To display the columns that exist for each element click on the +. To create the column mapping, select the column and move it to the Columns mapped to the cluster list box.


Lists the columns that are mapped to cluster columns.


Cluster Imp dialog -  -This is a  heading to improve readability of this document only.


Display only
The name of the index that has been defined for this cluster. If this name is displayed in black, the index does not have individual storage characteristics and you can click Index Storage Dialog... to define the characteristics. If this name is displayed in red, individual storage characteristics have been defined. You can remove these characteristics by clicking Use Default Storage.


Opens the Index Storage dialog box for you to create and edit the index storage information as required.


Sets the index to use default storage characteristics. This button is dimmed if the index already uses default settings, i.e. the index name is displayed in black.


Cursor dialog -  -This is a  heading to improve readability of this document only.


Lists the parameters that are defined for this cursor.


Adds a new parameter to the list.


Removes a selected parameter from the list.


Database dialog -  -This is a  heading to improve readability of this document only.


Indicates whether a definition of an Oracle database or a different type of database is to be created in the repository.

Default: Yes


Indicates whether definitions for the users SYS and SYSTEM are to be recorded in the repository.

Default: Yes


Indicates whether a database user definition is to be recorded in the repository for the database.

Default: Yes


Indicates whether a default tablespace definition (SYSTEM) is to be recorded in the repository for the database. This definition is not used by the Server Generator.

Default: Yes


Indicates whether a default rollback segment definition (SYSTEM) is to be recorded in the repository for the database. This definition is not used by the Server Generator.

Default: Yes


Identifies whether the CONNECT default role should be recorded in the repository. If checked, the role is recorded in the repository.


Identifies whether the DBA default role should be recorded in the repository. If checked, the role is recorded in the repository.


 Identifies whether EXP_FULL_DATABASE default role should be recorded in the repository. If checked, the role is recorded in the repository.


Identifies whether the IMP_FULL_DATABASE default role should be recorded in the repository. If checked, the role is recorded in the repository.


 Identifies whether the RESOURCE default role should be recorded in the repository. If checked, the role is recorded in the repository.


Lists the nodes that have been defined for the database. You can create a new node by entering its name in this field. The node definition is recorded in the repository when Finish is pressed.


Database user dialog -  -This is a  heading to improve readability of this document only.


Display only
The tablespaces that the user has permission to use.


 Identifies the amount of space that is allocated to the user in each tablespace. Optionally enter the amount required space.


Identifies the units of space in which each tablespace quota is measured.


Lists the privileges that are not granted to the user. To grant a privilege, select the privilege and click >. To grant all privileges to the user, click >>.


Lists the privileges that are granted to the user. To remove a privilege, select the privilege and click <. To remove all of the listed privileges, click <<.


Lists the roles that cannot be performed by the user. To allow the user to perform one of these roles, select the role and then click >.


Lists the roles that can be performed by the user. To prevent the user from performing a specified role, select the role and click <.


The +Grant and -Grant buttons determine whether the user can grant access to other roles. By default, users in a role cannot grant access to other roles.

To enable users in a role to grant access to other roles, select the required role from the Roles granted list and press the +Grant button. Note, if users can already grant the role to other roles, the +Grant button is dimmed.
To stop users in a role from granting access to other roles, select the role from the Roles granted list and press the -Grant button.


Domain dialog -  -This is a  heading to improve readability of this document only.


Indicates whether the required value is specified as a range or as a specific value. If both options are enabled you must choose whether you want to specify a range or a specific value.

Range	Enabled if the defining datatype can have a range specified, e.g., DATE, NUMBER.
Discrete	Enabled if the defining datatype type can be defined as a distinct value e.g., DATE, VARCHAR2.


Indicates whether, at runtime, the values of columns in this domain are validated against a database table, rather than being checked against a list of values that has been hard-coded in the generated code.

Query	Indicates that the value of a column is validated against a database table. This means that the list of allowed values is to be loaded into a reference code table (CG_REF_CODES).
Hard code (Default)	Indicates that the values are hard-coded in the generated application and are validated from there.  Server Generator will generate check constraints to validate columns that are in the domain against the allowable values.


 Identifies whether the columns in this domain are to be updated to have the datatype, length and default value shown here. If this box is checked the columns will be updated when you click Apply or Finish.


Domain Constraint (not supplied by FK dialog)


Lists the columns in the join table. Use the Add button to insert the column names in the WHERE clause rather than typing the column names.


Click this button to insert join table column names into the WHERE clause instead of typing the column names.


File dialog -  -This is a  heading to improve readability of this document only.


Indicates whether a data file or a log file is to be created.


Foreign Key dialog -  -This is a  heading to improve readability of this document only.


Choose the way in which you want to implement the link to the join table.

If the table to which you want to join does not have a primary key, then the Join to primary key option is not available.

If the table to which you want to join does not have a unique key, then the Join to unique key option is not available.

If you do not want to create the foreign key link via a primary key or a unique key, you can choose which columns are to implement the link.


Display only
Displays the default names of the columns that will be created for the key constraint in the current table. These columns are based on those in the primary/unique key of the join table to which the join is to be made. The key names will be used unless you specify different names for the columns.


 Lists the names that are to be used for the newly created columns, instead of using the default names provided by the columns in the join table.


Lists the columns in the join table that are to be used to map to the key in the current table. Specify which columns are to be used by clicking on each entry and choosing the required column from the dropdown list.


Lists the columns that form the key constraint in the current table. Each column displayed on this side of the table must be mapped to a column in the join table. You can add further existing columns to the constraint by clicking on the empty table cell and choosing the required column from the list.


Lists the columns that have been defined for the join table, view or materialized view, but which are not part of the key constraint. To add a column to the key constraint, select the column and click >.


Lists the columns that make up the key constraint. To remove a column, select the column and click <.


Choose this option to create new columns in the current table, that are based on the key columns of the join table.


Choose this option to select existing columns in the current table, that are to link to the key columns in the join table.


Lists the unique keys that have been defined in the join table. Select the required unique key from the list.


Index dialog -  -This is a  heading to improve readability of this document only.


Indicates whether the index is for a foreign key. If Yes is selected, then the next tab allows you to choose the required foreign key. If No is selected, then the next tab allows you to select the index columns.


Lists the foreign keys that have been defined from this table or materialized view to other tables. Choose the required foreign key from this list. The foreign key columns are shown in the list box below.


Display only
Displays the columns that have been defined for the foreign key. These are the columns that the will be created for the index.


Lists the columns that have been defined for this table or materialized view, but which are not part of the index. To add a column to the index, select the column and click >. To select all columns, click >>.


Lists the columns that make up the index for the table or materialized view. To remove a column, select the column and click <. To remove all columns, click <<.


Click this button to add a function based entry, for example, UPPER(column_name). The text you enter is free format and is not validated.


 Click this button to remove a function based entry from the index. This button available only when a function based index entry is selected.


Index Storage dialog -  -This is a  heading to improve readability of this document only.


Choose what you want to do:

-	Local indexes are the most commonly used, as they are managed automatically and are the most efficient form of indexing partitioned tables.
-	Global indexes are not managed automatically, but they can provide better performance.
-	Non partitioned indexes are the default


Lists the columns that are not used to partition the index. Mandatory columns are displayed in red. To specify which of these columns are to be used to partition the index, select the columns and click >.


Lists the columns that are to be used to partition the index. To remove columns, select the columns and click <.


Display only
The name of the global index partition. To add or delete partitions go to the previous tab on this dialog box.


Display only
The name of the local index partition. To add or delete partitions go to the previous tab on this dialog box.


Inserts an empty row above the currently selected partition key entry, allowing you to insert a new partition entry.


Deletes a selected partition from the partition key in the repository.


Item Group dialog -  -This is a  heading to improve readability of this document only.


Lists the item groups and displayed items that have been defined for the module component. The + and - icons allow you to expand and collapse branches that show items within item groups. To place an item or item group in an item group, select it and click >.

Note:	The > button is dimmed if you try to perform an invalid action, e.g., trying to place the item group within itself or trying to make an item group both a parent and child of the same item group.


Lists the items and item groups that form this item group. To remove an item or item group, select the entry and click <.


Java Class Imp dialog -  -This is a  heading to improve readability of this document only.


Indicates how this Java implementation (source, class or resource) is to derive Java code. Options are:

As Source Text	(Only applicable for Java source objects)  Use Java source code defined within the Java Block property. If pre-selected, none of the other properties on this tab apply. If the Java Block property is empty, this option is not available.  Indicate where the Java object is to derive source code via the appropriate USING Sub Query, External BFILE or Key for LOB option.
USING Sub Query	Use Java code within a CLOB/BLOB/BFILE column. The appropriate sub query must be supplied.
USING External BFILE	Use Java code  within an external BFILE. A database directory and filename must be supplied.
USING Key for LOB column	Use Java code within a column named LOB in the table CREATE$JAVA$LOB$TABLE. The key value must be supplied for the LOB column.


Lists the Java definitions visible to the workarea that can be implemented.


Module dialog -  -This is a  heading to improve readability of this document only.


 Identifies whether the library module is to be a repository-based or file-based library module.

Choose repository to create a repository-based library module. For repository-based library modules, source code is entered and stored in the repository as application logic named routines. Because the code is stored in the repository, it is easy to modify and generate new library modules.

Choose File to create a file-based library module. For file-based library modules, source code is entered and stored in an Oracle common library module file (with the suffix .pll or .plx) specified by the repository module's Source Path property. Because a file-based library module is simply a reference to an existing file, it cannot be generated. The repository module definition exists simply to enable you to attach it to other module definitions.

If you choose File, you must enter the name of the file in the Source File field.


 When clicked, displays a dialog box that allows you to navigate to the required file.


 When checked, removes the path from the file shown in the Source File field.

To ensure generated applications are portable between systems, we strongly recommend you specify only the name of the library module file in the Source File field and use the appropriate Registry variables to specify the path to locate the file at runtime. The Registry variable to use depends on the Language of the repository module, as follows:

Language	Registry variable to use:
Oracle Forms	FORMS50_PATH,ORACLE_PATH
Oracle Reports	REPORTS30_PATH,ORACLE_PATH
Oracle Common Library	ORACLE_PATH


 Lists the arguments or parameters that are to be used by the application that is generated from this module definition.


 Identifies whether the argument is to be defined by a domain or by a datatype.


 Identifies the language of each called module. The languages are represented using the icons shown below.

Icon	Module Language
	Oracle Forms
	Oracle Reports
	Oracle Web PL/SQL
	Visual Basic
	All non generatable modules, i.e., PASCAL, COBOL
In addition to the icons that identify a module's language, the following icons are used to identify whether a module is of type menu or library.

Icon	Module Type
	Menu module
	Library module


 Lists the modules that are to be called from the calling module. You can create module definitions in the repository by typing their names into this table. Any modules that are created in this way have the same language as the module from which they are being called.


 Identifies the container in which a called module exists.


 Allows you to add an existing module definition to the module network. Clicking this button causes a dialog box to be displayed from which you can choose a module definition.


 Inserts a blank row into the list, into which you can enter the name of a module. The new row is added above the currently selected row.


 Removes a reference to a module from the module network.

Note:	The module definition is not removed from the repository.


 Lists the different locations at which user text can be positioned on a generated Web PL/SQL application. When the name of a location is selected from this list, the user text that is to be shown on the generated application is displayed in the User Text field.


 Identifies the user text that is to be displayed at a specific location on a Web PL/SQL application. To enter user text, select the required position from the Text Location field and then enter the text in the User Text field.


 Choose what you want to do:

Just create the module with the information provided
Creates the module definition in the repository, without defining any components.

Create the module then invoke a wizard to create a module component
Creates the module definition in the repository, then starts the Module Component Data Wizard for you to create a specific module component, i.e. a module component that can be used by this module only.

Create the module then include a reusable component
Creates the module definition in the repository, then displays a dialog box from which you can choose an existing module component to be included in the module.

Create the module then display it on a Module Diagram
Creates the module definition in the repository, then displays a Module Diagram based on the newly created module definition.


Module component dialog -  -This is a  heading to improve readability of this document only.


 Lists the different parts of a generated Web PL/SQL application for which you can provide user text. To specify text for a location, select the location in this list and enter the text in the User Text box.


Component data dialog -  -This is a  heading to improve readability of this document only.


 Optional
Lists the tables visible to the workarea. A base table usage is not mandatory as a component does not have to contain table usages, in which case it is referred to as a control block.

If you are creating a sub-component this field cannot be changed because its base table usage must match that of the owning component. If the owning component does not contain table usages, neither does the sub-component.


 Optional
Lists the tables, views and materialized views to which the base table is connected via a key constraint. Lookup table usages can be created only if a base table has been specified. Use + and - to show links to tables.
To create a lookup table, click on the table icon next to the table name. To create a chained lookup, expand the required branch and click on each of the tables that are to be part of the lookup chain. A check mark is displayed over the table icon of each of the selected tables, to show that it will be created as a lookup usage.


 Display only
Displays the default name that is used within the FROM clause of generated SQL statements and to identify columns in PL/SQL procedures and function calls. This name defaults to the table alias. To use a different identifier name, enter the name in the Name field.


 Lists the database columns that exist for the tables on which the usages are based. To specify which of these columns are to be used by this component, select the columns and click >. To select all columns, click >>.


 Lists the database columns that are to be used by the component. If a check mark is displayed next to a column, the column is to be displayed on applications that are generated from this component. To remove columns, select the columns and click <. To remove all columns, click <<.


 Display only
Displays the default name that is used to identify the item. This name defaults to the name of the column from which the item is derived. To use a different name, enter the name in the Name field.


  Click this button to reset the name shown in the Name field back to the Default Name, i.e. the name of the column on which the item is based. Only the name of the selected item (or the item on which the edit cursor is positioned) is reset.


 Lists the displayed items for which a value does not have to be entered by a generated application. To specify which of these items must have a value entered at run time, select the columns and click >.


 Lists the displayed items for which a value must be entered by a generated application. To specify that items are optional, select the items and click <.


 Lists the key constraints that can be used to create a key based link from the base table usage in this component to a base table usage in another component. The icons identify the type and direction of the link that will be created.

Icon	Key constraint type
	(Domain constraint) Creates a link, based on a domain constraint, to a usage of a domain table.
	(Foreign key) Creates a standard master detail type link.
	(Foreign key) Creates an inverted master detail type link.
	(Primary key) Creates a link, based on the primary key, to a usage of the same table in a different module component.

For information about the different types of key based links, see About key based links


 To create the component in the repository, choose this option and click Finish.


 To create the component in the repository and then specify layout details for the component, choose this option and click Finish.


Module component layout dialog -  -This is a  heading to improve readability of this document only.


 Lists the items that are used by the component, but which are not displayed on applications are generated from the component.


 Lists the items that are displayed on applications generated from the component.


 Lists the items that are displayed on applications that are generated from the module component.


 Lists the items that are to be used to provide context on a generated application.


 Opens the Column Details dialog box for the selected item. This dialog displays details about the underlying column on which the item is based.


 Lists the item groups and displayed items that have been defined for the module component. The + and - icons allow you to expand and collapse branches that show items within item groups. Use the Up and Down arrows to change the sequence and content of the item groups.


 Displays the reusable and non-reusable module components (and their sub-components) with which the List of Values component can be associated. If you choose to associate an LOV component with an item, the name of the item is displayed in the Associated Item box.


 Displays the name of the item with which the LOV component is associated.


 Click this button to remove the association to the item displayed in the Associated item box.


 Use this list in conjunction with the List of Values list to specify where LOV values are to be returned to the module component or sub-component. The list displays bound and unbound items from the module component (and any sub-components) with which the LOV component is associated. You cam optionally enter the name of an item that does not exist in the associated module component, e.g. MODULE.ITEM, however no validation is performed on the text that you enter. Use the Add button to add each mapping to the map list.


 Use this list in conjunction with the Module Component list to create mappings between the LOV and module components and sub-components. The list displays bound and unbound items in the LOV component. Use the Add button to add each mapping to the map list.


Module component table usage dialog -  -This is a  heading to improve readability of this document only.


 Lists the table definitions visible to the workarea. The table you select is the base table within a module component.


 Lists the table definitions to which the module component's base table is linked via a key constraint.


 Identifies whether a query or validate expression is specified for the table usage. Note that the help displayed for the condition (using ?) reflects the chosen condition type.


 Lists the existing columns. Select a column from the dropdown list and click Add to place the column name in the condition.


 Click this button to add the chosen column to the query.


 Lists the columns that have been defined for the table. Depending on the Show Unassigned Columns Only box, this list may or may not include columns that are used by the module component. To use a column, select the column and click >. To use all columns, click >>.


 Lists the columns that have been defined for the table and which are used by the module component. Note, a column may be used more than once. The columns are initially ordered according to the columns' Display Sequence. If you change the order of the entries in this list, you can click Resequence to Columns to return to the Display Sequence order. To remove a column, select the column and click <. To remove all columns, click <<.


 Identifies whether columns that have been selected for use by the module component, i.e. the columns shown in the Selected Items list box, are to remain displayed in the Available Columns list box. By default once a column has been selected, it is no longer displayed in the Available Columns list box. However, if you want to select a column more than once, this box must be unchecked.


 Reorders the Selected Items, according to their Display Sequence. Click this button if you have reordered the items in the Selected Items list box, and want to return them to the Display Sequence order.


 Lists the optional items that are used by the module component. To specify that an item is mandatory, select the item and click >.


 Lists the mandatory items that are used by the module component. To specify that an item is optional, select the item and click <.


 Lists the items that are not in a list of values. To specify that an item is in a list of values, select the item and click >.


 Lists the items that are in a list of values. To specify that an item is not in a list of values, select the item and click <.


Module Network dialog -  -This is a  heading to improve readability of this document only.


 Lists modules that are defined in the repository, but which are not called by the calling module. The Show All modules check box determines which modules are shown in this list. You can select one or more modules from this list.

Note:	If the calling module is a Form menu, then PL/SQL procedures and functions are shown when the Show All Modules box is checked.


 Determines which module definitions are shown in the list.
If unchecked, module definitions that are available to the workarea and which are of the same type as the calling module are shown.
If checked, all module definitions available to the workarea (that are not already called by the calling module) are shown.

Note:	If the calling module is a Form menu, then PL/SQL procedures and functions are shown when the Show All Modules box is checked.


 Lists the arguments that have been defined for the calling module. If a check mark is displayed next to an argument name, then a value has been specified. To specify the source value of each argument, select the argument and then choose the required option from the Source of Passed Values list. Selecting an item from this list causes the appropriate source field to display the argument value. If no value is assigned, the None option is selected.


 Identifies the name of the argument for which values are shown in the Source of Passed Values list and allows you to enter the names of arguments specific to this module network, if the last (empty) entry of the list of arguments is selected.


 Lists the standard arguments that exist for the calling module. If a check mark is displayed next to an argument name, then a value has been specified. The arguments that are displayed in this list are determined by the language of the called module. Selecting an item from this list causes the appropriate source field to display the argument value. If no value is assigned, the None option is selected.
The last entry in this list always displays an icon only. Use this entry to create arguments that are specific to this module network. To do this click on the empty entry and enter the argument name in the Arguments in Called Module box, then click Add.


 Adds a user defined argument that is specific to this module network. To add an argument click on the empty entry at the end of the list and enter the argument name in the Arguments in Called Module box, then click this button.


 Deletes a user defined argument that is specific to this module network. This button is available only if a user defined argument is selected from the list. Each user defined entry is identified by an icon of a person.


 Indicates whether a literal value, an item, an argument or no value is to be passed to the selected argument.


Node dialog -  -This is a  heading to improve readability of this document only.


 Lists the databases that exist for the workarea, but which are not located on this node. To record that a database is located on this node, select the node and click >.


 Lists the databases that are located on this node. To remove a database from the node, select the database and click <.


 Identifies whether databases that are not located on any nodes are displayed. When unchecked databases that do not appear on any nodes are displayed in the list.


 Lists the nodes to which this node is connected. When a node is selected in this list, information about the connection to this node are displayed in the fields to the right of the list. Use Add and Delete to specify connections between nodes.


 Creates a connection to another node.


 Removes a connection to a node.


 Lists the PL/SQL definitions that execute on this node. When a PL/SQL definition is selected in this list, information about it is displayed in the fields to the right of the list. Use Add and Delete to specify which PL/SQL definitions execute on this node.


 Opens a list box from which you can choose a PL/SQL definition that is to be executed from this node.


 Specifies that a PL/SQL definition is no longer to be executed from this node.


Oracle Object Type dialog -  -This is a  heading to improve readability of this document only.


 Lists the Oracle object type attribute definitions that have been created for the Oracle object type.


 Creates an attribute definition in the repository.


 Deletes a selected attribute definition from the table definition.


 Opens a dialog box that allows you to enter valid values for the attribute.


 Identifies whether the column is defined by a domain and datatype (i.e. it is a scalar column), Oracle object types or Oracle collection types. The value chosen from this field determines the remaining fields that are displayed on this page.


PL/SQL definition dialog -  -This is a  heading to improve readability of this document only.


 Mandatory, 40 characters
A unique name for the PL/SQL definition.


 Mandatory, 20 characters
A short name for the PL/SQL definition.


 Mandatory, 70 characters
The purpose or short description for documentation purposes.


 Lists the methods that can be used to define the PL/SQL.

Method	Description
Declarative	Use this method when defining definitions such as packages, where you want to reuse code that is defined in individual definitions.
Free Format	Use this method if you do not intend to reuse the code that is defined in individual definitions.
Operating System File	Use this method to store and maintain PL/SQL source code in third-party applications.


 Lists the parameters that have been defined for the PL/SQL definition.


 Creates an argument for the PL/SQL definition.


 Deletes an argument from the PL/SQL definition.


 Identifies how the argument is to be defined, e.g. using a datatype.


 If you have chosen to define the argument using a column, this field identifies the table within which the column exists.


 Optional, 30 characters
The exception name.


 Lists the exceptions that have been defined for the PL/SQL definition.


 Creates an exception for the PL/SQL definition.


 Deletes an exception from the PL/SQL definition.


 Lists the declarations that have been defined for the PL/SQL definition.


 Identifies how the variable or constant is to be defined, e.g. using a datatype.


 If you have chosen to define the variable or constant using a column, this field identifies the table within which the column exists.


 Allows you to base program data for this PL/SQL definition on an existing program datum in another PL/SQL definition. This list shows all variable program data constructs for each public Package visible to the workarea. Each name in the list is formed using <PACKAGE_NAME>.<PROGRAM_DATA_NAME>.

Note: The Declaration Name becomes read only when the this field is shown, because you are creating a reference to an existing program datum in a different PL/SQL Package, rather than creating a new program datum in the current PL/SQL definition.


 Indicates whether the data construct is Variable or Constant.


 Creates a declaration for the PL/SQL definition.


 Deletes a declaration from the PL/SQL definition.


 If the PL/SQL definition is complete and no further information is to be recorded, choose this option and then click Finish.


 If the PL/SQL definition is complete and you want to record a PL/SQL type, choose this option and then click Finish.


 If you want to create and then edit the PL/SQL definition, choose this option and then click Finish.


PL/SQL Type dialog -  -i.e. datastructures


 Lists the tables visible to the workarea. Choose from this list the table on which you want to base the record.


 Lists the datastructure items that are defined for the record.


 Identifies how the datastructure item is to be defined.


 If the datastructure item is to be defined by a datastructure, column, cursor or program datum, use this field to provide context. For example, if the datastructure item is to based on a column, use this field to specify the table in which the column exists.


 Identifies the object definition that is to be used to define the datastructure item.


Role dialog -  -This is a  heading to improve readability of this document only.


 Lists the privileges that are not granted to the role. To grant a privilege, select the privilege and click >. To grant all privileges to the role, click >>.


 Lists the privileges that are granted to the role. To remove a privilege, select the privilege and click <. To remove all of the listed privileges, click <<.


 Lists the roles that cannot be performed by the current role. To allow the role to perform one of these roles, select the role and then click >.


 Lists the roles that can be performed by this role. To prevent the role from performing a specified role, select the role and click <.


 The +Grant and -Grant buttons determine whether users in a role, can grant other roles access to that role. By default, users in a role cannot grant access to other roles.

To enable users in a role to grant access to other roles, select the required role from the Roles granted list and press the +Grant button. Note, if users already can already grant the role to other roles, the +Grant button is dimmed.
To stop users in a role from granting access to other roles, select the role from the Roles granted list and press the -Grant button.


Rollback Segment dialog -  -This is a  heading to improve readability of this document only.


This button displays the Create Storage Definition dialog box, allowing you to create a storage definition without exiting from the Rollback Segment dialog.


General IMP property dialog -This is a  heading to improve readability of this document only.


 Lists the repository elements for which you can specify details required to implement the element on a database.  Only elements of the appropriate type and which are visible to the workarea are shown in this list.


 Identifies whether privileges are being specified for users or roles.


materialized view property dialog -This is a  heading to improve readability of this document only.


 How to decide which option you should choose:

If you select to choose the tables and columns on which the materialized view is to be based, you can select the tables, views, materialized views and columns from a list. You can then define default values to by this materialized view for the purposes of application generation. In most cases you should select this option. This is because for all but the most complex queries, you should specify the base tables using the elements defined in the repository.

If you select to type in your own definition, the tables on which the materialized view is to be based, are defined using a free format SELECT statement, that you specify. This enables complex queries to be defined; for example, queries that contain group functions and nested statements.


 Lists the tables, views and materialized views on which the materialized view can be based. To specify which of these elements are to be used by the materialized view, select the required elements and click >.


 Lists the tables, views and materialized views on which the materialized view is to be based. To remove one or more elements from the materialized view definition, select the elements and click <.


 Lists the columns that exist for the tables, views and materialized views on which the materialized view is to be based. To specify which of these columns are to be used by the materialized view, select the columns and click >. To use all columns, click >>.


 Lists the columns that are to be used by the materialized view. To remove columns, select the columns and click <. To remove all columns, click <<.


 The name that is to be used to identify the column on a materialized view.

Default name displays the default name that is given to the column when it is created. This is the name that is used to identify the column, unless a Chosen Name is specified.
Chosen name is the name that you want to give to the column. Changing the chosen name causes the name of the column to be updated.


Click this button to reset the Chosen Name to the Default Name.


 If you choose to:

Create the materialized view now, a definition is recorded in the repository. You can then use the Server Generator to create the materialized view on a database.

Define default values, then you can record details about the materialized view for application generation. For example, you can specify which columns will normally be displayed as items on generated applications.


 Lists the columns that will not normally be displayed as items on generated applications. To specify which columns are normally to be displayed as items on generated applications, select the columns and click >. To display all columns, click >>.


 Lists the columns that will normally be displayed as items on generated applications. To remove columns from display, select the columns and click <. To remove all columns, click <<.


 The SELECT statement that specifies the base tables and columns from which the materialized view is derived.
For example,
SELECT ALIAS1.COL1 ALIAS1_COL1
FROM TABLE1 ALIAS1

This field is display only.


 Lists the tables, views and materialized views on which the materialized view can be based. Select an entry from the dropdown list and click Add to place the element name in the materialized view definition above.


 Lists the columns that exist for the table, view or materialized view displayed in the list box above. Select an entry from the dropdown list and click Add to place the column name in the materialized view definition above.


 Click this button to add the chosen table, view or materialized view to the materialized view definition.


 Click this button to add the chosen column to the materialized view definition.


 This button displays additional information about the column on which the item is based.


 Display only
The name of the item.


Snapshot Imp property dialog -This is a  heading to improve readability of this document only.


 Display only
Lists the names of the materialized view's underlying elements.


 Lists the names of the users for which the materialized view tables are to be implemented. By default these are implemented for the user as the underlying element. If an element is to be implemented for a different user than that shown, choose the required user from the dropdown list.


Snapshot Refresh Group property dialog -This is a  heading to improve readability of this document only.


 Lists the materialized views that exist for the database but which are not in the materialized view refresh group. To add a materialized view to the group, select the materialized view and click >. To add all materialized views to the group, click >>.


 Lists the materialized views that are in the materialized view refresh group. To remove a materialized view from the group, select the materialized view and click <. To remove all of the listed materialized views, click <<.


 Identifies whether a default rollback segment is to be used by the materialized view refresh group. If you do not want to use the default rollback segment, choose No and choose the name of the required rollback segment from the list below.

Default: Yes


Table dialog -This is a  heading to improve readability of this document only.


 Indicates whether audit columns are to be created in the repository for this table. The audit columns record details such as the date that the definition was created and which user created the definition.


 Lists the table definitions that exist in the repository, to which this table can be joined via a foreign key. Only tables for which a primary key is defined (with primary key columns), are shown in this list.


 Shows the foreign keys to be created for the table. Click on the + to view the foreign key columns. These column definitions will be created in the table you are creating.


 Deletes a selected foreign key from the table definition.


 Lists the column definitions that have been created for the table. Mandatory column names are colored red. The datatype for each column is identified by an icon.


 Creates a column definition in the repository.


 Deletes a selected column definition from the table definition.


 Opens a dialog box that allows you to enter valid values for the column.


 Displays the domains that you can use to apply a set of validation rules to the column.


 Identifies whether a domain is to be created from the selected column.


 Lists the columns that have been defined for this table, view or materialized view, but which are not part of the key. To add columns to the key, select the columns and click >.


 Lists the columns from which the key is derived. To remove columns, select the columns and click <.


 To create the table definition with the information that you have specified so far, click Create the table definition now option. and click the Finish option.


 To define how the table will be used by generated applications, click this option and then click Next.


 Lists the columns on this table that will not be displayed on a generated application. To display one of these columns on a generated application, select the column and then click >. To display all of these columns on a generated application, click >>.


 Lists the columns on this table that will be displayed on a generated application. To remove one of these columns from a generated application, select the column and click <. To remove all of these columns from a generated application, click <<.


 Display only
Displays the names of the columns that are defined for the table.


 Records the table definition in the repository when you click Finish.


 Records the table definition in the repository and invokes the Create Index dialog box when you click Finish. This option is unavailable if no columns have been defined for the table.


 Records the table definition in the repository and invokes the Create Trigger dialog box when you click Finish. This option is unavailable if no columns have been defined for the table.


 Records the table definition in the repository and invokes the Create Foreign Key dialog box when you click Finish.


 Records the table definition in the repository and invokes the Create Unique Key dialog box when you click Finish. This option is unavailable if no columns have been defined for the table.


Table IMP dialog -  -This is a  heading to improve readability of this document only.


 The name of the user for which privileges are being granted.


 The name of the role for which privileges are being granted.


 Indicates whether a synonym is to be automatically created by the Server Generator when the database object is in a different schema to this user or role. A check mark is used to indicate that the synonym will be automatically created. Click on this field to add or remove the check mark.


 Indicates whether the user or role has the privilege to grant access to other database users. A check mark is used to indicate that the privilege is granted. Click on this field to add or remove the check mark.


 Indicates whether all privileges are granted to the user or role. A check mark is used to indicate that all privileges are granted. Click on this field to add or remove the check mark.


 Indicates whether the SELECT privilege is granted to the user or role. A check mark is used to indicate that the privilege is granted. Click on this field to add or remove the check mark.


 Indicates whether the INSERT privilege is granted to the user or role. A check mark is used to indicate that the privilege is granted. Click on this field to add or remove the check mark.


 Indicates whether the DELETE privilege is granted to the user or role. A check mark is used to indicate that the privilege is granted. Click on this field to add or remove the check mark.


 Indicates whether the UPDATE privilege is granted to the user or role. A check mark is used to indicate that the privilege is granted. Click on this field to add or remove the check mark.


 Indicates whether the ALTER privilege is granted to the user or role. A check mark is used to indicate that the privilege is granted. Click on this field to add or remove the check mark.


 Indicates whether the INDEX privilege is granted to the user or role. A check mark is used to indicate that the privilege is granted. Click on this field to add or remove the check mark.


 Indicates whether the REFERENCE privilege is granted to the user or role. A check mark is used to indicate that the privilege is granted. Click on this field to add or remove the check mark.


 Indicates whether the EXECUTE privilege is granted to the user or role. A check mark is used to indicate that the privilege is granted. Click on this field to add or remove the check mark.


 This privilege is not applicable to this implementation.


 Lists the indexes, primary keys and unique keys that have been defined. Icons are used to distinguish between each of these types. Entries in this list, for which index storage details have already been specified, are displayed in red.


 Opens the Index Storage dialog box for the entry selected in the Index list. This dialog allows you to create and edit index storage information as required.


 Sets the selected index, primary key or unique key to use default storage characteristics. This button is dimmed if the selected entry already uses default settings, i.e. the element name is displayed in black.


 Lists the columns that are not used to partition the table. Mandatory columns are displayed in red. To specify which of these columns are to be used to partition the table, select the columns and click >.


 Lists the columns that are to be used to partition the table. The columns shown in this list constitute a partition key column. The maximum number of columns that can be in the key is 16. To remove columns, select the columns and click <.


 Creates a new table partition definition in the repository.


 Removes a table partition definition from the repository .


 Lists the table partitions that have been defined. To create more table partitions, go to the previous page.


Tablespace Segment dialog -  -This is a  heading to improve readability of this document only.


 The database users that use this tablespace.


 Quotas identify the amount of space that is allocated to the user in each tablespace. Optionally enter the amount required space.


 Identifies the units of space in which each tablespace quota is measured.


 Records the tablespace definition in the repository when you click Finish.


 Records the tablespace definition in the repository and invokes the Create Datafile dialog box when you click Finish.


 Records the tablespace definition in the repository and invokes the Create Rollback Segments dialog box when you click Finish.


Trigger dialog -  -This is a  heading to improve readability of this document only.


 Lists the columns that are not part of the trigger. To specify which of these columns are to be included in the trigger, select the columns and click >. To include all columns, click >>.


 Lists the columns that are to be used by the trigger. To remove columns, select the columns and click <. To remove all columns, click <<.


 How to decide which option to choose:

Choose the first option to record a definition of the trigger in the repository.

Choose the second option to record the trigger definition and then invoke the Logic Editor to refine the definition.


Unique key Property dialog -This is a  heading to improve readability of this document only.


 Lists the columns that have been defined for this table, view or materialized view, but which are not part of the key. To add columns to the key, select the columns and click >.


 Lists the columns from which the key is derived. To remove columns, select the columns and click <.


Unbound item Property dialog -This is a  heading to improve readability of this document only.


Optional
Defines a client side function that is used by a generated application to derive the value of the unbound item. Client side functions are written in the language of the application. For example, for a Web PL/SQL application the client side function may be written in JavaScript. Use the Add button to insert a bound item into the expression.


Optional
Lists the bound and unbound items that exist for the module component. Use the Add button to insert an item into the expression.


Adds the chosen item to the client side expression.


 Optional
Lists the functions that can be used to compute the value of an unbound item. The chosen function uses the value of the item chosen from the Items Used list.


Optional
Specifies the item on which the computed item is based. You can base the computed item on a bound item that exists for the module component, by choosing the item from the list. Alternatively, you can enter the name of another item in the format MODULE_COMPONENT.ITEM_NAME. The item specified here is used with the chosen function to compute the value of the unbound item.


Optional
Defines the PL/SQL expression that is used by a generated application to derive the value of the unbound item.


Optional
Defines the SQL expression that is used by a generated application to derive the value of the unbound item.


Optional
Lists the functions that can be performed from the SQL expression. Use the Add button to insert a function (along with a chosen item) into the expression.


Optional
Lists the bound items that exist for the module component. Use the Add button to insert an item (along with a chosen function) into the expression.


Adds the chosen function and item to the SQL expression.


Identifies whether expert level functions are included in the Function list.


Optional
Defines the PL/SQL expression that is used by a generated application to derive the value of the unbound item.


Optional
Lists the PL/SQL subprograms that can be performed from the expression. These must be defined in the container. Use the Add button to insert a subprogram (along with a chosen item) into the expression.


Optional
Lists the bound items that exist for the module component. Use the Add button to insert an item (along with a chosen subprogram) into the expression.


Adds the chosen subprogram and item to the expression.


Optional
Defines the expression that is used by a generated application to derive the value of the unbound item.


Optional
Lists the functions that can be performed from the SQL expression. Use the Add button to insert a function (along with a chosen table and column) into the expression.


Optional
Lists the tables that are used by the module component. Use the Add button to insert a table (along with a chosen function and column) into the expression.


Optional
Lists the bound items that exist for the chosen table. Use the Add button to insert a column (along with a chosen function and table) into the expression.


Adds the chosen function, table and column to the expression.


Optional
Defines the expression that is used by a generated application to derive the value of the unbound item.


Optional
Lists the bound and unbound items that exist for the module component. Use the Add button to insert an item into the expression.


Adds the chosen item to the expression.


View Property dialog -This is a  heading to improve readability of this document only.


 How to decide which option you should choose:

If you select to choose the tables and columns on which the view is to be based, you can select them from a list. You can then define default values to by this view for the purposes of application generation. In most cases you should select this option. This is because for all but the most complex queries, you should specify the base tables using the elements defined in the repository.

If you select to type in your own definition, the tables on which the view is to be based, are defined using a free format SELECT statement, that you specify. This enables complex queries to be defined; for example, queries that contain group functions and nested statements.


 Lists the tables, views and materialized views on which the view can be based. To specify which of these elements are to be used by the view, select the required elements and click >.


 Lists the tables, views and materialized views on which the view is to be based. To remove one or more elements from the view definition, select the elements and click <.


 Lists the columns that exist for the tables, views and materialized views on which the view is to be based. To specify which of these columns are to be used by the view, select the columns and click >. To use all columns, click >>.


 Lists the columns that are to be used by the view. To remove columns, select the columns and click <. To remove all columns, click <<.


 The name that is to be used to identify the column on a view.

Default name displays the default name that is given to the column when it is created. This is the name that is used to identify the column, unless a Chosen Name is specified.
Chosen name is the name that you want to give to the column. Changing the chosen name causes the name of the column to be updated.


 The SELECT statement that specifies the base tables and columns from which the view is derived.
For example,
SELECT ALIAS1.COL1 ALIAS1_COL1
FROM TABLE1 ALIAS1

This field is display only.


 Optional
The SELECT statement that specifies the base tables and columns from which the view is derived. For example, enter the SELECT statement, omitting the keyword SELECT.

DNAME, MIN(SAL), MAX(SAL), AVG(SAL)FROM EMP, DEPT

Use the list boxes below to add the required table, view, materialized view and column names where appropriate. The SELECT keyword is generated automatically by the Server Generator.


Optional
A restriction or join condition for the view, specified in a WHERE clause. This clause defines a condition on the SELECT statement (that defines the view) that must be met in order for rows resulting from the query to be returned. For example, if the query is to retrieve data from more than one table, you can specify the join condition using a WHERE clause. If no condition is specified, all rows in the table are returned.


 Lists the tables, views and materialized views on which the view can be based. Select an entry from the dropdown list and click Add to place the element name in the view definition.


 Lists the columns that exist for the tables, views or materialized view displayed in the list box above. Select an entry from the dropdown list and click Add to place the column name in the view definition.


 Click this button to add the chosen table, view or materialized view to the view definition.


 Click this button to add the chosen column to the view definition.


 Click this button to validate the free format text and create/delete the view columns in the repository accordingly.


 If you choose to:

Create the view now, a definition of the view  will be recorded in the repository. You can then use the Server Generator to create the view on a database.

Define default values, then you can record details about the view for application generation. For example, you can specify which columns will normally be displayed as items on generated applications.


 Lists the columns that will not normally be displayed as items on generated applications. To specify which columns are normally to be displayed as items on generated applications, select the columns and click >. To display all columns, click >>.


 Lists the columns that will normally be displayed as items on generated applications. To remove columns from display, select the columns and click <. To remove all columns, click <<.


 Displays additional information about the column on which the item is based.


 Display only
The name of the item.


View Imp Property dialog -This is a  heading to improve readability of this document only.


 Display only
Lists the names of the view's underlying elements.


 Lists the names of the users for which the view tables are to be implemented. By default these are implemented for the user as the underlying element. If an element is to be implemented for a different user than that shown, choose the required user from the dropdown list.


Available Modules for Module Network dialog box

This dialog box allows you to choose a module that is to be part of a module network, when you are creating or editing a module definition.

Available modules list box
Lists the modules that are available to the workarea, but which are not called by the calling module. The Show All modules check box determines which modules are shown in this list. You can select one or more modules from this list.

Show All Modules check box
If unchecked, only module definitions of the same type as the calling module are shown. If checked, all module definitions available to the workarea (that are not already called by the calling module) are shown.

Note:	If the calling module is a Form menu, then PL/SQL procedures and functions are shown when the Show All Modules box is checked.


Allowable Values dialog box

Dialog box options

Range/Discrete

Indicates whether the required value is specified as a range or as a specific value. If both options are enabled you must choose whether you want to specify a range or a specific value.

Range	Enabled if the defining datatype can have a range specified, e.g., DATE, NUMBER.
Discrete	Enabled if the defining datatype type can be defined as a distinct value e.g., DATE, VARCHAR2.
Low Value, Optional, 40 characters

The lowest valid number in the range of allowable values.

High Value, Optional, 40 characters

The highest valid number in the range of allowable values.

Value, Optional, 40 characters

A valid value for the data that is to be entered into this column. Each valid value that you define is recorded against the column definition in the repository as an Allowable Value.

Meaning, Optional, 240 characters

The full meaning of the value entered in the Value field. This is useful for documentation purposes if the value is a code.

Abbreviation, Optional, 20 characters

An alternative, shorter value that can be used instead of the value or meaning.

Add

Inserts a line for you to enter a new value above the currently selected value.

Delete

Deletes a value from the list of valid values.

Do you want to query valid values from the database?

Indicates whether, at runtime, the value of the column is validated against a soft-coded database table, rather than being checked against a list of values that has been hard-coded in the generated code.

Query	Indicates that the value of a column is validated against a soft-coded database table. This means that the list of allowed values is to be loaded into a reference codes table (CG_REF_CODES).
Hard-code (Default)	Indicates that the values are hard-coded in the generated application and are validated from there.  Server Generator will generate check constraints to validate columns against the allowable values.
Can the user enter values that are not in the list?

Indicates whether the allowable values are used at runtime as a suggestion list, rather than a list that strictly enforces the column's value. This should be set to Yes if you are going to implement an item with a combo-box.

Yes	Indicates that the list is used as a suggestion list.
No (Default)	Indicates that the list values are enforced. Server Generator will generate check constraints to validate columns against the allowable values.


Nodes in workarea dialog box

This dialog box lists the names and types of the nodes visible to the workarea. Use this dialog box to select the nodes to be used for a network connection.

To choose a node, select it from the list and click OK.


Associate PL/SQL Definitions with Nodes dialog box

This dialog box lists the names and purposes of the PL/SQL definitions visible to the workarea. Use this dialog box to select the PL/SQL definitions with which the node is to be associated.

To choose a PL/SQL definition, select it from the list and click OK.

For information about PL/SQL definitions, see PL/SQL definitions.


Common Fields


 Display only
Lists the storage parameters that will be used for database implementation. The values in this list apply to the storage definition


Common Buttons


 To close this dialog box without saving any changes you've made, click Cancel.


 To get more help, click Help.


 To close this dialog box and save any changes you've made, click Finish.


 To apply any changes you've made without closing the dialog box, click Apply.


 To move to the next page, click Next. This button is dimmed if mandatory information has not been entered on the current tab or if the last tab is displayed.


 To move to the previous page, click Back. This button is dimmed if the first tab is displayed.


 To move a selected entry up the list, click this button.


 To move a selected entry down the list, click this button.


 To move entries that are selected in the right list box into the left list box, click this button.


 To move entries that are selected in the left list box into the right list box, click this button.


 To move all entries that are displayed in the right list box into the left list box, click this button.


 To move all entries that are displayed in the left list box into the right list box, click this button.


 Displays a dialog box from which you can edit additional related properties.


 To insert an entry, below the selected item, click this button.


 To delete the selected entry, click this button.


 Opens the browse dialog box for you to choose the file/path name.


 This icon identifies that the last page of the dialog box is displayed.


 Invokes a Text Editor which provides you with additional text editing features to those available from the default text entry box.


 Invokes an HTML Editor, which provides you with additional text editing features to those available from the default text entry box.


Opens the Create Storage Definition dialog box, allowing you to create a storage definition without exiting from this dialog box.


About data warehousing

Related Topics

Data warehousing is a process that integrates enterprise wide information into a single information system that supports business decisions and is easily accessed by end users.

Data sources may be internal or external to a business and may be stored in a variety of ways, e.g. relational databases, hierarchical databases and flat files. For example, a company's data warehouse would contain internal information, such as employee details, sales revenue, but it may also contain external data such as competitor's reported revenues for comparison purposes. Primarily, data sources are internal to an organization and are largely based on operational data.

The information held in data sources must be loaded into data warehouses and data marts. A load manager should verify the data being loaded and manage any errors that occur during the load process. Prior to being loaded all inconsistencies in the data must be removed or rationalized. Inconsistencies can take many forms, for example, dates and addresses maybe stored in different formats across different data sources. This rationalization is often called the transformation stage and is part of what is commonly referred to as the Extraction, Transformation and Transportation (ETT) process.

Periodically data warehouses/marts are refreshed with new data, gradually creating a historical bank of information that can be used for analysis and reporting. In most cases, the data cannot be updated by end users and provides a secure method for accessing data.

Metadata is an essential component in data warehouse environments. It is often referred to as "data about data". Specifically, metadata describes how data warehouse information is designed and structured and how data source information maps to information in the warehouse. Within a warehouse environment there are two types of metadata:

•	User metadata, which is essentially a guide to help users access and use warehouse data effectively. It describes the location and structure of the data in a way that can be understood by end users. End user metadata also provides information such as, how the data is derived or who within the organization is responsible for areas of data. User metadata may also be referred to as business metadata.

•	Extraction, Transformation and Transportation  (ETT) metadata, describes the structure of data in the data sources, how it is to be transformed and where it is to be loaded into the warehouse. This type of metadata records detailed information such as, data types, transformation rules, refresh information and how data selected from source systems maps to fields in the warehouse.

Summary data is precalculated numeric data such as sales totals per year, and is stored with the warehouse. Summary data is an important factor in data warehousing as it ensures good performance on queries.  About

Once the warehouse data is in place and query tools have been provided, it can be accessed by end users, such as, analysts and sales people. You can help the performance of the warehouse by monitoring queries. For example, you can increase the priority of frequently used queries and schedule lower priority queries to run when the system is less busy.


When to use data warehousing

Related Topics

Some of the main reasons why businesses choose to implement a data warehouse are:

To query large amounts of data without impacting transaction processing

Traditional online transaction processing systems are required to perform transactions within acceptable time constraints. Potentially, reports and queries that are run on the same server as transaction processing systems can reduce system performance, delaying processing times. Creating a data warehouse on which querying and reporting operations can be performed, can help to resolve this problem.

To increase the retrieval speed of data

When designing transaction processing systems, retrieval speed of data is one of many requirements that must be considered. Therefore, a compromise must be reached, ensuring that all requirements are satisfied, including acceptable data retrieval speeds. When designing a data warehouse, the requirements are different to that of an OLTP system, allowing methods that maximize retrieval speeds to be deployed. For example, in data warehouses bit-mapped indexing is may be used to improve the speed of querying and reporting, however, these types of indexes are not suitable for transaction processing.

To provide a single source of "clean" data

Legacy systems often result in data being stored in different formats and on different servers. For example, a company may have several databases, each of which contains different sets of information about employees. Details such as an employee's address, could potentially be stored in slightly different formats, but it may not be viable to update the existing systems to correct the inconsistency. Data warehouses and data marts provide an opportunity to clean up data without changing existing systems.

To provide access to historical data

In most cases old data is removed from online transaction processing systems to ensure that processing times are maximized. However, by storing historical data (in addition to current data) on a data warehouse it can be accessed at all times. This access to historical data is particularly useful for finding details for a particular point in time. For example, you may want a report showing the number of people who bought a particular make and model of car in the first quarter of 1996, but that make and model may no longer be in production.


About data warehouses and data marts

Related Topics

Data warehouses and data marts are collections of information, derived from data sources, that support an organization's decision making processes. They share the following basic characteristics:

•	Data is organized by subject area to support handling of large amounts of data. For example, within a business a subject area might be Products or Personnel.

•	Data is rationalized, to eradicate anomalies between different data sources.

•	Data is not updated in the traditional way that an operational system is updated (UPDATE, INSERT, DELETE operations). Instead, periodical batch updates are made, such as, loading new data and compressing existing data where details become less significant over time.

•	It is common for end-users to have read only access to data warehouses and data marts.

•	Data spans many years providing access to historical data and allowing access to information for a specific point in time.

The fundamental difference between data warehouses and data marts is the scope of data they contain and the processing required to support and deliver that data to business users.

Data warehouses incorporate enterprise wide information and can therefore be time consuming and costly to implement. There are no definitive rules specifying the process that you should follow when designing data warehouses. However, due to their size and complexity, it is common for them to be built using an incremental development approach. Using this approach subject areas are implemented one at a time, gradually building up an enterprise wide warehouse.

Data marts incorporate only a subset of an enterprise's data, focused on specific functions or activities of the enterprise. For example, measuring and forecasting sales performance, or measuring the impact of new product introductions on company profits. An organization may choose to implement one or more data marts instead of a data warehouse for a number of reasons, e.g. different departments may only ever need access to subsets of information. Data marts can be used as stepping stones towards creating a data warehouse. However, care must be taken to avoid inconsistencies in the information held in the individual data marts to make the transition to a data warehouse as smooth as possible.


Overview of the data warehousing process

Related Topics

Creating a data warehouse is a complex and lengthy process. This overview describes at a high level the main tasks that you must perform when creating a data warehouse. Oracle Designer supports each of these tasks.  About

To create a data warehouse:

1.	Analyze and define the requirements of the business users. For example, what level of detail is required and how often should data be refreshed?

2.	Identify the sources from which data will be loaded into the warehouse.

3.	Design the physical data warehouse model.

4.	Map the data sources to the warehouse model.

5.	Identify and record the data extraction, transformation and transportation (ETT) procedures that must be performed to get the source data into the warehouse

6.	Create the physical database.

7.	Populate the data warehouse.

8.	Provide users with access to the warehouse.


How Oracle Designer supports data warehousing

Related Topics

Oracle Designer supports the generation of simple warehouse models, i.e., star models and snowflake models. About

Data warehousing support has been added to Oracle Designer server modeling tools and also to the design and generation environment.

Data warehousing support during server modeling:

Entity Relationship Diagrammer	Using Entity Relationship Diagrams, you can record your high level design graphically, classifying entities as either 'facts' or 'dimensions' using the Data Warehouse Type property. This information is used by the Database Design Transformer to create a first cut database design of the warehouse in the Repository.
Database Design Transformer	For each entity that has been classified as a 'fact' the Database Design Transformer (DDT) creates table definitions of type 'fact' in the Repository. In addition, for each fact table, appropriate primary key constraints, foreign key constraints and BITMAP index definitions are created.
Data warehousing support during design and generation (Design Editor):

Server Model Diagrams	Using Server Model Diagrams, you can record your database design graphically, classifying tables as 'facts' or 'dimensions' using the Data Warehouse Type property.
Property Dialog boxes	The Design Editor allows you to record your database design in the Repository using either Property Dialog boxes or Property Palettes. The Property Dialog boxes validate tables classified as facts or dimensions, to ensure that your design conforms to star/snowflake models. For example, the Table dialog box issues warnings if you create foreign key constraints between two fact tables, because it does not follow the star /snowflake model.
Server Generator	The Server Generator issues warnings if a design does not conform to star/snowflake models. For example, warnings are issued if BITMAP indexes are defined for dimension tables and if fact tables exist without BITMAP indexes.

To utilize data warehouse features during server model transformation and database generation, the Data Warehouse? Property of your application system must be set to 'Yes'.


Data warehouse models (stars/snowflakes)

Related Topics

Using Oracle Designer you can generate two data warehouse models, i.e., star models and snowflake models. Both these models comprise a single fact and one or more dimensions. One of the dimensions must be 'time' as obtaining information for a specific time is a key feature of data warehousing.

Star Models

These are the simplest form of model that you can use to implement a data warehouse or data mart. They consist of a central fact table from which multiple dimension tables radiate.  For information about star queries, see the Oracle8 Server Concepts manual.

Snowflake models

These are further normalized than star queries. Therefore they are less restrictive and are more suitable than star models for modeling business data requirements.


Categories of data used in data warehousing

Related Topics

Within a data warehouse environment data can be classified into three main categories:

•	Fact data

•	Dimension data

•	Summary data

Fact data

Fact data represents what it is about a business that requires analysis. For example, in a sales organization the fact data is likely to be sales figures. The bulk of an organization's data is stored in fact tables. Warehouses typically contain many fact tables which store numerical data such as units sold. Each fact table contains multi-part primary key values, of which each part references a dimension. Fact data may also be referred to as detail data.

Due to the volume of data stored in fact tables, they are often partitioned into smaller units of data to improve performance. Generally, fact data is frequently refreshed and is continually growing in size.

Dimension data

Dimension data is the information used to perform queries on fact data. Dimensions contain columns which are the key values that link to fact tables. Although dimension data does change, it does not usually require the same type of frequent updates and refreshing that fact data needs.

The number of dimension tables in a warehouse model is determined by user's query requirements. For example, in a simple model there could be as few as three dimension tables. Dimension tables may share fact and summary tables.

Time dimensions are critical in data warehouse models as they provide the ability to perform accurate analysis over time periods. The time periods may be simple, e.g. days and weeks, or more complex, e.g. fiscal periods and seasons. For example, a sales organization may want to know how products sell during different seasons.

Summary data

Summary data is summarized fact data which can provide immediate answers to requests for aggregated data. Summary data can be derived from fact tables or from existing summary tables. A number of facts can be combined into a single summary table.

Using summary tables can help to reduce the query calculations that are frequently performed. The degree to which you summarize the data that is held on the database tables will impact the usability and performance of the warehouse. You should find a balance that provides a warehouse that contains all of the necessary information, and which also has acceptable performance.

Summary tables contain key columns that link to dimensions.


Creating a data warehouse using Oracle Designer

Related Topics

Within Oracle Designer there are three main approaches to database design and generation:

•	Analysis - A top-down approach based on defining the system requirements as an entity-relationship model.

•	New Design - Use this approach to rapidly design a database design from scratch.

•	Design Capture - A bottom-up approach which extracts SQL definitions from an existing database catalog or file and produces Repository definitions from the design. You can modify the design in the Repository and use it to update the original database or to migrate the design to another target.

In general, these approaches can be applied to data warehouse design within Oracle Designer. However there are differences between how you use Oracle Designer to create a traditional online transaction processing database and to create a database that is to be used for data warehousing. The main differences are outlined below.

Setting up the Application System

Before you start to record a data warehouse design in the Repository you must create a data warehouse application system. To create a data warehouse application system, use the Repository Object Navigator to create an application system and set the Data Warehouse? Property of the application system to 'Yes'.

The data warehouse flag on the application system indicates to Oracle Designer that validation must be performed on the design to ensure that it conforms to a star/snowflake model. This flag also ensures that default values suitable for data warehouse designs are presented when elements are created in the Repository.

During the analysis stage

If you choose to start your design from the analysis level, you specify entities as 'fact' or 'dimension' using the Data Warehouse Type property. The Database Design Transformer uses this information to create corresponding fact or dimension tables in the Repository. For each entity that is implemented as a fact table, the transformer creates a BITMAP index.

During the database design stage

For each distinct business area, create a Server Model Diagram, identifying the tables that are to be implemented and the relationships between them. If you used the Database Design Transformer to create a first cut database design, the resulting tables will already be classified as facts for dimensions. You can check this using the tables' Data warehouse Type property.

Even if you have created a detailed logical model and used the Database Design Transformer to generate a first cut design, it is likely that you will need to define new tables. The Design Editor provides you with Property Dialog boxes which validate that the elements you create conform to star/snowflake models.

Enhancing a data warehouse design

After you have created your basic database design, you should refine and enhance it. This area can be split into two categories.

•	Recording supporting information about the data that is to be stored in the warehouse. For example, you should record design decisions about the data in a warehouse and the relationships between that data.

•	Recording information about the database that is to be generated, such as storage details and tables are to be partitioned.

After generating the data warehouse:

•	Populate the data warehouse. There are many methods that you can use to populate your data warehouse. Oracle Designer allows you to create PLSQL definitions in the Repository, that can be used to transport rationalized data into the warehouse.

•	Provide users with access to the warehouse. Use Oracle Designer to generate the applications necessary for end-users to access the information held in the data warehouse. You can quickly generate Oracle Forms applications, Oracle Reports applications and WebServer applications.


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.


Utilities - Copy with new language
Copy with New Language (Utilities Menu)

Related Topics

Creates a new module definition as a copy of an existing definition. The new module component must be based on a different language to the element from which it was copied. For example, you can create a Visual Basic module that is based on an existing Oracle Forms module.

Note:	This utility is specifically for creating copies of definitions with different languages. To copy a definition without changing the language, choose Utilities→Copy Object.

Dialog box options

Short Name

A display only field that identifies the short name of the module that you want to copy. The definition must be a module.

Language

A display only field that identifies the language of the definition that you want to copy.

New Short Name

Identifies the short name of the new definition that is to be created.

New Language

Identifies the language of the new definition that is to be created. The list shows the languages from which you can choose. Notice how the language of the definition from which you want to make the copy is not shown in the list.


Utilities - Map Unbound Items
Map Unbound Items (Utilities Menu)

Related Topics

Changes unbound items into bound items. Unbound items are those which are not mapped directly to a database column.

The database columns are identified using the module component table usage alias and the column name, for example Dept.Deptno, where Dept is the table usage alias and Deptno is the column name. Additionally, the type and length of the database column are displayed in brackets after the name, for example Dept.Deptno (VARCHAR2 240).

Dialog box options

Unbound Items

Lists all of the unbound items for a selected module component.

Columns

Lists the database columns to which each unbound item can be mapped. This list is derived from the underlying columns of the tables that are used by the module component. For example, if a module component has a base and a lookup table usage, the columns for both of those table usages are listed.

This list is empty if no table usages have been defined for the module component.

If <NULL> is shown as the column value, then the unbound item will not be mapped to a column.


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.


Navigator - Return to Object Reference
   Return to Object Reference (Navigator Menu)

Related Topics

Returns to the repository object from which you located a referenced object.


Navigator - Expand All
   Expand All (Navigator Menu)

Related Topics

Expands the selected node or nodes on the Navigator, to show all the levels of branches below.

This option is available only when a selected node or nodes can be expanded. The [image] icon is displayed next to all nodes that can be expanded.

To expand only a single level below a selected node, click the [image] icon.


Navigator - Collapse All
   Collapse All (Navigator Menu)

Related Topics

Collapses the selected node or nodes and all the levels of nodes below them on the Navigator. The Navigator does not store any information about the levels to which nodes are expanded.

This option is available only when a selected node has been expanded. If a node can be collapsed, the [image] icon is displayed next to it.

To collapse a node or nodes so that they can be expanded back to the same level, click the [image] icon.


Navigator - Set Mark
   Set Mark (Navigator Menu)

Related Topics

Places a bookmark on the currently selected repository object. The Navigator can have only one bookmark at a time. At a later stage, if you want to return to the bookmark, you can use Navigator→Goto Mark.


Navigator - Go to Mark
   Go to Mark (Navigator Menu)

Related Topics

Automatically scrolls the Navigator to the location of the bookmark. This option is available only if a bookmark has been set using Navigator→Set Mark.


Navigator - Go to Object Definition
   Go to Object Definition (Navigator Menu)

Related Topics

Navigates to a repository object that is referenced by a selected repository object.

For example, if a table has a foreign key defined, you can use this option to navigate to the definition of the table containing the primary key referenced by the foreign key.


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.


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.


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.


Run - Form Builder
Form Builder (Run Menu)

Related Topics

Invokes the Form Builder tool, which enables you to build a form by hand.


Run - Forms Runtime
Forms Runtime (Run Menu)

Related Topics

Invokes the Forms Runtime tool, which enables you to run a generated form or a form built by hand using Form Builder.


Run - Report Builder
Report Builder (Run Menu)

Related Topics

Invokes the Report Builder tool, which enables you to build a report by hand.


Run - Reports Runtime
Reports Runtime (Run Menu)

Related Topics

Invokes the Report Runtime tool, which enables you to run a generated report or a report built by hand using the Report Builder tool.


Messages - Copy Selected Messages
   Copy Selected Messages (Messages Menu)

Related Topics

Copies selected text from the Message Window to the Clipboard.


Messages - Show Help On Message
   Show Help on Message (Messages Menu)

Related Topics

Displays cause and action information for the selected error/warning message.


Messages - Clear Message
   Clear Messages (Messages Menu)

Related Topics

Clears any displayed messages from the Message Window.


Messages - Previous Message
   Previous Message (Messages Menu)

Related Topics

Highlights the previous message in the Message Window.


Messages - Next Message
   Next Message (Messages Menu)

Related Topics

Highlights the next message in the Message Window.


Messages - Go to Source of Error
   Go to Source of Error (Messages Menu)

Related Topics

Navigates from the selected message (after generation) to the appropriate component where the design problem can be fixed. For example, if a message indicates that a specific property is not set correctly you can use this menu option to navigate directly to the Property Palette.


Messages - List Actions
   Build Actions (Messages Menu)

Related Topics

Displays a list of possible actions available after generation or design capture (e.g. view/run the generated files). The contents of this list is dependent on the type of application being generated.

Note:	Check the generate option settings (Options→Generator Options→<language>) if an expected action is missing from the list.

Dialog box options

Description

Lists the post-generation build actions (e.g. run the generated application).

Run button

Executes the selected build action.


Messages - About Current Task
   Abort Current Task (Messages Menu)

During generation or design capture the Message Window displays progress information. To stop the process generation at any time use this option.


Message Action dialog box

This dialog box is displayed when an error or warning message requires more than one action/source to correct the error.

Dialog box options

Description

Lists the actions to correct the error/warning message.

Run button

Executes the selected message action.


Ask dialog box

This dialog box is displayed if the Generator requires additional information in order to proceed with generation process.

Answer text field

Enter you answer to the generation question here.

Abort button

To stop the generation process, click this button.


Yes-No dialog box
Yes/No dialog box

This dialog box is displayed when the Generator requires a yes or no answer to a specific request. In order for the generation process to proceed click the relevant yes/no button

Yes button

Click this button to perform the action.

No button

Click this button to cancel the action.

Abort button

To stop the generation process, click this button.


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.


The TextPad

Related Topics

The TextPad is a convenient method for entering and storing text for multi-line text properties. You can also use the TextPad to save text in a file and to assign text from a file to a multi-line text property.

The TextPad window contains a toolbar and a main text writing area:

For information on a TextPad toolbar button, click [image] in the main toolbar, then click the toolbar button.


Multi-line text properties

Related Topics

Many element types in the repository have text properties, such as Description, Notes or Comment. Some of these text properties (e.g., Description and Notes) are multi-line text properties, meaning that they can consist of more than one line of text.

Multi-line text properties are listed under the heading "Text" in the Property Palette, and are indicated by a [image] icon next to the property name.

You can edit a multi-line text property either by using the TextPad, or by using an ASCII or HTML editor if one is available.


File menu options for TextPad


File - Close (Textpad)
Close (File Menu - TextPad)

Related Topics

Closes the TextPad without attaching the current text to the selected property.

To close the TextPad and attach the text to the selected property, choose File→Exit.

If you do not want to attach the text to the property, but want to keep a copy of the text, then save the text as a text file.


File - Include File (Textpad)
   Include File (File Menu - TextPad)

Related Topics

Includes a specified file at the current position in the TextPad.

You can use File→Write to File to save the current text to file and come back to it later. In this way, it is possible to write some boilerplate text that you can attach to some selected properties.

Dialog box options

Use the context-sensitive help facility in the this dialog box for information on individual components.


File - Write to File (Textpad)
Write Text to File (File Menu - TextPad)

Related Topics

Saves the current text in the TextPad to a specified file.

Dialog box options

Use the context-sensitive help facility in the this dialog box for information on individual components.


File - Save Uncommitted Data (Textpad)
   Save Uncommitted Data (File Menu - TextPad)

Related Topics

Commits to the repository any unsaved TextPad changes you have made to the selected property.

Note:	Any changes that have been made to properties on the Property Palette, prior to invoking the TextPad are also committed to the repository.


File - Revert Uncommitted Data (Textpad)
   Revert Uncommitted Data (File Menu - TextPad)

Cancels any unsaved TextPad changes you have made to the selected property and closes the TextPad.

To cancel unsaved TextPad changes without closing the TextPad, click the [image] button.

Note:	Any unsaved changes that have been made to properties on the Property Palette, prior to invoking the TextPad are also canceled.


File - Print (Textpad)
Print (File Menu - TextPad)

Related Topics

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

Dialog box options

Use the context-sensitive help facility in the this dialog box for information on individual components.


Edit menu options for TextPad


Edit - Undo (Textpad)
   Undo (Edit Menu - TextPad)

Cancels the effect of the last operation performed in the TextPad. For example, you can use this option to discard any unsaved TextPad changes you have made, without closing the TextPad.

Choosing this option a second time restores the effect of the canceled operation.


Edit - Copy (Textpad)
   Cut (Edit Menu - TextPad)

Related Topics

Removes the selected text from the TextPad and places it on the Clipboard.

The Clipboard stores the selection that you cut from the TextPad until the next time you cut or copy something. Each time you cut or copy text, this overwrites the Clipboard contents.

You can insert the contents of the Clipboard into the TextPad using the [image] button. You can also paste text from the Clipboard into other Windows applications.

To remove selected text from the TextPad without placing it on the Clipboard, choose Edit→Clear.


Edit - Undo (Textpad)
   Copy (Edit Menu - TextPad)

Related Topics

Places a copy of the selected text on the Clipboard.

The Clipboard stores the selection that you copy from the TextPad until the next time you cut or copy something. Each time you cut or copy text, this overwrites the Clipboard contents.

You can insert the contents of the Clipboard into the TextPad using the [image] button. You can also paste text from the Clipboard into other Windows applications.


Edit - Paste (Textpad)
   Paste (Edit Menu - TextPad)

Related Topics

Places the contents of the Clipboard at the insertion point in the TextPad.

The Clipboard contains the subject of the most recent cut or copy. The Clipboard contents can be pasted as many times as required.

To place text on the Clipboard, highlight the text and click the [image] or [image] button. You can also cut or copy text from other Windows applications and paste them in the TextPad.


Edit - Clear (Textpad)
Clear (Edit Menu - TextPad)

Removes the selection from the TextPad without placing it on the Clipboard.

To place a copy of the removed text on the Clipboard, click the [image] button.


Edit - Find (TextPad)
Find (Edit Menu - TextPad)

Related Topics

Searches for a text string in the TextPad.

The TextPad window is searched to find the next text string that contains a match for the specified characters. You can specify the direction of the search and whether or not the search is case-sensitive.

Dialog box options

Find What

The text string that you want to search for in the TextPad. By default, this field contains the current selection in the TextPad.

Match Case check box

Indicates whether the search is case-sensitive.

Up option button

Indicates that the search operates upward from the current cursor position.

Down option button

Indicates that the search operates downward from the current cursor position.

Find Next button

Finds the next occurrence of the string in the Find What field. This button is dimmed if no string has been specified.


Edit - Replace (Textpad)
Replace (Edit Menu - TextPad)

Related Topics

Finds and replaces occurrences of a specified text string in the TextPad.

The TextPad window is searched to find the next text string that contains a match for the specified characters. You can specify whether or not the search is case-sensitive.

Dialog box options

Find What

The text string that you want to be replaced in the TextPad. By default, this field contains the current selection in the TextPad.

Replace With

The text string that you want to replace the occurrences of the text string in the Find What field.

Match Case check box

Indicates whether the replace operation should search for only those text strings that match the case of the string in the Find What field.

Find Next button

Selects the next occurrence of the text string in the Find What field.

Replace button

Replaces the found text string with the string in the Replace With field. If no text string is currently selected, then this button searches for the next occurrence of the string in the Find What field.

Replace All button

Replaces all occurrences of the string in the Find What field with the string in the Replace With field.


Edit - Repeat (Textpad)
Repeat (Edit Menu - TextPad)

Related Topics

Finds the text string that was specified (under Find What) in the most recent search or replace operation.


Edit - Select All (Textpad)
Select All (Edit Menu - TextPad)

Selects all text in the TextPad.


Edit - WordWrap (Textpad)
WordWrap (Edit Menu - TextPad)

Enables or disables the word wrap feature for text.

When word wrap is enabled (this is the default), text that cannot be fitted on one line is displayed on the next line in the TextPad. When word wrap is disabled, this additional text is displayed on the same line and you must scroll horizontally to see it.

Note:	If you set the text to unwrapped, then you will be permitted to enter as much text as you want in one line. When you commit the text to the repository, the text is automatically wrapped to use as many lines as is necessary.


Edit - Text
Text (Edit Menu)

Related Topics

Attaches free format multi-line text for the text types (e.g. Description and Notes) associated with this selected element.

Dialog box options

Element Name

Displays the name of the element.

Text Type

The types of text, e.g., Description, Notes. The changes made in the Text Area apply to the type of text displayed in this box.

Text Area

The text for the element. Text can be cut, copied and pasted from this area by using the hot-keys Ctrl+X, Ctrl+C and Ctrl+V.

Note:	A maximum of 80 characters can be entered per line for PL/SQL text types.

Text Editor

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

HTML Editor

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


Edit - Create Object
   Create Object (Edit Menu)

Related Topics

Creates a new repository definition of the same type as the currently displayed definition(s). If in default view, the Property Palette switches to spreadtable view. To be able to create a new object, you must have INSERT access for the workarea and container in which you are creating the object. Use the Repository Object Navigator to check your access permissions.


Edit - Delete Object
   Delete Object (Edit Menu)

Related Topics

Deletes the selected object definition from the workarea and places it in the wastebasket. To be able to delete an object, you must have DELETE access rights to the workarea and the container that owns the object. Use the Repository Object Navigator to check your access permissions.


Edit - Copy Properties
   Copy Properties (Edit Menu)

Related Topics

Copies all properties to the Properties Clipboard.

This option overwrites any previously copied properties on the Properties Clipboard.

You can paste the copied properties into other objects in the Navigator by choosing Edit→Paste Properties.

Note:	You can check the contents of the Properties Clipboard by choosing Edit→View Copied Properties.


Edit - Paste Properties
   Paste Properties (Edit Menu)

Related Topics

Inserts copied properties into a selected object.

You use this option when the Properties Clipboard contains a set of properties that were copied from a previous selection. You can paste the contents of the Properties Clipboard as many times as required.

Note:	You can check the contents of the Properties Clipboard by choosing Edit→View Copied Properties.


Edit - View Copied Properties
View Copied Properties (Edit Menu)

Related Topics

Displays the object properties, if any, that have been most recently copied to the Properties Clipboard. This is useful as a check when you are about to paste copied properties into an object.


Edit - Clear
Clear (Edit Menu)

Related Topics

Clears the details of a selected property. This menu option does not place the contents of the selection to the Properties Clipboard. Use Edit→Cut to remove the details of the selected property to the Properties Clipboard.


File - Save Uncommitted Data
   Save Uncommitted Data (File Menu)

Related Topics

Commits any outstanding changes made in the Property Palette to the repository.


File - Revert Uncommitted Data
   Revert Uncommitted Data (File Menu)

Related Topics

Cancels unsaved changes made to properties in the Property Palette.


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.


Properties - Expand All
Expand All (Properties Menu)

Related Topics

Expands all groups of properties in the Property Palette. Related properties are arranged in named groups after the non-related properties. For example, the element type Table Definition has named groups such as Volumes, Storage, Documentation, Visual Basic/C++ and Audit.


Properties - Collapse All
Collapse All (Properties Menu)

Related Topics

Collapses all groups of properties in the Property Palette. Related properties are arranged in named groups after the non-related properties. For example, the element type Table Definition has named groups such as Volumes, Storage, Documentation, Visual Basic/C++ and Audit.


Properties - Pin Palette
      Pin Palette (Properties Menu)

Related Topics

Causes the properties displayed in the Property Palette to remain unchanged even if you select another repository object from the Navigator. This action is known as "pinning" the Palette.

The Palette is the "pinned" state when the Property Palette toolbar button is [image].


Properties - Object Set
   Object Set (Properties Menu)

Related Topics

Displays the editable properties of two or more selected repository objects as a set on the Property Palette. The selected objects need not be of the same type. By default, when multiple repository objects are selected from the Navigator, the objects automatically become members of the object set (i.e. this menu option is not available).

In this type of display, properties for which all selected objects have the same value defined have the actual value displayed. Properties for which all selected objects have a value but the values are different have the value displayed as ######. To display the properties of individual members of the object set, use Properties→Next Object and Properties→Previous Object.


Properties - Next Object
   Next Object (Properties Menu)

Related Topics

Displays the properties of the next repository object in a set of two or more selected objects. The selected objects need not be of the same type. You can use this option to quickly move forwards through the members of a set.


Properties - Previous Object
   Previous Object (Properties Menu)

Related Topics

Displays the properties of the previous object in a set of two or more selected repository objects. The selected objects need not be of the same type. You can use this option to quickly move backwards through the members of a set.


Properties - Locate Object Definition
Locate Object Definition (Properties Menu)

Related Topics

Navigates to a repository object that is referenced by a selected repository object. For example, if a table has a foreign key defined, you can use this option to navigate to the definition of the table containing the primary key referenced by the foreign key.


Property Details dialog box

Displays various internal details about a selected property and the element to which it relates. These details are mostly of interest to developers writing code against the repository Application Programming Interface (API).

Object Details

Short Name

The short name of the element, preceded by the short name of its supertype. The supertype codes are:

CEL - container element

NSHR - 'non-shareable' element

PAC - primary access controlled element

SAC - secondary access controlled element

SHR - 'shareable' element

Name

The full name of the element type.

Base Table

The name of the repository table in which elements of this type are defined.

Caution:	Developers should not write code to access these tables directly. Instead, they should use the corresponding API view. For example, workarea definitions are stored in the base table named I$SDD_WORKAREAS, but user-written code should access the corresponding API view named SDD_WORKAREAS.

Object ID

A 38-digit numeric code that uniquely identifies the element. This code is sometimes known as the IRID.

Object IVID

A 38-digit numeric code that uniquely identifies this version of the element, even if the element has not been brought under version control. If the element is not versionable (for example, a workarea) this value is 0.

Version Label

The version label of the element, if it is under version control. It is this label, rather than the IVID, that is displayed by the various repository tools, such as the Version History Viewer.

Properties Details

Base Table Column

In the repository base table for this element type, the name of the column that stores data for the selected property. See the cautionary note above regarding the use of API views rather than base tables.

View Column

The name of the column in the API view for this element type that stores data for the selected property.

Mandatory

Indicates whether this is a mandatory property (that is, it must always have a value).

Maximum Length
DataType

The combination of these two values indicates the maximum length of the value that this property can have. For example, a maximum length of 256 and a datatype of VARCHAR2 means that the property value can be up to 256 characters in length.

Range

The range of values that this property can take.

Internal Value

The value for this property as it is stored internally in the repository.

Display Value

The value for this property as it is displayed in the repository tools.

Domain Name

The name of the domain, if any, to which this property belongs.

Model

Displays the type definition from the repository model for this element type. This includes details of the element short name, view name, versioning structure, uniqueness criteria, deletion rules, summary of changes since the previous release, and properties (both displayed and non-displayed).

API

The CDAPI function specification for this element type, giving details of the standard PL/SQL procedures provided for the element type (e.g., insert, update, delete etc.).


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.


Deleting diagrams

Related Topics

Diagrams that are no longer required can be deleted from the repository. Deleting a diagram does not delete any of the elements stored in the repository that are represented on the diagram.

To delete a diagram:

1.	Choose File→Delete Diagram.

2.	Select the diagram you want to delete and click OK.

3.	Click Yes to delete the diagram from the repository.


Saving diagrams

To save changes to an existing diagram :

•	Choose File→Save.

To save a diagram under a new name:

1.	Choose File→Save Diagram As.

2.	Enter the name of the file under which you want to save your diagram and click OK.


Opening new windows

Related Topics

You can open more than one window for the active tool. In this way, you can work on different parts of the tool simultaneously.

The new window is displayed on top of any existing windows. If one of these windows is at its full size, the new window obscures the existing ones. You can rearrange the windows by using other options on the Window menu.

To open a new window:

•	Choose Window→New Window.


Minimizing the number of diagram pages

Related Topics

Since deleting or moving the last diagram item on a page does not also automatically delete the page, a diagram may include many redundant blank pages lying outside the outermost points of any items on the diagram.

Note:	New pages are automatically added to a diagram whenever you create a new diagram item on, or move a current diagram item to, an area of the diagram window that is outside the current page boundary.

To minimize the number of pages used for the active diagram:

•	Choose Layout→Minimize Number of Pages.

The remaining number of pages will always form a rectangle.


Undoing the last graphical actions

You can undo and redo the most recent graphical actions you have made on a diagram. Graphical actions are actions that affect the look of items on the drawing surface, such as cutting and pasting items, altering the position and size of items on the diagram or changing the font, color and line width. For example, if you resize an object on the diagram, you can return the object to its previous size using undo.

To undo the last graphical action on a diagram:

•	Choose Edit→Undo.


Copying, cutting and pasting

Related Topics

You can cut, copy and paste items on a diagram. Each time you copy or cut selected diagram items, they are placed on the Clipboard, overwriting its previous contents. The contents of the Clipboard can then be pasted back onto the active diagram or another diagram. It is important to note that by using the Edit→Copy menu option you do not perform semantic copies of the selected elements (e.g. it cannot be used to create a new table definition from an existing table definition).

To copy diagram items to the Clipboard:

1.	Select the items you want to copy.

2.	Choose Edit→Copy.

To cut diagram items from a diagram:

Note:	When you cut an element from a diagram, the element is not removed from the repository.

1.	Select the items you want to cut.

2.	Choose Edit→Cut.

To paste the contents of the Clipboard onto a diagram:

1.	Position the cursor where you want to paste the Clipboard contents.

2.	Choose Edit→Paste.


Selecting items on diagrams

Related Topics

To select all items on the diagram:

•	Select Edit→Select All.

You can deselect individual items by holding down CTRL and clicking on them.

To select all diagram items of the same type:

1.	Click on a diagram item of the required type.

2.	Choose Edit→Select Same Type.

Select additional individual items by holding down CTRL and clicking on them.

To select specific diagram items on a large diagram:

•	Choose the Select option from the Edit menu, then choose the elements that you want to select.

To select all items in a given area of the diagram:

1.	Position the mouse cursor in the area in which you want to select the diagram items and hold down the mouse button.

2.	Drag the mouse over the required area and release the mouse button.

This procedure selects all elements wholly within the rectangle. To include elements partially within the given area, hold down ALT when dragging the rectangle.

Note:	To select subsequent rectangular groups of items, hold down CTRL and drag another rectangle in the same way.


Navigating to elements on diagrams

Related Topics

As a diagram increases in size, it can become too large for you to be able to see all of its items at one time in a window. This can make it difficult to locate the part of the diagram you want to work on. The navigate facility provides a way of finding an element on a diagram and displaying that part of the diagram without having to scroll to it.

To navigate to an element on a diagram:

1.	Choose Edit→Navigate To.

2.	Select the element to which you want to navigate.


Removing elements from diagrams

Related Topics

Elements that have become obsolete can be removed from a diagram. When you remove an element from a diagram, you can either:

•	remove the element from the diagram, but not from the repository, i.e., cut the element from the diagram

•	remove the element from the diagram and from the repository, i.e., delete the element

Note:	When you delete an element from a diagram and the repository, the element is also deleted from any other diagrams. Any unopened diagrams containing the deleted element become temporarily out-of-date until consolidation occurs when the diagram is opened. This automatic consolidation ensures that diagrams you are working on always reflect the latest information in the repository.

To remove an element from a diagram but not from the repository

1.	From the diagram, select the element or elements you want to delete.

2.	Choose Edit→Cut.

To remove an element from a diagram and from the repository:

1.	From the diagram, select the element or elements you want to delete.

2.	Choose Edit→Delete from Repository.


Copying elements with new languages

Related Topics!Alink(COM_Copying_elements, , , )

When you have created module definitions in the repository, you may want to use them as the basis for new elements of a different language. For example, you may want to use an Oracle Forms module, as the basis for a Visual Basic module.

The Copy With New Language utility helps you to create new elements with different languages, by automatically removing information that is not relevant for the target language.

With the introduction of reusable module components (which can be made private), The use of the copy utility to create copies of module components is now redundant. If you need to copy a common definition of a module component to different modules, then make the module component reusable. However if you wish to diversify that definition then make the inclusion of the reusable module component private.

To copy an element with a new language:

1.	Select the module that you want to copy.

2.	Choose Utilities→Copy With New Language.

3.	Specify the name and language of the new module that is to be created.


Mapping unbound items to database columns

During application design you can record details about the items that are to be displayed and used by a generated application. You can record details about items that map directly to a single database column, by creating bound items in the repository. You can also record details about items whose values cannot be derived from a single database column, by creating unbound items in the repository.

You can change an unbound item into a bound item, by mapping the unbound item to a database column.

Note:	You cannot change a bound item into an unbound item.

To map unbound items to database columns:

1.	Select one or more unbound items.

2.	From the Select Binding for Unbound Items dialog box , use the Column dropdown lists to identify the database column to which each unbound item will be mapped.


 Printing

Related Topics

To preview the print job as it will appear when printed:

•	Choose File→Print Preview.

−	To navigate through the pages, choose either the Next Page button or the Prev Page button as appropriate.

−	To specify whether one or two pages are previewed at once, choose the One Page/Two Page button.

−	To increase or decrease the view of the printed pages, choose the Zoom In or Zoom Out button, as appropriate.

−	To print, choose the Print button.

−	To close the Print Preview window and return to the main tool window, choose the Close button.

To specify the range of pages to be printed:

1.	Choose File→Print.

2.	Do one of the following:

−	To print all pages, click the All option button.

−	To print out a range of pages, enter the page numbers in the From and To fields associated with the Pages option button.

To specify the print quality used for printing:

1.	Choose File→Print.

2.	Choose the required print quality from the Print Quality drop-down list. The higher the number the better the print quality.

To specify the number of copies that you want to print:

1.	Choose File→Print.

2.	Specify the number of copies you want to print in the Copies field.

To print a print job to a file:

1.	Choose File→Print.

2.	Check the Print to File check box.

3.	Enter the name and location of the file to which you want to print the print job.


 Changing the print setup

Related Topics

Note:	To set some of the more advanced document printing options, select the Options button to display the Options dialog box.

To select the printer:

1.	Choose File→Print Setup.

2.	Choose the Default Printer option button to print to the default printer.

Note:	You can change the default printer and connect to other printers using Print Manager.

To specify the page orientation:

1.	Choose File→Print Setup.

2.	Choose the required option button from the Orientation group. The image of the page will change accordingly in the orientation group.

Note:	The page orientation used for the print jobs can be changed at any time. Changing the page orientation automatically refreshes the display to reflect the new orientation as well as changing the orientation setting on the printer. The page orientation can be set to either landscape or portrait.

To specify the page size used for the print job:

1.	Choose File→Print Setup.

2.	Choose the required page size from the Size drop-down list.

Note:	The page size used can be changed at any time. Changing the page size automatically refreshes the display to reflect the new size as well as changing the paper-size setting on the printer.

To specify the paper source:

1.	Choose File→Print Setup.

2.	Choose the required paper source from the Source drop-down list.

Note:	A number of different paper sources for the currently connected printer may be available, such as Upper Cassette, Lower Cassette, Envelope Feeder, Manual Feed or Auto Select.

If you have any problems changing the print setup, please refer to your System Administrator.


 Adding page numbers, titles and boundaries to diagram print jobs

Related Topics

To print a page number at the bottom of each page of a diagram print job:

1.	Choose File→Print.

2.	Check the Page Numbers check box.

To print the diagram title at the top of each page of a diagram print job:

1.	Choose File→Print.

2.	Check the Page Title check box.

Note:	The page title is specified in the Title field of the Summary Information dialog box.

To print the page boundaries on a diagram print job:

1.	Choose File→Print.

2.	Check the Page Boundaries check box.


Changing the database connection

Related Topics

To change the database connection:

1.	Choose File→Change Connection.

2.	Specify a username and password.

3.	Specify a connect string for the Oracle database to which you want to connect.

For any unsaved changes, a message box is displayed asking you whether or not you want to save the changes.

Note:	If you are using one of the diagramming tools, and you currently have diagrams open, these diagrams will be closed.

After successful connection to a database, this option displays the Workarea dialog box, enabling you to choose the workarea.

4.	Select the name of the required workarea and click OK.

If you have any problems trying to connect to a database, please refer to your System Administrator.


Changing the workarea

Related Topics

If you have access to more than one workarea, you can switch between the different workareas, without leaving the tool. If you have the repository management Workarea privilege you may create a new workarea.

To change the workarea:

1.	Choose File→Change Workarea.

2.	Do one of the following:

•	Select the name of the required workarea from the list and click OK.

•	Click New to create a new workarea.


Closing diagrams

To close a diagram:

•	Choose File→Close.

If the active diagram is named and contains any unsaved changes, this option displays an alert box asking you whether or not you want to save the changes. Click Yes to save the changes and close the diagram.

If the active diagram is untitled, this option displays an alert box asking you whether or not you want to save the untitled diagram. Click Yes to display the Save Diagram As dialog box enabling you to name and save the diagram before closing it.


Getting diagram information

To get information about the diagram:

1.	Choose File→Summary Information.

Note:	The database connection and the current workarea cannot be changed from the Summary Information dialog box, but can be changed using File→Change Connection and File→Change Workarea.

2.	If required, enter the title for the diagram and the name of the author of the diagram.

3.	Check the appropriate check boxes to determine which of the fields are displayed on the diagram.


Viewing diagrams

Zooming in and out

Displaying diagrams at their original size

Fitting a diagram to the size of the window

Fitting the selection to the size of the window


Zooming in and out

To increase the magnification of the diagram in the active window:

•	Click [image].

To decrease the magnification of the diagram in the active window:

•	Click [image].

To zoom in on a selected area:

1.	Click [image].

2.	Position the cursor on the diagram at the corner of the area you want to magnify and hold the mouse button down.

3.	Drag the rubber-band box to the opposite corner of the area you want to magnify and release the mouse button.


Displaying diagrams at their original size

Related Topics

You can reset the magnification of a diagram to the same magnification that it was displayed at when the diagram was opened or created.

To reset the magnification of a diagram:

•	Choose View→Normal Size.

The whole diagram can be easily resized again or fitted to the size of the window using the appropriate option.


Fitting the selection to the size of the window

Related Topics

You can adjust the magnification of the selected diagram items on the diagram to the maximum size that will fit into the active diagram window.

To adjust the magnification of diagram items:

1.	Select the diagram items that you want to fit to the size of the diagram window.

2.	Click [image].


Fitting a diagram to the size of the window

Related Topics

You can adjust the magnification of the whole diagram to the maximum size that will fit into the active diagram window.

To adjust the magnification of the diagram:

•	Click [image].


Requerying elements

Related Topics

In a multi-user environment where data is shared between many users, certain situations can arise that result in the data displayed becoming out of date with the latest information in the repository. For example, the contents of the tool can inadvertently be changed if it contains elements owned by another user and that user deletes, renames or changes those elements.

For example, user A is working on Diagram 1 which contains table EMP. Table EMP is also included on Diagram 2, currently opened by User B. User A deletes table EMP, which is removed from Diagram 1. User A then removes table EMP from the repository. User B's diagram is now out of date and should be requeried.

User B is unaware that table EMP has been removed from the repository until User B tries to change the properties of table EMP. User B is informed that table EMP no longer exists and can requery the diagram.

To preserve the integrity of data, checks are automatically carried out against the repository each time you attempt to change an object. For example, if an object has been changed by another user, you are informed that the displayed data is out of date and you must requery the repository before you make further changes to the object.

While you are working, repository elements can be requeried:

•	individually

•	all at the same time

Note: 	If you are using the broadcast mechanism facility, changes are automatically highlighted within the tool.

To requery individual objects:

1.	Select one or more objects to be requeried.

Note:	If the broadcast notification service is being used, the out-of-date repository objects can easily be recognized by the display of the broadcast indicators [image]. Click [image] to requery the object's details.

2.	Choose Edit→Requery Selection.

To requery all objects displayed in the active window:

•	Choose Edit→Requery All.


About the broadcast mechanism

Related Topics

The broadcast mechanism allows repository users to be notified of changes to repository objects made in other tools or by other users as soon as those changes are made. If repository objects that are currently displayed in one tool are changed in another tool, or by another user on another machine, a broadcast notification indicator is displayed so that the out-of-date objects can be updated to reflect the changes.

Example 1 - A simple case

A single instance of the Repository Object Navigator and a single instance of another tool are active on the same computer. Both tools are connected to the same repository instance. In the Repository Object Navigator, the user deletes a column that is also represented on a diagram and in the Navigator of the other tool. Broadcast indicators [image] are displayed in the other tool on the parent instance (i.e., the table) on the diagram, and on the child instance (i.e., the actual column) in the Navigator.

Example 2 - Differentiating between repositories

Two instances of the Repository Object Navigator, and a single instance of another tool, are active on the same computer. One of the Repository Object Navigator instances and the other tool are connected to the same repository instance. The second Repository Object Navigator is connected to a different repository instance. The user deletes a table from the repository using the other tool. The broadcast indicator [image] is displayed in the Repository Object Navigator that is connected to the same repository instance as the other tool. The other Repository Object Navigator is not affected by this element deletion.

Note:	To use the broadcast server mechanism over the network, you must first configure the broadcast server for a network notification service. You must use the Repository Administration Utility to configure the broadcast server.

When and where will broadcast notification indicators appear?

•	On creation of children (elements and associations), indicators are displayed in the Navigators (Repository Object Navigator and other tools) on the parent repository object type. For example, when a new column is created, a broadcast indicator is displayed on the Table Definition node in the Navigator.

•	On deleting or updating of children (elements and associations), indicators are displayed in the Navigators on the child node and not the corresponding parent node. For example, if the column EMPNAME was deleted from the table EMP, an indicator is displayed on the EMPNAME node in the Navigator(s).

•	On check in, check out or refresh of repository objects in a shared workarea. For example, where user A and User B are sharing a workarea, they will each be notified of changes made by the other user.

•	In the Matrix Diagrammer, indicators are displayed on the axis and intersections.

•	On diagrams, indicators are displayed only on instances of primary access controlled element types (e.g., the table EMP).

Setting the broadcast notification levels

The following broadcast notification levels can be set by a user:

•	Network. Any changes made on the same machine or other machines (i.e., across the network) will be broadcasted to all users participating in the network broadcasting mechanism.

•	Desktop, the default setting. Changes made on the same machine will be broadcasted to all tools running on that user’s machine.

•	Disabled. This level turns off the broadcasting mechanism, i.e., the user does not receive (or send) notification messages.

Note:	If you decide to disable the broadcast mechanism but would like to see (e.g., at the end of your working session) the latest information in the repository for the currently displayed objects, use the requerying elements facility, or refresh the workarea.

See Setting the broadcast options for more information.


Setting the broadcast options

Related Topics

Any repository object updates made on the same machine (i.e., the same desktop) or other machines (i.e., across the network) can be broadcasted to users as soon as those changes are made. Only users participating in the broadcast mechanism at network level will be notified of changes made by other users.

Note:	Setting this option applies to the user on the computer, not to individual tools. For example, on the same machine you cannot have the broadcast mechanism disabled in one tool and have this option set to network in the Repository Object Navigator. Also, you cannot decline to receive notification messages but still be able to send them.

To set the broadcast notification options:

1.	Choose Options→Broadcast Options.

2.	Select one of the following broadcast notification levels:

•	Disable - turn the broadcast notification service off

•	Desktop - broadcast changes to this machine only

•	Network - broadcast changes to this machine and all other users' machines participating in this broadcast


Force deleting repository objects

If you want to remove a non-versioned repository object PAC or a SAC element and override any blocking constraints defined for the corresponding object type, use Force Delete. About

To force delete an object you must have DELETE access rights to the workarea and the owning container, and the FORCE repository privilege.

To force delete repository objects:

1.	In the Navigator, select the objects to be force deleted.

2.	Choose Utilities→Force Delete.

The Force Delete Wizard is displayed with path and element type details of the selected objects.

3.	Follow the instructions provided by the wizard.


Force purging repository objects

If you want to remove an object version from the current workarea and override any blocking constraints defined for the object type, use Force Purge. About

To perform a force purge operation, you must have DELETE access rights to the appropriate workarea and container, and have the FORCE and PURGE repository privileges.

To force purge repository objects:

1. 	In the Navigator, select the objects to be force purged.

2.	If an object displays a [image] icon, check it in. How

3.	Choose Utilities→Force Purge (or Force Delete, if only this is displayed).

The Force Purge Wizard is displayed with path and element type details of the selected object versions.

4.	Follow the instructions provided by the wizard.


Deleting repository objects

You can delete a non-versioned object, or a checked-in versioned object. To be able to delete an object you must have the DELETE access right to the workarea and the owning container. You cannot delete a checked-out object.

Deleting a non-versioned object places it in the wastebasket, from where it can subsequently be removed from the repository or restored to the workarea.

Deleting a versioned object simply removes that object version from the current version of its owning container. The object version is retained in any previous versions of its container, but is no longer visible either in the current workarea or in any workareas that use subsequent versions of the container.

Note:	There are several other methods of removing objects, such as Force Delete, Purge and Force Purge. About

You cannot use the Delete method to delete an object that is referenced in other containers; you must either delete all the references first, or use the Force Delete method.

To delete a repository object:

1.	In the Navigator, locate the objects you want to delete.

2.	If an object displays a [image] icon, check it in. How

3.	Select the objects in the Navigator window. How

4.	Click [image].

5.	In the Confirm Delete dialog box, click Delete.

6.	(Optional)  If you want to remove the objects from the repository completely, empty the wastebasket using the Repository Object Navigator. Note that doing so also removes any other objects in the wastebasket.

Alternatively, you can use the Repository Object Navigator to restore the objects from the wastebasket.


Resequencing elements

Allows you to change the order in which elements are ordered and displayed in the Navigator. For example, you can resequence columns in a table definition.

To resequence an element, select it from the list box and click the appropriate sequence button.

To resequence an element:

1.	In the Navigator, select the element you want to resequence.

2.	Choose Utilities→Resequence.

3.	Select the element from the list and move it to the new position.

4.	Click OK.


Copying elements

Related Topics

You can copy one or more elements of repository objects to the same or a different container within the same workarea. There are two types of copy:  simple copy, using a copy-and-paste technique to copy a single object in the Navigator window, or extended copy using a wizard to copy one or more objects. With extended copy you can optionally choose to copy elements that are referenced by the copied elements, or to remap their references.

You can copy PAC elements, SAC elements, or PAC elements together with their SAC elements.

To copy a repository element (simple copy):

1.	In the Navigator window, select the element you want to copy.

2.	Choose Edit→Copy (or press CTRL+C).

3.	(Optional)  Select a different container as the destination.

4.	Choose Edit→Paste (or press CTRL+V).

If you see the Copy dialog box:

•	select Deep Copy if you want to copy SAC elements as well as the PAC element for an object

•	select Auto Checkout if you want to check out the destination container (if copying a PAC element) or object (if copying a SAC element)

•	select Copy Dependencies if you want to copy any dependency information for the object that has been created by the Dependency Manager tool

•	select Don’t Show This Dialog Again if you want your check box selections to apply every time you perform a simple copy

To copy a repository element (extended copy):

1. 	(Optional)  In the Navigator window, select the objects you want to copy.

2. 	Choose Utilities→Extended Copy.

3. 	Follow the on-screen instructions in the Extended Copy Wizard. Online help is available for each screen of the wizard.


Filtering the contents of a list box

If a filter control is displayed on a dialog box, you can use the control to filter the contents of a list box on that dialog box. The filter control is comprised of a filter field that identifies the search string for which matches are to be found, and a filter button that activates the filter.

To filter the contents of a list box:

1.	Enter the condition that is to filter entries from the list box.

For example:

•	To list all elements ending in "EN", type "%EN".

•	To list all elements beginning with "EN", type "EN%".

•	To list all elements containing the letters "EN", type "%EN%".

The wildcard character (%) is used to represent any character, string of characters or no characters. Use the underscore character (_) to represent any single character.

For example, to list all elements beginning with "EN" whose fourth character is "S", type "EN_S%".

2.	Click [image] (Filter button).


Redefining workareas

After you have created a workarea, you can redefine various of its characteristics, provided that you have the necessary access rights to do so.

You can redefine the properties (name and description), the default checkin branch (where possible) and the specification (the rules and configurations by which the workarea is populated).

To redefine a workarea:

1.	In the Navigator window, select the name of the workarea you want to redefine.

2.	Choose Edit→Edit Workarea.

3.	Follow the on-screen prompts in the workarea wizard.

4.	Click Finish to complete the redefinition.


Refreshing workareas

Refreshing a workarea redisplays the workarea contents according to the current workarea specification. As a result, objects may be added to, updated in, or removed from, the set of objects visible in the workarea. Refreshing a workarea also resolves potential version conflicts for objects in the workarea.

If you refresh a shared workarea that is owned by another user and in which you have included a container or one of its objects to which you have access, you will not see that container or object unless the workarea owner is also granted access to the container.

Note:	If refreshing a workarea would cause checked-out or non-versioned objects to be lost or orphaned (for example if their container has been excluded from the workarea), an error message is displayed.

You can preview the effect of refreshing without actually performing the operation.

To refresh a workarea:

1.	Choose Edit→Refresh Workarea.

Note:	If you are using the Repository Object Navigator and more than one workarea is visible, select the workarea that you want to refresh.

2.	(Optional)  To see the effect of refreshing the workarea before you perform the operation, select Preview Changes Before Refreshing. You can choose to see the effect simply on the repository, or (if the repository contains uploaded files) the effect on both the repository and the file system.

3.	(Optional) To synchronize the repository and the file system when you refresh the workarea, select Synchronize.

4.	If you chose to preview the changes in step 3, do the following when the Preview Changes dialog box is displayed:

a.	Choose Changes in Repository or Changes in Repository and File System as required.

b.	Click the tabs on the dialog box as required, to show objects as follows:

New - objects that will be added to the workarea when it is refreshed

Changed - objects that will be updated in the workarea when it is refreshed

Removed - objects that will be deleted from the workarea when it is refreshed

c.	Click Refresh to refresh the workarea, or Cancel to abandon the operation.


 Embedding other applications

Exchanging information with other Applications

Embedding objects on diagrams

Creating links to other files

Editing embedded objects

Converting objects

Editing linked objects

Maintaining links


Embedding objects on diagrams
 Embedding objects on the diagram

Related Topics

You can include an object created by another application on a diagram by embedding it. If an object does not exist, it can be created and embedded while you are working in the diagram window.

Note:	An embedded object increases the file size of a diagram, because the object is stored in the diagram.

To embed a new object:

1.	Choose Edit→Insert New Object.

2.	Click Create New.

3.	From the Object Type list box, select the application to be used to create the object.

The contents of the list depend on the applications installed on your computer that support linking and embedding.

4.	(Optional)  If you wish to display the embedded object as an icon on the diagram, check the Display as Icon check box .

Note:	If you do not check the Display as Icon check box you may still find that the embedded object is displayed as an icon on the diagram. For more information about the OLE capabilities and functionality of other Windows-based applications, see the documentation for those applications.

5.	To invoke the selected application, click OK.

The selected application is displayed in a separate window or the application temporarily replaces the diagrammer menus and toolbar.

6.	Create the object.

The object is created at the top-left corner of the visible portion of the diagram.

7.	To return to the modeler/diagramming tool, do one of the following:

−	If the object was created in a separate window, save the object and then return to the diagrammer.

−	If the object was created within the current diagram window, click the mouse button anywhere outside of the OLE object area.

To embed an existing object:

1.	Choose Edit→Insert New Object.

2.	Click Create from File.

3	Enter the name of the source document in the File box.

4.	(Optional)  If you want to display the embedded object as an icon on the diagram, check the Display as Icon check box .

Note:	If you do not check the Display as Icon check box you may still find that the embedded object is displayed as an icon on the diagram. For more information about the OLE capabilities and functionality of other Windows-based applications, see the documentation for those applications.

5.	To include the contents of the file as an object on your diagram, click OK.

The object is created at the top-left corner of the visible portion of the diagram.


 Creating links to other files

Related Topics

You can create a link to share information between a diagram and a file created in another application that supports object linking. You can create a link to an entire file or to a selection in a file (if the application supports it).

To create a link to an entire file:

1.	Choose Edit→Insert New Object.

2.	Click Create from File.

3.	In the File box, enter the name of the file to which you want to link.

4.	Check the Link check box.

5.	(Optional)  If you want to display the linked information as an icon on the diagram, check the Display as Icon check box.

6.	Click OK.

The linked object is inserted at the top-left corner of the visible portion of the diagram.

To create a link to a selection in a file:

Note:	Not all applications allow you to link to a selection in a file. For more information about the OLE capabilities and functionality of other Windows-based applications, see the documentation for those applications.

1.	In the application in which the information you want to link was created, open the source file.

2.	Select the information to be linked.

3.	Choose Edit→Copy.

4.	Switch to the modeler/diagramming tool, then choose Edit→Paste Link to include the contents of the Clipboard as a linked object on the diagram.

The linked object is inserted at the top-left corner of the visible portion of the diagram.


 Editing embedded objects

Related Topics

You can modify an embedded object directly in the current diagram. When you double-click an embedded object, the original application is opened, or for some embedded objects (such as video and sound clips), the objects are played.

To edit an embedded object by 'double-clicking':

1.	Double-click the embedded object area or the icon that represents the embedded object.

The original application either temporarily replaces the modeler/diagrammer menus and toolbars or is displayed in a separate window.

2.	Edit the object.

3.	To return to the modeler/diagramming tool, do one of the following:

−	If the object was updated in a separate window, save the changes and then return to the Diagrammer.

−	If the object was updated within the current diagram window, click the mouse button anywhere outside of the OLE object area.

To edit an embedded object by using the menu option:

1.	Select the object you want to edit.

2.	Do one of the following:

−	Choose Edit→<object name> Object→Edit.

The original application either temporarily replaces the diagrammer menus and toolbars or is displayed in a separate window.

Note:	Depending on the application used to create the embedded object, the Edit menu option may not be available to you.

−	Choose Edit→<object name> Object→Open.

The original application is opened.

3.	Edit the object.

4.	To return to the modeler/diagramming tool, do one of the following:

−	If the object was updated in a separate window, save the changes and then return to the Diagrammer.

−	If the object was updated within the current diagram window, click the mouse button anywhere outside of the OLE object area.


 Converting objects

Related Topics

You can convert an embedded object to a different file format by selecting another application to be the object's source application. You can also change whether the embedded or linked object is displayed as the object itself or as an iconic representation of the object on the diagram.

To convert an embedded object to a different file format:

1.	Select the object you want to convert.

2.	Choose Edit→<object name> Object→Convert.

3.	From the Object Type list box, select the application whose file format you want to convert the object to.

4.	Do one of the following:

−	To permanently convert the embedded object to the specified file format, click Convert To.

−	To temporarily activate all embedded objects of the selected type in the specified file format, click Activate As. When you edit the object, you use the file format you specified, but when you save the object, it is saved in its original file format.

5.	Click OK.

To change the display of the object on a diagram:

1.	Select the object.

2.	Choose Edit→<object name> Object→Convert.

3.	Do one of the following:

−	To display the object as an icon on the diagram, check the Display as Icon check box.

−	To display the object as itself on the diagram, uncheck the Display as Icon check box.

4.	Click OK.


 Editing linked objects

Related Topics

You can modify a linked object directly in the current diagram. When you double-click a linked object, the original application is opened, or for some linked objects (such as video and sound clips), the objects are played.

To edit a linked object by 'double-clicking':

1.	Double-click the linked object area or the icon that represents the linked object.

The original source application displaying the linked information is opened.

2.	Edit the linked object as necessary.

3.	Save the changes and exit from the application.

Any changes made to the linked object appear in all files associated with it through links, in addition to the original file containing the object.

To edit a linked object by using the menu option:

1.	Select the object you want to edit.

2.	Do one of the following:

−	Choose Edit→<object name> Object→Edit.

The original source application displaying the linked information is opened.

Note:	Depending on the application used to create the linked object, the Edit menu option may not be available to you.

−	Choose Edit→<object name> Object→Open.

The original source application displaying the linked information is opened.

3.	Edit the linked object as necessary.

4.	Save the changes and exit from the application.

Any changes made to the linked object appear in all files associated with it through links, in addition to the original file containing the object.


 Maintaining links

Related Topics

By default, linked objects are updated automatically. An object that is linked manually does not change when the object in the source document changes. The object gets updated in the destination document only when you decide to update it. When you break a link, the linked object remains in the diagram; however, it can no longer be updated. You may lose a link if you rename or move its source document. If this happens, you must reconnect each link to its original source file or to a different file.

To control the way links are updated:

1.	Choose Edit→Links.

2.	From the list in the Links box, select the link or links whose update option you want to change.

3.	Do one of the following:

−	To update linked information every time a change occurs in the source file, click Automatic.

−	To update linked information only when you choose to, click Manual.

4.	Click Close.

To update a link manually:

1.	Choose Edit→Links.

2.	From the list in the Links box, select the links or links you want to update.

3.	Click Update Now.

For each selected link, the diagrammer reflects in the current diagram any changes made in the source file since the last update.

4.	Click Close.

To break a link:

1.	Choose Edit→Links.

2.	From the list in the Links box, select the links or links you want to break.

3.	Click Break Link.

4.	Confirm that you want to break the link.

5.	Click Close.

To reconnect or change a link:

1.	Choose Edit→Links.

2.	From the list in the Links box, select the links or links you want to reconnect or change.

3.	Click Change Source.

4.	In the Source filename box, type or select the name of the file to which you want to reconnect or change the link, and then click OK.

5.	Click Close.


 Exchanging information with other Applications

Related Topics

With the linking and embedding facilities, you can include information created by other applications on a diagram. The main difference between linking and embedding is where the data is stored. Embedded objects become part of the diagram. Linked information is stored in the source document; the diagram stores only the location of the information in the source document but displays a graphic representation of the linked object.

Embedding an object

Embedding means inserting information (such as a diagram from one of the Designer tools or a text document from Microsoft Word) into a diagram. Once embedded, the object becomes part of the diagram. When you double-click an embedded object, you open the application in which the object was created; the object is displayed and ready for editing. When you return to the current diagram, the diagram reflects any changes you have made to the object. You can embed an existing object or you can create and embed a new object.

Linking information

Linked information can be created between a diagram and a file created in another application. Once a link is established, you can check for and retrieve new data or you can specify that the Diagrammer is to update the linked object as soon as it changes in the source document.

Using the Object Packager

There is another way to embed or link objects. Instead of linking or embedding the object in the form it was created, you can embed an icon that represents the object, known as a package. Packages can contain either embedded objects or links to documents, but a package itself is always embedded. By using Object Packager (an application supplied with Windows), you can create a package and insert it into a destination document. For more information about the Object Packager, see the Help documentation for Object Packager.


Showing or hiding the toolbar

To determine whether or not the standard toolbar is displayed below the menu bar, choose View→Toolbar.


 Showing or hiding the status bar

The status bar displays,  for example:

•	a brief description of what the currently selected menu option does.

•	an indication of whether the Caps Lock, Num Lock and Scroll Lock functions are enabled.

To determine whether or not the status bar is displayed at the bottom of the application window, choose View→Status Bar.


 Showing or hiding the tool palette

To determine whether or not the tool palette is displayed, choose View→Tool Palette.


 Organizing windows

If you have more than one window open, you can rearrange them on the screen using the Window menu options.

To arrange the open windows in an overlapping pattern:

•	Choose Window→Cascade .

To fit all the windows into the application window:

•	Choose Window→Tile Horizontally, or Window→Tile Vertically.

To tidy up the icons of any windows you have minimized:

•	Choose Window→Arrange Icons.


 Displaying open windows

You can display a window that is open but not currently visible on the screen, e.g., when it is obscured by other windows. When you select such a window for display, that window becomes the active window.

To display an open window:

•	Choose Window→<1,2,3...window name>.


 Obtaining version information about the current tool

To obtain version information about the current tool:

•	Choose Help→About.


 Accessing the online documentation system

The online documentation system that you are using provides help information about the current application. You can display this information by means of the following:

•	Help menu

•	toolbar help button or the dialog box help button

•	F1 key

Help menu

The Help menu provides access to the following kinds of help information:

•	Help→Help Topics displays a list of the main subject areas in the online documentation system. Note, a full-text search facility is available via the Find tab of the Help Topics dialog box.

•	Help→How to Use Help displays general information about using Microsoft Windows help.

•	Help→About displays version and copyright information about this tool

 Context-sensitive help toolbar or dialog button

The last button in the standard toolbar provides access to context-sensitive help information about the menu options and toolbar buttons for this tool.

The help button located at the top-right of the dialog box provides access to context-sensitive help information about individual fields on the dialog box. Field-level help is available only on the more complex dialog boxes

Selecting the context-sensitive help button and then selecting a menu option, toolbar button or an individual field on a dialog box displays the help topic for the chosen item. (Similarly, selecting a menu option, toolbar button or an individual field on a dialog box and pressing F1 displays context-sensitive help.)

Dialog box help button

You can obtain specific information for a dialog box by selecting the Help button on the dialog box itself. The resulting help window tells you what the dialog box does, and provides information about each individual field. You can scroll through the field help to see what each field does.

F1 key

Pressing F1 while a diagram window is active displays help information about the modeler/diagrammer.

Pressing F1 while a dialog box is active displays the help information for that dialog box.


Using the Navigator

Selecting objects in the Navigator

Navigating to a named object

Expanding objects in the Navigator

Collapsing objects in the Navigator

Setting bookmarks in the Navigator

Navigating to and from a referenced object


Selecting objects in the Navigator

Related Topics

To select a single object in the Navigator, click on it. The entry is highlighted to show that it is selected. Any previous selection in the Navigator is lost.

To select a range of objects, select an object to identify the start of the range, then hold down SHIFT and select an object to mark the end of the range. All the objects between the two selected objects are selected.

To select several objects that are not within a range, hold down the CTRL key and select the nodes individually.


Navigating to a named object

If you want to locate an object by name, you can navigate to it directly by using the text box in the toolbar.

Note:	The object must have been previously displayed in the Navigator window in the current session.

To navigate to a named object:

1.	Start typing the name of the object in the text box in the toolbar:

As you type, the system selects the first object that matches the name you have typed so far.

2.	If the selected object is not the one you want, do one of the following:

•	Type more of the name to narrow the search.

•	Click [image] in the toolbar repeatedly until you find the object you want.

Note:	You can click [image] to go back to the object that was last found in the search.


Expanding objects in the Navigator

Related Topics

You can expand all or part of the Navigator to view the objects. You can expand an object only when its Collapse/Expand Icon is in its collapsed state.

When you expand a node by one or more levels, the level to which the node is expanded is determined by how it was previously collapsed. A node is expanded by one level unless the Navigator→Collapse option was used to collapse it. This collapse option stores information about the level to which a node is expanded, so that, when the Navigator→Expand option is used, the node is expanded to its previous level.

When you fully expand a node, the Navigator displays all the objects below it, until no more nodes can be opened.

Note:	When the Navigator is expanded and filters have been set, only objects that fit the filter criteria are shown. In the Repository Object Navigator use Navigator→Filter. In other tools, use Options→Customize.

To expand objects in the Navigator:

Do one of the following:

•	Double-click a collapsed node. The node is expanded and selected.

•	Click the Collapse/Expand icon of a collapsed node. The node is expanded but not selected.

•	Select the objects that you want to expand and do one of the following.

−	To expand the object to the next level, choose Navigator→Expand.

−	To expand all objects under the selected entry, choose Navigator→Expand All.


Collapsing objects in the Navigator

Related Topics

You can collapse all or part of the Navigator to hide objects that were visible in the expanded state. When you collapse an object, the Navigator stores the level to which the object was expanded. You can expand the object to its previous level using the Navigator→Expand option. In this way, you can easily collapse and expand part of the Navigator.

To collapse objects in the Navigator:

Do one of the following:

•	Click the Collapse/Expand icon of a expanded node. The node is collapsed but not selected.

•	Double-click an expanded node. The node is collapsed and selected.

•	Select the object that you want to collapse in the Navigator and do one of the following:

−	To collapse the selected node, choose Navigator→Collapse.

−	To collapse all nodes under the selected node, choose Navigator→Collapse All.


Setting bookmarks in the Navigator

Related Topics

You can use the Set Mark and Go to Mark commands to mark an object in the Navigator and then return to that object later on. Once a mark has been set, you can work in the Navigator and in other windows as desired. Only one bookmark can exist on the Navigator at any one time.

A bookmark remains set until:

•	you set a new mark

•	you delete the marked object

•	you change views in the Designer

•	you quit the tool

To set a bookmark, position the cursor on the desired entry and click the [image] button.

To jump to a bookmark, click the [image] button. The marked object is selected.


Navigating to and from a referenced object

Where a repository object references another object, you can navigate to the referenced object from the original object. For example, if a table has a foreign key defined, you might want to navigate to the definition of the table containing the primary key that is referenced by the foreign key.

Subsequently you can navigate back to the original object from the referenced object.

To navigate to a referenced object:

1.	In the Navigator window, select the name of the object that references the other object.

2.	Click [image].

To return to the object reference:

1.	In the Navigator window, select the name of the referenced object.

2.	Click [image].


Laying out diagrams

Working with the grid

Displaying the grid

Changing the size of the grid cells

Snapping diagram items to the grid

Using autolayout

Laying out diagrams automatically

Displaying the autolayout area

Adding and removing pages

Minimizing the number of pages


Displaying the grid

Related Topics

To show or hide the grid on the active diagram:

•	Choose View→Grid.

To show or hide the grid by default:

1.	Choose OptionsLayout.

2.	To show the grid, check the Display check box.

3.	(Optional)  Click Save to show or hide the grid for the active diagram, and for all diagrams opened during the current session and in future sessions.


Changing the size of grid cells

Related Topics

The grid cells on the diagram are square, and so only one value is required to determine their size. The value that you specify for the grid cells changes both the height and width of the cells. One unit is equal to 0.01 inches on a diagram displayed at its original size.

To change the size of the squares on the grid:

1.	Choose Options→Layout.

2.	Enter a value (in the range of 10 to 100) in the Cell Size field to determine the new size of the grid cells.

Note:	The size of the grid cells affects the positions of elements moved using the AutoLayout utilities, because elements are snapped to the grid lines when they are automatically laid out.

3.	(Optional)  Click Save.


Snapping diagram items to the grid

Related Topics

Diagram items that are created or moved on the active diagram can be automatically aligned to the grid lines that are nearest to them, even if the grid is not displayed.

To snap diagram items to the grid:

1.	Choose Options→Layout.

2.	Check the Snap check box.


Laying out diagrams 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 element height and width in the Preferences 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 two ways in which elements can be automatically laid out on a diagram.

To reposition all elements automatically on the active diagram:

1.	Ensure that no elements are selected on the active diagram.

2.	Choose Layout→AutoLayout.

To reposition selected elements automatically on the active diagram:

1.	Select the elements to be automatically laid out.

2.	Choose Layout→AutoLayout.

Note:	The elements automatically laid out on the diagram are snapped to the grid lines defined for that diagram. The size of the grid cells is defined in the Preferences dialog box.

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

1.	Select the elements to be automatically laid out.

2.	Choose Layout→AutoLayout to New Area.

3.	Position the cursor at the point on the active diagram at which you want to start defining the autolayout area and hold the mouse button down. A better autolayout result can be achieved if the autolayout area you select contains a large amount of free space.

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

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.


Displaying the autolayout area

Related Topics

To show the autolayout area for the active diagram:

1.	Select Options→Show/Hide.

2.	Check the Show AutoLayout Area check box and click OK.

To hide the autolayout area for the active diagram:

1.	Select Options→Show/Hide.

2.	Uncheck the Show AutoLayout Area check box and click OK.


Using the Property Palette

Properties of repository objects are viewed and edited in the Property Palette.

About the Property Palette

The Property Palette

Displaying properties

Opening a new Property Palette

Displaying the properties of objects

Displaying the properties of a set of objects

Displaying the properties of an object while selecting another (pinning the palette)

Expanding and collapsing properties in the Property Palette

Viewing summary information of a property

Navigating to and from a referenced object using the Property Palette

Changing properties

Changing the properties of an object

Changing the properties of a set of objects

Saving property changes in the repository

Entering values for text properties

Specifying text editors for text properties

Returning properties to their original settings

Undoing the last action in the Property Palette

Copying and pasting properties of an object

Navigating the Property Palette

Using shortcut keys to work with the Property Palette


The Property Palette

Related Topics

The Property Palette enables you to view and edit the properties of objects in the Navigator. There can be any number of Property Palettes open simultaneously.

Note:	Changes in the Property Palette are not immediately stored in the repository. Such changes are saved when you close the Property Palette, select another object or choose the Save button or menu option.

When you select an element in the Navigator, the Property Palette displays the property values for that element.

The Property Palette consists of a toolbar, and a list of property types and their values. When you select a property value in this table, you can edit the property value directly. With multi-line text properties (indicated by [image]), you use the TextPad.

Some property values are selectable from a list of values screen, indicated by a [image] icon when you select the value field. You can either enter a value directly, or click the icon to display a list of values from which to choose.

Other property values are selectable from a drop-down list, indicated by a [image] icon when you select the value field. Some drop-down lists are editable, while others are not. About

Some property types are mandatory in that they must have a property value defined in the Property Palette. For example, the property type Name is a mandatory property type for the element type Table. Other property types (e.g. Owning Folder) are non-editable and cannot be changed using the Property Palette.

Different colors are assigned to mandatory and non-editable property types so that you can recognize them in the Property Palette. By default, the names of mandatory properties are shown in red, and those of non-editable properties in green.

If all the property values appear in green and a value field displays with a gray background when you select it, the object is probably under version control and checked in. You can edit the properties of versioned objects only when they are checked out.

By default, the window is displayed as a grid, with the property names listed vertically and their values listed alongside.

Alternatively, you can display the window as a spreadtable. Using this format, you can list more than one set of properties in the window. For example, you can select two or more objects (either of the same type or of different types) from the Navigator and compare their property values on the spreadtable.

You can get help information on properties in the Property Palette by clicking the [image] context-sensitive help button then selecting the property on which you require information. Alternatively, select a property name or value and press F1.


About drop-down lists in the Property Palette

There are two types of drop-down list in the Property Palette: editable and non-editable.

An editable drop-down list allows you to enter any text in the value field, or choose from a set of values supplied in the list. A non-editable list allows you only to choose a value from the list.

Action	Effect with editable list	Effect with non-editable list
Double-click the property name field	Sequences through the list	Sequences through the list
Select the value field	Enables text entry	Displays the entire list
Select the value field, press ENTER then use UP ARROW or DOWN ARROW	Sequences through the list	Sequences through the list
Type character in value field with list displayed	Enters character in field	None
Type character in value field with list not displayed	Enters character in field	Selects first value in list that begins with this character, if any


Opening a new Property Palette

Related Topics

A Property Palette can be used for viewing and editing the properties of an object. For any selected object (or group of objects), it contains the properties and property values.

To open a new Property Palette:

1.	If the new Property Palette is to be displayed in addition to a currently displayed Property Palette, pin the existing Property Palette.  How

Note:	If an unpinned Property Palette is open, and you try to open an additional palette, the existing palette becomes the active window. A new palette is not opened.

2.	Press F4 or choose Tools→Property Palette.


Displaying the properties of objects

Related Topics

To display the properties of an object:

1.	If there are no Property Palettes available, open a new Property Palette.  How

2.	Select the object from the Navigator to display the properties in the Property Palette.

The properties of this object remain in the Property Palette until you select another object in the Navigator. It is possible to pin a Property Palette so that it retains the information on the selected object even after a different object has been selected in the Navigator. How


Displaying the properties of a set of objects

Related Topics

You can view the properties of more than one object together.

To view the properties of a set of objects of the same object type:

1.	Open a new Property Palette, if necessary.  How

2.	Select the objects whose common properties you want to view. The objects should be of the same object type.

The property types for the object type are displayed in the Property Palette. Where there is a conflict with the value of a given property, the property value is displayed with a set of hashes (#####). For example, the property value for Table Name will always be displayed as #####. Table names must always be unique.

3.	(Optional)  To sequence through the set of selected objects, click [image] or

repeatedly on the Property Palette toolbar.

To return to the combined view, click [image] on the Property Palette toolbar.

4.	(Optional)  If you want to compare all the properties by using the spreadtable view, click [image] on the Property Palette toolbar.

To view the properties of a set of objects of different types:

1.	Open a new Property Palette, if necessary.  How

2.	If the Union/Intersection button on the Property Palette toolbar is not already set as desired, click it to show the [image] button (displays only the common

property types) or the [image] button (displays all the property types combined).

3.	Select the objects whose properties you want to view.

4.	(Optional)  To sequence through the set of selected objects, click [image] or

repeatedly on the Property Palette toolbar.

To return to the combined view, click [image] on the Property Palette toolbar.

5.	If you want to compare all the properties by using the spreadtable view, click [image] on the Property Palette toolbar.


Displaying the properties of an object while selecting another (pinning the Palette)

Related Topics

You can cause the properties displayed in a Property Palette to remain unchanged even if you select another object from the Navigator. This action is known as "pinning" the palette. Doing so could be useful for displaying the properties of an important object while working elsewhere in the Navigator. Releasing a Palette from the pinned state is known as "unpinning" the palette.

You can make changes to properties in a pinned Property Palette.

To pin a Property Palette:

•	Click [image] on the Property Palette toolbar so that it shows a circle symbol.

With a pinned Property Palette on the screen, you can open a new Property Palette to view or edit the properties of a newly selected object.

To unpin a Property Palette:

•	Click [image] so that the pin symbol is displayed.


Expanding and collapsing properties in the Property Palette

Related Topics

Expanding and collapsing groups of related properties in the Property Palette is similar to collapsing and expanding repository objects in the Object Navigator. The Palette's Expand/Collapse icons are identical to the Navigator's + and - icons.

You can either expand or collapse a single group of related properties, or you can expand or collapse all named groups of properties.

To expand and collapse individual groups:

Do one of the following:

•	Click on the Collapse/Expand icon of an expanded/collapsed group.

•	Double-click on the group label (shown in bold type) to toggle between the expanded and collapsed state.

•	Select the group that you want to expand/collapse by clicking on the group label and then choosing either Property→Expand or Property→Collapse.

To collapse and expand all groups of related properties:

•	Choose Property→Expand All or Property→Collapse All.


Viewing summary information on a property

Related Topics

For each property of a repository object, you can display certain details, such as maximum length and datatype, together with the name of the repository table and column where the property definition resides.

To view summary information on a property:

1.	Select the required element or association in the Navigator.

2.	If necessary, open a Property Palette.  How

3.	Select the property on which you want to view summary information.

4.	Press F5.


Navigating to and from a referenced object using the Property Palette
Navigating to a referenced object

Where a repository object references another object, you can navigate to the referenced object from the original object. For example, if a table has a foreign key defined, you might want to navigate to the definition of the table containing the primary key that is referenced by the foreign key.

To navigate to a referenced object:

1.	In the Property Palette, select the name of the object that references the other object.

2.	Choose Properties→Locate Object Definition.


Changing the properties of an object

Related Topics

You can change the properties of an object using the Property Palette. You can also change a property of a group of objects. How

When you attempt to change the properties of an object, data locks are taken out to prevent concurrent updates by other users. If the attempted lock fails, e.g., the object is locked by another user, you are informed of the reason for the failure.

To change the properties of an object:

1.	View the properties of the object.  How

2.	If necessary, scroll the Property Palette until the property you want to edit is on view.

3.	Select the property.

The property value field varies according to the property you select. Some properties have a drop-down list of possible values while others require you to type what you want in the field.

4.	Edit the property value.

Note:	When working in the Property Palette, the changes you make are not immediately stored in the repository. The properties are committed to the database when you select another object in the Object Navigator. If you are concerned about losing data, you can save the recent property changes in the repository.   How


Changing properties

Changing a property of a primary access controlled (PAC) element creates a lock on the entire element and prevents the element from being updated by another user until the lock is released.

Example: changing the name of a table creates a lock on all properties of that table element until the transaction is complete; i.e., saved or canceled.

Changing a property of a secondary access controlled (SAC) element creates a lock on the row being updated, but other rows remain unlocked. It is possible for another user to update these unlocked rows. The lock is released when the transaction is complete.

Example: User A attempts to update column EMPNO on table EMP and a lock is taken out on that column. Column ENAME on table EMP is locked by User B. At this stage, each user's view of table EMP is unchanged; i.e., the changes made by User B are not visible to User A, and vice versa. When the changes are saved, the locks on both columns are released.

There are now two representations of EMP. Each user's view of EMP will become the same when one of the following happens:

•	User A or B next edits table EMP.

•	Either user attempts to change a column whose value has changed.

In this way, data integrity is preserved.


Changing the properties of a set of objects

Related Topics

You can define a value for a given property in each object in a specified set.

For example, in a single operation, you could select a group of tables and change the Journal property value from Client to Server. You can apply this task to objects of different object types. For example, you could set the Journal property in a set of selected tables and views.

To change the properties of a set of objects:

1.	View the properties of the required set of objects.  How

Note, If you are selecting objects of different object types, set the Union/Intersection toolbar button to [image] (Intersection) because you are not interested in property types that are not common to all object types.

2.	If necessary, scroll the Property Palette until the property you want to edit is on view.

3.	Select the property that you want to edit.

4.	Enter a new value for the property.

Note:	When working in the Property Palette, the changes you make are not immediately stored in the repository. The properties are committed to the database when you select another object in the Navigator. If you are concerned about losing data, you can manually save the recent property changes in the repository.   How


Saving recent property changes in the repository

Related Topics

To save the changes you have made in the Property Palette, click [image].

You can do this in either the main toolbar or the Property Palette tool palette.

This task applies to the Property Palette only; changes you make in the Navigator window (e.g., creating and deleting objects) are automatically committed to the database.


Entering values for text properties

Related Topics

Some repository objects can have one or more text properties. Some of these text properties (e.g., Description or Notes) permit the entry of multi-line text (these properties are indicated in the Property Palette by a [image] icon next to the property name).

To enter a value for a text property:

1.	If the property has no icon next to its name, click the value field and type in the text.

Note:	Double-clicking the property name or value field opens the TextPad for you to use, but the text is saved in a single line.

2.	If the property has a [image] icon, indicating that you can enter multi-line text, do one of the following:

•	Double-click the property name or the value field, or click [image] in the toolbar, to open the TextPad.

•	Click [image] in the toolbar to open the specified ASCII text editor, e.g., Windows WordPad or Notepad.

•	Click [image] in the toolbar to open the specified HTML editor.


Specifying text editors for text properties

Related Topics

A basic text editor, the TextPad, is provided for use when entering values for those text properties (for example, Description or Notes) that make use of multi-line text. These properties are indicated in the Property Palette by a [image] icon next to the property name.

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.

To specify a text editor:

1.	Choose Options→Text Editor Options.

2.	In the Text Editors dialog box:

•	(Optional)  In the Text Editor field, type the command that runs the ASCII text editor you want to use, or use the Browse button to locate the .EXE file for the editor. Ensure that the filename is followed by the characters <SPACE>%1 in order for the command to function correctly.

•	(Optional)  In the HTML editor field, type the command that runs the HTML editor you want to use, or use the Browse button to locate the .EXE file for the 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.


Reverting properties to their previous settings

Related Topics

If, while creating an object or editing its properties, you decide not to implement the changes you have made, you can cancel any changes you may have made, provided that you have not yet saved these changes.

To return the properties of the current object to their original settings:

•	Click [image] on one of the toolbars.

In the Application window toolbar (and the Navigator toolbar in the Repository Object Navigator), this button cancels the effect of unsaved changes to the current workarea.

In the Property Palette, this button merely cancels the effect of unsaved changes to object properties.

Example

If you highlight an object type in the Navigator window and click the Create button or choose Edit→Create to create an object of that type, the icon that represents the object type appears in the Navigator and a set of properties is displayed in the Property Palette.

If you begin to enter properties but do not save them, clicking the Revert button in the Property Palette toolbar simply returns the properties to their values before you began to change them. Contrast this with clicking the Revert button in the Application window toolbar or the Navigator toolbar, which erases both the properties display and the new icon.


Undoing the last action in the Property Palette

You can undo and redo the most recent change you have made on a Property Palette by choosing Edit→Undo.


Copying and pasting properties of an object

Related Topics

You may find that having created an object, some of the property values you want to give it exactly match the values for an object you have already created. Instead of entering these values again, you can copy them from the existing object and paste them into the new object.

To copy properties to the Properties Clipboard:

1.	Select the properties that you want to copy.

2.	Choose Edit→Copy Properties.

The selected properties are copied to the Properties Clipboard.

Note:	Choosing Edit→Copy Properties overwrites the contents of the Properties Clipboard; you cannot merge copied properties.

To paste the contents of the Properties Clipboard:

1.	Select the object to which you want the copied properties to be applied.

2.	Choose Edit→Paste Properties.

This procedure can be performed many times; pasting does not clear the Properties Clipboard.

If you are unsure of the current Properties Clipboard contents, you can view them by choosing Edit→View Copied Properties.


Using shortcut keys to work with the Property Palette

Shortcuts when using the Property Palette

To		Press
Navigate vertically down the Property Palette columns		DOWN ARROW
Navigate from left to right down the Property Palette columns		TAB
Open or close a group heading in the left column (the group heading must be the context cell)		ENTER


The Message Window
About the Message Window

Related Topics

The Message Window displays progress information and details of any errors or warnings that occur during the generation and design capture processes.

The contents of the message window will be read by screen reading software when the up and down arrow keys are pressed.

Note:	The message window is displayed automatically when you perform generation or design capture.  Alternatively, you can display or hide it by choosing View→Message Window.

Understanding the message colors

All generators use the following message colors:

Color	Severity	Description
Red	Error	A serious fault has been identified that halts generation or capture.
Blue	Warning	A fault has been identified that may produce undesirable results in the generated or captured object .

During application generation, properties with invalid or unset values are adjusted by the generator products. However, in some cases it is not possible for properties to be adjusted, e.g., if an element is checked in.

Messages are displayed to identify whether property values have been adjusted. The following colors are used:

Color	Severity	Description
Green	Warning	The property value has been adjusted.
Purple	Information	The property value has not been adjusted.
Messages concerning applied adjustments are given a severity of "Warning", while those concerning failed adjustments are given a severity of "Information". This allows you to suppress the display of failed adjustment messages, by setting the message reporting level to "Warning".

Adjustment messages are grouped under header warning messages, as shown in the following example.

CGEN-03499 WARNING: Invalid/unspecified properties adjusted in module definition
CGEN-03484 ADJUSTMENT: Window WINDOW: Defaulting Property 'Title'
CGEN-03484 ADJUSTMENT: Component MC1: Defaulting Property 'Overflow'

CGEN-03500 WARNING: Some invalid/unspecified properties could not be adjusted in repository
CGEN-03484 ADJUSTMENT FAILED: Component MC2: Defaulting Property 'Canvas Width'
CGEN-03484 ADJUSTMENT FAILED: Component MC2: Defaulting Property 'Canvas Height'

Using the Message Window

Locating and fixing errors after generation

Copying error messages to the Clipboard

Clearing the Message Window

Displaying the Build Actions dialog box

Setting the default display level for error messages


Locating and fixing errors after generation

Related Topics

During generation and design capture the Message Window displays progress information and details of any errors or warnings that occur. Use the automated message action facility to fix any errors and then generate again.

Note:	You can set the level of the error messages you want to be displayed in the Message Window, e.g. Information.  How

To locate and fix errors after generation:

1.	From the Message Window, select an error/warning message from the error stack.

2.	(Optional) Click [image] on the Message Window tool palette to show the cause and action help text for the message.

Alternatively, right-click on a selected message to show its cause and action.

3.	Click [image] to navigate to the source of the error. If the source of the error is available, it is highlighted in the Navigator.

Alternatively, double-click on the message to navigate directly to the first source of the error in the list. If it is not possible to navigate to the source of an error, double-clicking will display the help (cause and action descriptions) for the error or warning message.

Note:	In some cases you may have to respond to more than one action/source to correct an error, in which case the list of actions are displayed in the Message Action dialog box.

4.	If the Message Action dialog box is displayed for the error you have selected, choose a message action from the list.

An appropriate window or tool is invoked that you can then use to rectify the error.

5.	Carry out the modifications as necessary (e.g. modify the property or preference).

6.	Use the [image] to select the next error in the error stack and repeat steps 3 to 5 to fix all

errors and warnings.


Copying error messages to the Clipboard
Copying error/warning messages to the Clipboard

Related Topics

You can copy selected error/warning messages in the Message Window to the Clipboard. During generation the Message Window displays progress information about the generation process and details of any errors that occur. Each time you copy selected messages, they are placed on the Clipboard, overwriting its previous contents. The contents of the Clipboard can then be pasted back into another tool (e.g. Notepad).

To copy messages to the Clipboard:

1.	Select the messages you want to copy.

2.	Click [image].


Clearing the Message Window

Related Topics

The Message Window displays details of any errors or warnings that occur during the generation process. To clear the contents of the Message Window, choose Messages→Clear Message. To undo the clear, choose Edit→Undo.


Displaying the Build Actions dialog box

Related Topics

The Build Actions dialog box displays a list of possible actions available after generation or design capture (e.g. to view or run the generated files). The contents of this list is dependent on what is being generated.

To display the Build Actions dialog box:

Do one of the following:

•	Choose Messages→Build Actions.

•	Click [image] on the Messages Window toolbar.


Listing external references

For certain operations it is very useful to know details of which objects in a particular context (a workarea, container or configuration) make reference to objects outside that context. For example, when exporting a set of objects that make up a configuration, you may want to check whether external references exist in the set, so you can ensure that the exported set is complete.

You can check whether external references exist for an object in its current context and, if necessary, include the referenced objects in that context.

To list external references:

1.	Select the workarea, container or configuration for which you want to list the external references, depending on the current tool.

2.	Choose Utilities→External References.

3.	If you want the display to show only the mandatory references, select List Mandatory Only and click List.

4.	If you want the display to also show external references for child objects of this workarea, container or configuration (for example, subfolders of a folder), select Recurse Sub Folders.

5.	If you want to include one or more listed objects in the context workarea, container or configuration, select those objects and click Include.

If you want to include all the listed objects, click Select All, then click Include.

Alternatively, if you want to include an object and all objects referenced by it (and so on until all references are exhausted):

a.	Select the object in the list.

b.	Select the Include Iteratively check box.

c.	Click Include.

6.	If the context is a workarea or configuration and you want to list objects from a checkin branch other than the default, choose the branch from Show Latest on Branch (this does not appear if the context is a container).

7.	If the context is a workarea or configuration and you want to display a different version of a listed object:

a.	Select that object in the list.

b.	Click Change Version.

c.	In the Select Object Version dialog, select the version you want to display and click OK.

8.	If you want to know which objects reference a listed object and the kind of reference they make to it, select the object in the list and click List References.


Updating columns/attributes in a domain

You can update all the columns/attributes in a selected domain with the property details of that domain. You may want to do this when you edit a domain and want to update all the columns/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.

To update columns/attributes in a domain:

1.	Select the domain for which you want to update columns or attributes.

2.	Choose Utilities→Update Columns/Attributes in a Domain.

Note:	From the Repository Object Navigator, choose Utilities→Designer→Update Columns/Attributes in a Domain.

The columns/attributes in the domain that you select will be updated with the values held in that domain.


Publishing diagrams

Use these procedures to publish Designer diagrams to the Repository Object Browser (ROB) or to save them as files.

To publish diagrams to the ROB:

1.	From the Design Editor, choose Utilities→Publish Diagrams.

The Publish Diagrams dialog opens.  The diagrams available for publishing are listed beneath the directories in the Available Diagrams pane.

2.	Use the arrow keys to populate the Selected Diagrams pane with the diagrams that you want to publish.

3.	In the Destination group, choose Publish to Repository Object Browser.

4.	From the Publish Format drop-down list, choose a file format for the published diagrams.

5.	To publish the selected diagrams to the ROB, click OK.

A progress dialog appears, showing the name of the diagram currently being published.  If you want to cancel the publish diagrams operation, click Cancel.  The operation will be cancelled after the current diagram is published.

The time taken to publish a diagram will be the same as the time taken by a diagrammer to open the diagram.

At the end of the process, the selected diagrams will be published to the ROB in the specified format.

To publish diagrams as image files:

1.	From the Design Editor, choose Utilities→Publish Diagrams.

The Publish Diagrams dialog opens.  The diagrams available for publishing are listed beneath the directories in the Available Diagrams pane.

2.	Use the arrow keys to populate the Selected Diagrams pane with the diagrams that you want to publish.

3.	In the Destination group, choose Publish to File.

The File Name text box is enabled, and shows the default file name of the diagram that is currently highlighted in the Selected Diagrams pane.  Selecting a diagram in the Selected Diagrams pane will show its default file name in the File Name text box.  You can change a default diagram name by overtyping it.

The Directory text box is enabled.  Type in the name of the directory to which you want the diagrams to be published, or use the Browse button to choose an existing directory.

4.	From the Publish Format drop-down list, choose a file format for the published diagrams.

5.	To publish the selected diagrams as files, click OK.

A progress dialog appears, showing the name of the diagram currently being published.  If you want to cancel the publish diagrams operation, click Cancel.  The operation will be cancelled after the current diagram is published.

At the end of the process, the selected diagrams will be published to the chosen folder in the specified format.


 Using the TextPad

You can use the TextPad to enter text in the same way as you would in the Windows Notepad facility.

Opening the TextPad

Including a text file

Saving the current text as a text file

Cutting, copying and pasting text

Finding a specified text string

Replacing occurrences of a specified text string

Attaching text to the property

Printing a TextPad


 Opening the TextPad

Related Topics

You can use the TextPad to attach text to a multi-line text property.

To open the TextPad:

1.	In the Navigator, select the object that has the property to which you want to attach the text. If the property is a multi-line text property, the [image] icon is displayed next to the property name.

2.	In the Property Palette, do one of the following:

•	Click the [image] icon

•	Double-click the property name

•	Click the property value field, then click the [image] button in the Property Palette toolbar


 Adding multi-line text with the TextPad

Related Topics

Some properties in the Property Palette can consist of only a single line of text, while others can have more than one line. The latter type are known as multi-line text properties, and are indicated in the Property Palette with a [image] symbol.

You can use the TextPad (as well as other editors) to add text to a multi-line text property.

To use the TextPad to add multi-line text:

1.	Open the TextPad.

2.	Enter text using the TextPad. How

3.	Attach text to the property. How


 Including text files

Related Topics

You can include text from an existing file in the TextPad. The TextPad supports ASCII text only, so you cannot include word processor files (e.g., .DOC files).

To include the text of an existing file in the TextPad:

1.	Move the cursor to the point where you want to include the text file.

2.	Choose File→Include File.

3.	In the Open dialog box, specify the text file that you want.


Saving the current text as a text file

Related Topics

When using the TextPad you can save text to a file.

To save the text shown in the TextPad as a text file:

1.	Choose File→Write to File.

2.	In the Save As dialog box, specify the name and location of your file.


 Cutting, copying and pasting text

Related Topics

To remove text and place it on the Clipboard:

1.	Select the text you want to remove.

2.	Choose Edit→Cut.

To place a copy of text on the Clipboard:

1.	Select the text you want to copy.

2.	Choose Edit→Copy.

To delete text without placing it on the Clipboard:

1.	Select the text you want to delete.

2.	Choose Edit→Clear.

To paste the Clipboard contents:

1.	Move the cursor to the position at which you want the Clipboard contents to be inserted.

2.	Choose Edit→Paste.

You can repeat the paste operation as many times as you want.

Note:	You can paste text from text files in Wordpad and other text editors or word processors.


 Finding a specified text string

Related Topics

You can search for every occurrence of a specified text string in the TextPad. You decide the direction of the search and whether it is case-sensitive.

To find a specified text string:

1.	Position the cursor where you want the search to start.

2.	Choose Edit→Find.

3.	In the Find dialog box, type the text for which you want to search.

Note:	The text in the Find What field defaults to the current selection, if any, in the TextPad.

4.	(Optional)  Click the Up or Down button to select the direction of the search (default is Down).

5.	(Optional)  If you want a case-sensitive search, select the Match Case check box.

6.	Click Find Next.

7.	(Optional)  Repeat step 6 until you find the text you want.


 Replacing occurrences of a specified text string

Related Topics

You can search for and replace occurrences of a specified text string with a different text string. You decide whether the replace is case-sensitive and whether you want a global or a discretionary replace operation.

To replace instances of a given text string:

1.	Position the cursor where you want the replacement to start.

2.	Choose Edit→Replace.

3.	In the Replace dialog box, type the text that is to be replaced in the Find What field.

Note:	The text in the Find What field defaults to the current selection, if any, in the TextPad.

4.	Type the new text in the Replace With field.

5.	(Optional)  If you want a case-sensitive replace, select the Match Case check box.

6.	(Optional)  If you do not want to replace all instances of the specified text:

a.	Click the Find Next button to find the next instance of the specified text.

b.	Click Replace if you want to replace the text.

c.	Repeat steps a. and b. as desired.

7.	(Optional)  If you want to replace all instances of the specified text, click Replace All.


Attaching text to the property
 Attaching text to a property

Related Topics

To attach the text in the TextPad to the multi-line text property:

Do one of the following:

•	Click [image] to attach the text and leave the TextPad open.

•	Choose File→Close to attach the text and close the TextPad.

To close the TextPad without attaching the current text:

•	Click [image]. The TextPad is closed and any unsaved changes made to the text are lost.


 Printing a TextPad

Related Topics

To print the contents of the TextPad:

1.	(Optional)  Change the print setup. How

2.	With the TextPad window selected, choose File→Print.

3.	In the Print dialog box, specify the range of pages to be printed.

4.	Specify the number of copies and whether or not you want the copies to be collated.

5.	If you want to change details of the destination printer, click the Properties button.


* # $ All Containers

* # $ K Allowable Values

* # $ K Application Systems

* # $ K Assumptions

* # $ K Assumptions to Tables

* # $ K Module Assumptions

* # $ Configurations

* # $ Container Member

* # $ K Database Files

* # $ Diagram Element Usages

* # $ Diagrams

* # $ Document Attachments

* # $ Documents

* # $ K Domains

* # $ Extended Elements

* # $ Extended Structure Elements

* # $ Files

* # $ Folders

* # $ Installations

* # $ Locations

* # $ Objectives

* # $ Operating System Files (Source & Record Files)

* # $ K Preference Sets

* # $ k Problems

* # $K Transformation Mapping Sets

* # $ K A Transformation Mapping Elements

* # $ A Set Member Items

* # $ A User Defined Sets

* # $ Workareas

* # $ Audit properties

All Containers

Allowable Values

Application Systems

Container Member

Configurations

Database Files

Diagram Element Usages

Diagrams

Document Attachments

Documents

Domains

Extended Elements

Extended Structure Elements

Files

Folders

Installations

Locations

Objectives

Operating System Files

Preference Sets

Problems

Transformation Mapping Elements

Transformation Mapping Sets

Set Member Items

User Defined Sets

Workareas

Audit properties

Common properties (Owner, Name, Version, OS Timestamp, Description, Notes etc)

The Property Palette

Locked primary elements flag


All Containers

Enables you to view all the containers to which you have access in the repository, as well as the Lost+Found area and the global wastebasket.

Lost+Found shows repository objects that do not currently reside in a container.

The global wastebasket includes the contents of wastebaskets in all the workareas to which you have access, together with any objects or object versions that are not visible in any workarea.


Allowable Values

About allowable values

An allowable value defines the values that an attribute, column, domain, module argument or unbound item can take. You can enter a single value, or a range of values (specified as value and high value).

Allowable Value definition properties

Owning Container

Entity (for Entity Attributes only)

Attribute (for Entity Attributes only)

Domain (for Domains only)

Column (for Columns only)

Module Argument (for Module Arguments only)

Unbound Item (for Unbound Items only)

Value

Version

Value Type

High Value

High Value Type

Abbreviation

Meaning

Display Sequence

Documentation

Description

Notes

Related topics

Domains


Display only
The name of the attribute for which you are defining the allowable values.


Display only
The name of the domain with which the attribute or column has been associated.


Display only
The name of (for Table) the table containing the column, or (for Column) the name of the column.


Display only
The name of (for Module) the module or PL/SQL definition to which the argument relates, or (for Module Argument) the name of the argument or parameter with which the attribute has been associated.


Display only
The name of the unbound item for which you are defining the allowable values.


Mandatory, 40 characters
The valid value to be used. If a range is not specified this value alone is used.

When defining a range of values, this value is used to define the low value.

Note: To specify whether this is a literal string or a database function call, set the Default Value Type property.

If the Dynamic List? property of an associated  column or domain is set to Yes, the allowable value is stored in a character column within a reference code table. The Generate Reference Code Table utility either generates the value as the literal value specified, or evaluates the function and if necessary manipulates the output into a character representation using the default Format Mask defined during generation.

Take care entering functions which perform date or number conversions. For example, if you specify the allowable value TO_DATE('05-06-1999','DD-MM-YYYY') an insert statement is generated to set the character column in the reference code table. As this expression returns a DATE datatype an implicit format mask is used to convert it to a character string. Typically a value of '05-MAY-99' would be stored.

This may cause problems if an application, running in French for example, tries to check a user entered value against the list of allowable values. In this instance the string would be expected to be in French format, e.g. '05-MAI-99'.  For this reason it is recommended that Domain Key Constraints are used instead of allowable values to define DATE and NUMBERIC sets of allowable values.


Mandatory, 15 characters
Indicates the nature of the value specified in the Default Value property, i.e., whether it is a literal string or a database function call.
Default: Literal


Optional, 40 characters
Identifies a high value if a range of values is being defined.

Note: To specify whether this is a literal string or a database function call, set the Default Value Type property.


Mandatory, 15 characters
Indicates the nature of the value specified in the Default Value property, i.e., whether it is a literal string or a database function call.
Default: Literal


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


Optional, 240 characters
The full meaning for the abbreviation or short code value, entered above, to describe the value or range specified.


Optional, 6 digits
The sequence in which the value appears in a generated application.


Application Systems

About application systems

An application system is a named set of object definitions in the repository. An application system typically corresponds to a database application that you are designing and building. For example, if your site was planning to develop applications for personnel management, payroll and stock control, you might create three application systems named PERSONNEL, PAYROLL and STOCK.

The application system definition can include information such as the name of the person or organization that has authorized development of the application, the name of the repository user who owns the application and other details such as a summary of the purpose of the application.

You must have access to a workarea with an existing application system or other container before you can create any repository objects. You can create application systems from the Repository Object Navigator or other tools. Note, however, that only the Repository Object Navigator offers access control facilities for your application systems.

The application system is initially owned by the user who created it. Full access rights on the application system are automatically set up for the application owner. Subsequently, the owner can use the Repository Object Navigator to grant access rights or transfer ownership to any other repository user.

You can create a child application system of an application system. The parent-child relationship allows you to group related application systems together by specifying a parent for them. You can make a copy of an application system under a new name. The original application system remains in the repository.

Application System definition properties

Name

Version

Title

Authority

Owner

Data Warehouse ?

Documentation

Priorities

Constraints

Comment

Summary

Objectives

Description

Notes

OS Timestamp


Optional, 40 characters
The title by which this application is to be reported on screens and reports in the implemented system.


Optional, 10 characters
The name of the person, or organization, authorizing this application system (for documentation purposes only).


Mandatory
Indicates whether or not this is a data warehouse application. If set to 'Yes', Oracle Designer tools validate information you enter in the repository for this application system, to ensure that it conforms to a star/snowflake model.


Optional, 240 characters
The priorities of the application system.


Optional, 240 characters
Any constraints on this application system.


Optional, 240 characters
Any additional comments.


Optional
A summary of the purpose of the application system (multi-line text).


Optional
The objectives of the application system (multi-line text).


Configurations

A configuration is a set of specific versions of selected repository objects. About

Configuration definition properties

Name

Description


Mandatory, 256 characters
The name of the configuration.


Optional, 2000 characters
A description or note about this configuration.


Container Member

The [image] icon indicates that this object is owned by a container other than the one from which you are viewing it.


Database Files

A database file is either a data file or a redo log file in an Oracle or other database.

Database File definition properties

Owning Container

Oracle Database

Tablespace

Name

Version

Full Pathname

Reuse ?

Group Number*

Size

File Size

File Size Unit

Maximum Size**

Maximum Size Unit**

Autoextend**

Autoextend ?**

Next Autoextend Amount**

Next Autoextend Units**

Documentation

Comment

Description

Notes

* 	displayed only for log files
**	displayed only for data files


Display only
The name of the Oracle database to which this file belongs.


Display only
The name of the tablespace to which this file relates (displayed if the file definition was created from a tablespace definition).


Mandatory, 100 characters
The name of the file.


Optional, 240 characters
The full pathname for the file, including the extension (and the node, if appropriate).


Mandatory
Indicates whether or not the database will be permitted to reuse the existing file. If the file does not exist, it will be created.


Optional, 6 digits
A group number for the redo log file, for use with the redo log group feature of the Oracle database server.


Optional, 10 digits
The file size, in units specified by the File Size Unit property.


Optional
The units for the file size: choose from Kilobytes or Megabytes.


Optional, 10 digits
The maximum size to which the file can be extended, in units specified by the Maximum Size Unit property. If no value is specified here, the file size is unlimited.


Optional
The units for the maximum size: choose from Kilobytes or Megabytes.


Mandatory
Indicates whether the file can be automatically extended via the AUTOEXTEND feature of the Oracle database server.


Optional, 10 digits
The amount by which the file can be automatically extended, in units specified by Next Autoextend Units.


Optional
The units for automatic extension: choose from Kilobytes or Megabytes.


Optional, 70 characters
A brief comment about the file.


Diagram Element Usages

A diagram element usage specifies an element in the repository that is displayed on a diagram.

Note:	You cannot create a diagram element usage or change the properties of a diagram element usage using the Navigator Property Palette. You must use the appropriate modeling or design tool.

Diagram Element Usage definition properties

Owning Container

Diagram Name

Diagram Type

Element Name

Related topics

Diagrams


Display only
The name (Diagram Name) and type (Diagram Type) of the diagram on which the current element is displayed.


Display only
The name of the current element.


Diagrams

A diagram represents a set of elements that are created or displayed via a modeling or design tool.

Note:	You cannot create a diagram via the Property Palette. You must use the appropriate modeling or design tool.

Diagram definition properties

Owning Container

Name

Diagram Type

Version

Title

Author

Scenario

Package

Documentation

Change History

Description

Notes

Related topics

Diagram Element Usages


Mandatory, 40 characters
The name of the diagram.


Display only
The modeling or diagramming tool that produced the diagram.


Optional, 40 characters
The title of the diagram.


Optional, 30 characters
The author of the diagram.


Optional
Indicates whether the diagram depicts the current situation (As Is) or the desired situation (To Be).

This property is for documentation purposes only, and is particularly suited for business process diagrams produced by Process Modeller.


Optional
The name of a package to which this diagram relates.


Optional
The change history of the diagram (multi-line text).


Document Attachments

A document attachment specifies an element with which a document is associated.

Document Attachment definition properties

Document

Parent*

Element

Version

*  displayed only for elements having a parent

Related topics

Documents


Display only
The name of the document with which the attachment is associated.


Display only
The name of the parent of the element attached to the document.


Display only
The name of the element attached to the document.


Documents

About documents

A document definition in the repository is a record of a particular document used in developing an application. Various types of document may be produced during application development, for example:

•	Terms of Reference

•	Feasibility Study

•	Product Proposal

•	Delivery and Acceptance Plan

•	System Test Plan

•	Installation Guide

•	Any other user-defined document

The information that can be specified includes the document name, the location of the file that contains the document, the name of the author, the creation date, the document version number and the current status of the document.

Document definition properties

Owning Container

Name

Version

Author

Type

Status

Format

Source Path

Ref

Change Control

Version

Date Document Created

Date Document Changed

Changed By

Authorization

Authorization Date

Authorized By

Documentation

Comment

Document Text

Description

Notes

Related topics

Document Attachments


Mandatory, 100 characters
The name of the document.


Optional, 80 characters
The library reference for the document.


Mandatory, 3 digits
The latest version number of the document itself (as distinct from the version label of this document definition).


Mandatory, 30 characters
The author of the document.


Optional, DATE
The date on which the document itself was created (as distinct from when this document definition was created).


Optional, 30 characters
The name of the person who last amended the document itself (as distinct from who last modified this document definition).


Optional, DATE
The date on which the document itself was last changed (as distinct from when this document definition was last changed).


Optional, 30 characters
The person or committee that authorized the creation of the document.


Optional, DATE
The date on which the document was authorized.


Optional, 40 characters
The document type (e.g., High-Level Design, Module Specification). You can choose a type from the list or enter your own.


Optional, 20 characters
The document format (e.g., ASCII, Framemaker, MS Word).


Optional, 10 characters
The status of the document (e.g., Draft, Definitive). You can choose a status from the list or enter your own.


Optional, 240 characters
The location of the file that contains the document.


Optional, 240 characters
A comment or brief description of the document.


Optional
The text of the document (multi-line text format).


Domains

About domains

A domain defines a set of validation rules, format constraints and other properties that apply to a group of entity attributes, columns, program data constructs, module arguments, datastructure items or unbound items.

If you make a change to a domain, you can propagate the updates to associated columns or attributes using the Update Columns in a Domain or Update Attributes in a Domain utility, available from the Utilities→Designer menu on the Repository Object Navigator.

Domain definition properties

Owning Container

Name

Version

Subset Of

Authority

Attributes in Domain

This group of properties relates to attributes in entity-relationship models only. These properties do not apply to Oracle object type attributes defined in a server model. If defining domains for Oracle object type attributes, use the 'Columns in Domain' properties.

Format

Average Att Length

Maximum Att Length

Att Decimal Places

Unit Of Measure

Derivation

Derivation Expression

Columns in Domain

This group of properties relate to columns and Oracle object type attributes in server models.

Datatype

Average Col Length

Maximum Col Length

Col Decimal Places

Dynamic List?

Default Value Type

Attributes and Columns

Default

Null Value

Documentation

Comment

Description

Notes

Related topics

Allowable Values


Mandatory, 40 characters
The name of the domain.


Display only
The name of the immediate parent for this domain, if a hierarchy exists.

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


Optional, 240 characters
A comment or brief description of this domain.


Mandatory, 10 characters
The format for entity attributes in this domain. Valid formats are: CHAR, DATE, IMAGE, INTEGER, MONEY, NUMBER, PHOTOGRAPH, SOUND, TEXT, TIME, TIMESTAMP, VARCHAR2 and VIDEO.

Note:	This property relates to attributes in entity-relationship models only.


Optional, 5 digits
The average length for entity attributes in this domain.

Note:	This property relates to attributes in entity-relationship models only.


Optional, 5 digits
The maximum length for entity attributes in this domain.

Note:	This property relates to attributes in entity-relationship models only.


Optional, 4 digits
The number of decimal places for entity attributes in this domain.

Note:	This property relates to attributes in entity-relationship models only.


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

Note:	This property relates to attributes in entity-relationship models only.


Optional
The format for columns or Oracle object type attributes in this domain. Valid formats are: BFILE, BINARY INTEGER, BLOB, CHAR, CLOB, DATE, DECIMAL, DOUBLE PRECISION, FLOAT, GRAPHIC, IMAGE, INTEGER, LONG, LONG RAW, LONG VARCHAR, LONG VARGRAPHIC, MLSLABEL, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, REAL, ROWID, SMALLINT, SOUND, TEXT, TIME, TIMESTAMP, VARCHAR, VARCHAR2, VARGRAPHIC, VIDEO.

Note:	This property relates to server models only.


Optional, 5 digits
The average length of columns or Oracle object type attributes in this domain.

Note:	This property relates to server models only.


Optional, 5 digits
The maximum length of columns or Oracle object type attributes in this domain.

Note:	This property relates to server models only.


Optional, 4 digits
The number of decimal places for columns or Oracle object type attributes in this domain.

Note:	This property relates to server models only.


Optional, 10 characters
The level of authority needed to update this domain.


Optional, 60 characters
The default value for the attributes/columns in the domain.

Note: To specify whether this is a literal string or a database function call, set the Default Value Type property.


Optional, 40 characters
The value to be used to indicate that the attribute/column in the domain is not present. 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.


Mandatory
When set to Yes and the display datatype for a column is Poplist or Text List, the list of allowable values associated with the domain will be dynamic (i.e. based on a SELECT from the CG_REF_CODES table) rather than hard-coded in the client application.

When se t to No (the default) the Server Generator will generate check constraints to validate columns in the domain against the allowable values.

Note:	This property relates to server models and is also used during module generation.


Mandatory, 15 characters
Indicates the nature of the value specified in the Default Value property, i.e., whether it is a literal string, a database function call or a client function call.
Default: Literal


Optional, 240 characters
A description of how the value is obtained for derived attributes or columns (those that derive their values from a calculation involving other attributes or columns in the same table).


Optional
The SQL expression or PL/SQL function call that defines derived attributes or columns (multi-line text).


Extended Elements

An extended element definition is an instance of a user-defined element type.

Extended Element definition properties

Owning Container

UE

Usrxn

Version

Name

Comment

Related topics

Extended Structure Elements


A user-defined property for the element. The optionality and datatype of the property are also user-defined.


Mandatory, 100 characters
The name of the user-defined element.


Optional, 70 characters
A comment, brief description or long name for the user-defined element.


Extended Structure Elements

An extended structure element definition is an instance of a user-defined association type.

Extended Structure Element definition properties

Owning Container

Part Of Reference

Use Of Reference

Comment

Related topics

Extended Elements


Display only
The name of the first element type in this user-defined association.


The name of the second element in this user-defined association.


Optional, 70 characters
A brief comment about this user-defined association.


Files

A file definition records details of files that are stored in the repository and which can be downloaded to a file system.

File definition properties

Owning Container

Name

Version

Short Description

Owner

Size

Privileges

OS Timestamp

Kind

Documentation

Description


Mandatory, 256 characters
The name of the file.


Optional, 240 characters
A brief description of the file.


Optional, 32 characters
A note of the person who owns the file.


Optional, 10 digits
The size of the file in bytes.


Display only
Operating system privileges, expressed as a bit mask.


Display only
For a file that was uploaded from a file system, the date when the file was last modified in the file system.


Display only
An indication of how the file is stored in the repository:  BLOB (Binary Large Object), CLOB (Character Large Object), Compressed File, Compressed Binary File, Compressed Text File or Unpopulated (empty file).


Folders

A folder is a general-purpose container in which repository objects can be created.

Folder definition properties

Name

Version

Owner

Documentation

Description

Notes

OS Timestamp


Installations

An installation definition records the installation of a node at a given location.

You cannot create an installation definition directly. You create definitions for a location and a node, then create a reference from one to the other. The reference is the installation definition.

Installation definition properties

Owning Container

Location

Node

Version

Installation

Date Commissioned

Date Decommissioned

Installer's Name

Contact Phone Number

Documentation

Comment

Related topics

Locations


Display only
The name of the location where the node is installed.


Display only
The name of the node.


Optional, 70 characters
A comment or brief description about this installation.


Optional, 20 characters
The date on which the installation was commissioned.


Optional, 20 characters
The date on which the installation was decommissioned.


Optional, 30 characters
The name of the person who installed the node at the specified location.


Optional, 20 characters
The telephone number of the person to contact for installation details.


Locations

A location definition records information about the geographical location at which business functions are performed.

Location definition properties

Owning Container

Name

Version

Type

Parent Location

Contact

Contact

Telephone Number

Address

Address Line 1

Address Line 2

Code

Coordinates

Coordinate 1

Coordinate 2

Documentation

Comment

Description

Notes


Mandatory, 30 characters
The name by which the location is usually known.


Display only
The name of the parent location, if this location belongs to a hierarchy.


Optional, 70 characters
A comment or brief description of the location.


Mandatory, 20 characters
The type of location that is being defined (e.g., office, site, region).


Optional, 30 characters
The person or department to contact at this location.


Optional, 30 characters
The telephone number of the person or department to contact at the location.


Optional, 40 characters
The first line of the location address.


Optional, 40 characters
The second line of the location address.


Optional, 20 characters
A short code for the location (e.g., postal or zip code).


Optional, 10 characters
The first coordinate of the location.


Optional, 10 characters
The second coordinate of the location.


Named Preference Set Usages

A preference set usage indicates that a preference set (a specific set of generator preferences) is used by a particular element.

Named Preference Set Usage definition properties

Owning Container

Name

Version

Product Flavor

Related topics

Preference Sets


Non-Default User Preferences

A non-default user preference is a value that a user assigns to a generator preference where it is required to be different from its factory setting.

Non-Default User Preference definition properties

Owning Container

Element

Preference Name

Version

Value

Frozen?


Display only
The name of the element to which the preference applies.


Display only
The short name of the preference for which the non-default value has been defined.


Display only
The user-defined value for this preference.


Display only
Indicates whether this preference value is frozen.


Objectives

An objective records an aim or goal of an organization or, for example, a statement of business intent such as a mission statement.

Objective definition properties

Owning Container

Name

Version

Type

Parent Objective

Objective

Target Value

Set By

Unit Of Measure

Planning Horizon

Date Required

Ranking

Achievement Comment

Documentation

Comment

Description

Notes


Mandatory, 40 characters
The name by which the objective is usually known.


Display only
Parent, if this objective belongs to a hierarchy.


Optional, 70 characters
A comment or description of the objective.


Mandatory, 20 characters
The type of objective that is being defined. Some organizations use the terms 'aims', 'goals', 'targets' and so on.


Optional, 30 characters
The person, committee or event responsible for specifying the objective.


Optional, 16 characters
Any appropriate value that has been set as a target of the objective.


Optional, 20 characters
The unit of measure for the Target Value.


Optional, 30 characters
The timescale that was being considered when the objective was set (e.g., PERMANENT, STRATEGIC, TACTICAL, 5YEAR, 10YEAR).


Optional, 20 characters
The date by which the objective should be achieved. You can enter a specific date, such as 30-JUN-99, or a more general comment about the time, such as End of FY1999.


Optional, 4 characters
A relative priority or rating for the objective. You can use text or a numeric scale (e.g., LOW, AVE, HIGH or 1 to 100 where 1 is low and 100 is high).


Optional, 30 characters
The date on which the objective was achieved, or a statement of the progress that has been made.


Operating System Files
Operating System Files (Source & Record Files)

Operating system files are files that are used by an application, but which are not stored in the repository and therefore cannot be downloaded to a file system. There are two types of operating system files:

File Type	Description
Source files	A file containing source code
Record files	A file containing data records
The two different types display different sets of properties. Source files can display a Language property but no storage details, while record files can display storage details but no Language property.

Operating System File definition properties

*	displayed only for source files

**	displayed only for record files

Owning Container

Name

Version

Full Pathname

Language*

Type

Storage**

Organization**

Access Method**

Storage Medium**

Block Size**

Cluster Size**

Size

File Size

Unit

Documentation

Comment

Description

Notes

Related topics

Records


Mandatory, 100 characters
The name of the file.


Optional, 240 characters
The location and name of the file. This value must be unique across all record files and source files in the application system.


Optional
The language in which the code of the source file is written. Languages are defined in the System Folder.


Optional, 16 characters
The file type is usually one of those in the dropdown list: ASCII, Binary, Data, I/O or Text. However, you can enter another file type if desired.


Optional, 70 characters
Any notes or comments about the file.


Optional, 16 characters
The method in which records are organized within the record file. File organization is usually one of the those in the dropdown list:  INDEXED, RELATIVE or SEQUENTIAL. However, you can enter another method if desired.


Optional, 16 characters
The most commonly used method for accessing the records in the record file. You can choose a method from the dropdown list, or enter another method if desired. The list options are INDEXED, ISAM (Indexed Sequential Access Method), RANDOM, SEQUENTIAL or VSAM (Virtual Sequential Access Method).


Optional, 16 characters
The type of medium used for storing the file. You can choose a method from the dropdown list, or enter another method if desired. The list options are DISK, FLOPPY and TAPE.


Optional, 10 digits
The size of each block (e.g., number of bytes per block).


Optional, 10 digits
The size of each cluster (e.g., number of bytes per cluster).


Optional, 10 digits
The file size (e.g., number of bytes in a file). This property is used in conjunction with the Unit property.


Optional, 10 characters
The units for the size of the block, cluster, or file taken either from the listed values below, or from a value that is applicable to your own environment. The list options are BYTE (default), CHARACTER, KILOBYTE, MEGABYTE and RECORD.


Preference Sets

About preference sets

A preference set is a grouping together of generator preference values so that they can be easily applied to and reused by designs recorded in the repository.

When a preference set is created, it contains default values for each preference for a specified generator. When the preference set is used, only preferences whose values have been explicitly set are used. That is, all preferences within the preference set that use the default values are ignored during generation.

You can modify the preference values within preference sets only if they are owned by the current container. Frozen preference sets must be unfrozen before they can be modified.

To use a preference set's values during generation, the preference set must first be applied to the design recorded in the repository. To apply preference set values for generation, use the Preference Palette.

Preference set definition properties

Owning Container

Name

Version

Product Flavor


 Mandatory, 30 characters
A unique name for the preference set.


 Mandatory
Determines the preferences and their default factory settings that are used by the preference set.


Problems

A problem definition records a business event or state that inhibits the progress of the enterprise towards its objective (e.g., personnel disputes, market moves, procedural or statutory changes, unresolved issues or unmade decisions).

Problem definition properties

Owning Container

Name

Version

Type

Parent Problem

Identified By

Date Identified

Date Solved

Opportunities

Cause Category

Resolution Benefit

Documentation

Comment

Description

Notes


Mandatory, 40 characters
The name by which the problem is usually known.


Display only
The parent of this problem, if this problem belongs to a hierarchy.


Optional, 70 characters
A comment or brief description of the problem.


Mandatory, 20 characters
The type of problem being defined, such as the severity level of the problem (e.g., HIGH, MEDIUM, LOW).


Optional, 30 characters
The person, committee or event that identified the problem.


Optional, 20 characters
The date on which the problem was first identified.


Optional, 20 characters
The date on which the problem was solved.


Optional, 70 characters
Any opportunities that are triggered on identification of the problem.


Optional, 20 characters
The cause of the problem (e.g., INTERNAL, EXTERNAL).


Optional, 70 characters
A description of the benefits that result from the resolution of the problem.


Transformation Mapping Sets - Definition
Transformation Mapping Sets

About mapping sets

A transformation mapping set represents the overall 'collective' mapping for transformation from one level to another, for example, from the type model to the server model. It is made up of the individual mappings of pairs of specified elements.

Transformation Mapping Set definition properties

Owning Container

Transformation Type

Version

Comment

Documentation

Description


Mandatory
The type of transformation mappings that this set contains.


Optional, 240 characters
A comment about the mapping.


Mapping Elements - Definition
Transformation Mapping Elements

About mapping elements

A mapping element represents an individual mapping of a specified source element to a specified target element within a mapped set. An example of a mapping element is the mapping of the entity object type 'Employee' to the table EMPLOYEES at the physical design (i.e. server) level.

Mapping Element definition properties

Owning Container

Transformation Mapping Set

Source

Source Element

Version

Source Element Type

Target

Target Element

Target Element Type

Created by Transformer?


Display only
The transformation mapping set to which the mapping element belongs.


The source element involved in the mapping.


The type of source element in the mapping.


The target element involved in the mapping.


The type of target element in the mapping.


Indicates whether the mapping was created by the transformer (Yes) or created by hand by the user (No).

Default: No


Set Member Items

About set member items

A set member item is a generic name for a repository element that is included in a user-defined set.

A user-defined set is a subset of container elements. You can define such a set of elements before migrating them to a different repository. A user-defined set cannot include diagrams or other user-defined sets.

Set Member Item definition properties

Owning Container

Set

Element in Set

Version

Related topics

User-Defined Sets


Display only
The name of the set.


Display only
The name of this element in the set.


User Defined Sets

A user-defined set is a set, defined by the user, in which elements of any type can be placed. User-defined sets can be overlapping, i.e. an element can be placed in more than one set. A repository element that forms part of a user-defined set is called a set member item.

User Defined Set definition properties

Owning Container

Name

Version

Documentation

Description

Notes

Related topics

Set Member Items


Mandatory, 30 characters
The name of the set.


Workareas

A workarea makes a set of repository objects and object versions visible to a particular user.

Workarea definition properties

Owner

Name

No. of Times Refreshed

Refreshed ?

Description

Default Checkin Branch

Related topics

About workareas


Mandatory, 256 characters
The name of the user who owns the workarea.


Mandatory, 256 characters
The name of the workarea.


Display only
The number of times that the workarea has been refreshed.


Display only
Indicates whether the workarea has ever been refreshed.


Optional, 2000 characters
A description or note about this workarea.


Display only
Indicates the default checkin branch, if one has been specified, for objects in this workarea.


Audit properties

The five audit properties display creation and modification details about a repository element.

Date Changed

Date Created

Created By

Changed By

Number Of Times Modified


Display only
The date on which the selected element was created.


Display only
The date on which the most recent set of modifications were made to this element.


Display only
The repository user by whom this element was created.


Display only
The repository user by whom the most recent set of modifications were made to this element.


Display only
The number of times the element has been modified since its creation.


FOLLOWING ARE THE COMMON PROPERTIES:

Owning Container

Name

Version

Owner

OS Timestamp

Text:

- Description

- Notes


Display only
The name of the container that owns this element.


Mandatory, 256 characters
The name of this container.


Display only
The version label of this object or container, if it is under version control. The letters CO indicate that the object or container is currently checked out.


Mandatory, 30 characters
The Oracle user name of the repository user who created the container, or to whom ownership has been transferred.


Display only
For a container that was uploaded from a file system directory, the date when the directory was last modified in the file system.


Optional
A multi-line text description of the element.


Optional
Multi-line text notes about the element.


FOLLOWING IS THE GENERAL TOPIC FOR A PROPERTY GROUP NAME IN THE PROPS PALETTE (CONTEXT ID 131179)


The Property Palette

The Property Palette enables you to view and edit the properties of objects in the Navigator. There can be any number of Property Palettes open simultaneously.

Note:	Changes in the Property Palette are not immediately stored in the repository. Such changes are saved when you close the Property Palette, select another object or choose the Save button or menu option.

When you select an element in the Navigator, the Property Palette displays the property values for that object.

The Property Palette consists of a toolbar, and a list of property types and their values. When you select a property value in this table, you can edit the property value directly.

Icons on the Property Palette

   Invokes the TextPad for a multi-line text property.

   Expands the group of related properties.

   Collapses the selected group of related properties. Only the group label will be shown.


FOLLOWING IS THE GENERAL TOPIC FOR LOCKED PRIMARY ELEMENTS FLAG


A system maintained property that indicates whether this element is locked by virtue of belonging to a set that has been locked or checked out.

Default: No


Contents

* # $ K Arguments

* # $ K Base Table Locations

* # $ K Check constraints

* # $ K Cluster Columns

* # $ K Cluster Implementations

* # $ K Clusters

* # $ K Columns / Oracle object type attributes

* # $ K Communities

* # $ K Community Databases

* # $ K Community Members

* # $ K Database Object Grants

* # $ K Database Profiles

* # $ K Database synonyms

* # $ K Database Triggers

* # Uses of Triggers

* # Components of a Trigger

* # Types of Trigger

* # $ K Database User Roles

* # $ K Database Users

* # $ K Datastructure Items

* # $ K Datastructures

* # $ K Directories

* # $ K Foreign keys

* # $ K Global Index Partitions

* # $ K Index Entries

* # $ K Index Storages

* # $ K Indexes

* # $ K Java definitions

* # $ K Java definition implementations

* # $ K Key Components

* # $ K LOB Storage

* # $ K Local Index Partition

* # $ K Materialized Views

* # $ K Materialized view Implementations

* # $ K Non-Persistent Queues

* # $ K Non Persistent Queue Implementations

* # $ K Other Databases

* # $ K Oracle Collection Types

* # $ K Oracle Databases

* # $ K Oracle Object Types

* # $ K Partition Key Entries

* # $ K Persistent Queues

* # $ K Persistent Queue Implementations

* # $ K PL/SQL Definitions

* # $ K PL/SQL Functions

* # $ K PL/SQL Procedures

* # $ K PL/SQL Packages

* # $ K Trigger Logic

* # $ K Cursors

* # $ Type Body - PL/SQL Definition Type

* # $ K PL/SQL definition implementations

* # $ K Primary Keys

* # $ K Program Data

* # $ K Queues

* # $ K Queue Implementations

* # $ K Queue Subscribers

* # $ K Queue Table Definitions

* # $ K Queue Table Implementations

* # $ K Records

* # $ K Relations - Based On

* # $ K Role Grants

* # $ K Roles

* # $ K Rollback Segments

* # $ K Sequence Implementations

* # $ K Sequences

* # $ K Storage Definitions

* # $ K System Privileges

* # $ K Tables

* # $ K Table Implementations

* # $ K Table Partitions

* # $ K Tablespace Quotas

* # $ K Tablespaces

* # $ K Trigger Column Usages

* # $ K Unique Keys

* # $ K Views

* # $ K View Implementations

* # $ K Constraints

* # Databases

* # Database Object Implementations

* # $ K Index Partitions

* # Java definitions / PL/SQL definitions / Modules

Join constraints -

* # Relation Definitions


Arguments

About arguments

Arguments are the parameters that are stored against a specific module or PL/SQL definition. These parameters control which data is used when the module is run. Examples include the input parameters to reports or utilities, and data parameters passing between modules.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Argument definition properties

Owning Container

Module / PL/SQL Definition

Name

Version

Input Output

Position

Defined By

Domain

Datastructure

Column

Table Definition

Oracle Type

Definition

Datatype

Length

Decimal Places

Default

Default Value Type

Optional ?

Display

Display

Prompt

Dynamic List ?

Suggestion list ?

Input Mask

Menu Generation

Substitution String

Documentation

Comment

Description

Notes


Optional
Identifies the column definition that defines the argument. The datatype of an argument that is defined using this property is declared using the %TYPE attribute.

For information about the %TYPE attribute, see the PL/SQL User's Guide and Reference Manual.


Display only
The name of the repository definition for which the argument or parameter is defined.


Display only
The name of the PL/SQL definition for which the argument or parameter is defined.


Mandatory, 30 characters
A unique name for the argument or parameter.

Note: Some of the generator products impose a limit on the number of characters that should be used for the names of arguments.


Optional, 6 digits
The sequence number of this argument within the definition.


Optional
Identifies the datatype of the argument, or its declaration. If a domain has been specified for the argument, then this value is overridden by the value defined by the domain.


The domain name for this argument. If a domain is specified, then the property values for datatype, default value, length and decimal place are defined by the domain and cannot be overridden in the argument definition.


Identifies the datastructure that defines the argument. This list displays only those datastructures defined for the current module or those defined for PL/SQL definitions of type PACKAGE visible to the workarea.


 Identifies the object type, VARRAY or nested table that defines the argument.


Indicates whether the argument is to be displayed. This property allows the argument to be explicitly hidden from the user. Hidden arguments may have their value supplied via a passed value.
Default: Yes


Optional
Identifies the table definition that defines the argument. If this property is set, the argument represents a row in a table. The record type of the row is declared using the %ROWTYPE attribute.

For information about the %ROWTYPE attribute, see the PL/SQL User's Guide and Reference Manual.


Optional, 60 characters
The default value for the argument.

To specify whether this is a literal string or a database function call, set the Default Value Type property.


Optional, 6 digits
The maximum number of characters in the value of the argument.


 Indicates the nature of the value specified in the Default Value property, i.e., whether it is a literal string, a database function call or a client function call.
Default: Literal


Optional, 3 digits
The maximum number of decimal places that an argument can have.


Optional, 20 characters
The format mask or modifier to be used for this input argument. For example, to mask a date parameter to display the year only.


Indicates whether null is a valid value for the argument.
Default: No


Optional, 130 characters
Text to be used as a prompt for this argument.


Optional, 40 characters
The name of a parameter to pass a value for this argument to the current module when the module is called. When setting the module's Command Line property, include the substitution string between angle brackets.


Optional
Identifies how the parameter is to be used. The options are:

<Null>	Unspecified
Input	Parameter is passed to but not from this module.
Modify	Parameter is passed to and from this module (i.e., it is changed by the module).
Modify Nocopy	As Modify but with the NOCOPY compiler optimization hint appended, allowing parameters to be passed by reference. This option is useful for parameters holding large datastructures.
Output	Parameter is passed from but not to this module.
Output Nocopy	As Output but with the NOCOPY compiler optimization hint appended, allowing parameters to be passed by reference. This option is useful for parameters holding large datastructures.


Optional, 100 characters
A comment about the argument.


When set to Yes, the generated list of values is dynamic, i.e. based on a SELECT from the Reference Codes table rather than on hard coded values.
Default: No


Indicates whether the domain of the argument is a suggestion list only, i.e. not enforced.
Default: No


Base Table Locations

About base table locations

A base table location is a repository definition that identifies the schema in which the underlying objects of a view or materialized view is to be implemented. The underlying objects may be tables, views or materialized views. It is only necessary to create a base table location if the underlying table, view or materialized view is implemented in a different schema. This is because the Server Generator must be told which underlying objects it is to use when creating a view or materialized view on a database.

For example, if view B is based on table A, then you can use a base table location if the latter is to be implemented for a different user.

By default views and materialized views are implemented in the same schema as the element, on which they are based. Where this is the case, base table locations are not required.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Base table location definition properties

Owning Container

Database

Database User

View

Materialized view

Table/View/Materialized view

Version

Alias

Database User


Mandatory
Identifies the database user for which a materialized view or view is to be implemented.


Display only
The name of the element on which the view or materialized view is based.


Display only
The alias that identifies the element on which the view or materialized view is based.


Display only
The name of the materialized view that is to be implemented for the specified database user.


Display only
The name of the view that is to be implemented for the specified database user.


Check constraints

What do you need help with?

About check constraints

Check constraint definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About check constraints

A check constraint provides a mechanism for checking that, for each row in a table, a condition evaluates to true or is unknown. Check constraints can be used to check that only a specified range of values is entered in a specific column or set of columns.

Note:	For this release, check constraints cannot be recorded in the repository for object views.

You can explicitly define check constraints to check the values of a specified column or a set of columns on a table. Multiple check constraints can be defined that reference a single column.

If you have defined allowable values for a column, check constraints are generated implicitly by the Server Generator to validate the allowable values.

Given the table CUSTOMER, you might define a check constraint to check that all values entered for the CUSTOMER_NUMBER column are in the range 10000 to 50000.

   CONSTRAINT customer_number
     CHECK (customer_number BETWEEN 10000 AND 50000);

Check constraints can also be used to evaluate the values entered for columns in an arc.

For example, the MEMBERSHIPS table stores information about company membership and about customer membership, using two mutually exclusive columns, CO_COMPANY_IDENTIFIER and CU_CUSTOMER_NUMBER respectively.

For example, given the table MEMBERSHIPS, suppose that club membership can be held either by a company or by an individual customer. The relationship is defined using an arc. This defines the columns CO_COMPANY_IDENTIFIER and CU_CUSTOMER_NUMBER as mutually exclusive.

In this scenario, you might define a check constraint to check that, for each row in the table, a value is entered either for CO_COMPANY_IDENTIFIER or for CU_CUSTOMER_NUMBER. The condition used to define the check constraint would be:

   CONSTRAINT membership_check
     CHECK (((co_company_identifier IS NULL) AND
     (cu_customer_number IS NOT NULL)) OR
     ((cu_customer_number IS NULL) AND
     ((co_company_identifier IS NOT NULL)))

The rows in the MEMBERSHIPS table are valid, since for each row, a value is specified either for the company number or the customer number, or else the value is null.

Limitations

Check constraints are used to evaluate a condition relating to the columns on a single table. You cannot use check constraints to reference other columns on different tables.

The condition specified in a check constraint must be a Boolean expression. Subqueries, sequences, the SYSDATE, UID, USER, USERENV functions, and the LEVEL or ROWNUM functions are not allowed.

When a check constraint definition has been entered into the repository, it can then be implemented on the database using the Server Generator.

--------------------------------------------------------------------------------------------------

Check constraint definition properties

Owning Container

Table

Name

Version

Complete ?

Enable ?

Validation

Validate In

Defer Status

Error Message

Exceptions Table

Enforce When Null ?

Where/Validation Condition

Where/Validation Type

Documentation

Comment

Description

Notes

Related Topics

Foreign Key Constraints

Key Components

Primary Key Constraints

Materialized views

Tables

Unique Key Constraints

Views


 Optional
Indicates whether the Where/Validation Condition property defines a Function Call or a SQL Expression.


Indicates whether the check constraint is to be validated by a generated application even if some of the column values are null.

Default: Yes


Optional, 70 characters
A comment about the purpose of this constraint.


Mandatory
The level at which the check constraint is to be implemented. The options are:

Client	The check constraint will be implemented at application level only.
Server	The check constraint will be implemented in the database only.
Both	The check constraint will be implemented at application and database level.

Default: Both


Optional
A multi-line SQL check constraint for the table.

For example, suppose that the columns co_company_identifier and cu_customer_number on a given table are mutually exclusive, and are included in an arc. You might define a check constraint to ensure that:

•	a value is specified for cu_customer_number and the value for co_company_identifier is null

•	a value is specified for co_company_identifier and the value for cu_customer_number is null.

The check condition would therefore be something like this:

CHECK	(((co_company_identifier IS NULL) AND
	(cu_customer_number IS NOT NULL)) OR
	((cu_customer_number IS NULL) AND
	((co_company_identifier IS NOT NULL)))
Note:  The keyword CHECK should be omitted, because it is automatically generated by the Server Generator.


Cluster Columns

About cluster columns

Cluster columns are used by a cluster to form a 'cluster' key. The cluster key determines how the rows of a cluster are grouped. Rows with the same cluster key are stored close together on the database.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Cluster column definition properties

Owning Container

Cluster

Name

Version

Usage Sequence

Format

Datatype

Length

Decimal Places

Documentation

Description

Notes

Related Topics

Clusters

Columns


Display only
The name of the cluster to which this cluster column belongs.


Mandatory, 30 characters
A unique name for a column to be included in the cluster key.

The names of the cluster key columns can be different from the names of the columns in the clustered tables.


Mandatory, 3 digits
A unique number that defines the order of the columns in the cluster key.


Display only
A standard Oracle database datatype for the column, for example, DATE, NUMBER and TIME.


Display only
The total number of digits that may be used to the right of the decimal point in a numeric column.


Display only
The total number of digits that can be specified in a numeric column. Numbers ranging from 1e129 to 9.99 x 1e124 can be stored.


Cluster Implementations

About cluster implementations

A cluster implementation is a repository definition that records the information that is required by the Server Generator to implement a specific cluster definition on a database. For example, a cluster implementation definition records details such as the initial number of concurrent update transactions that are allocated for blocks belonging to the cluster. If cluster implementation details are not specifically recorded in the repository, that is, a cluster implementation definition is not created, Server Generator uses the default implementation settings to create the cluster on a database.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Cluster Implementation definition properties

Owning Container

Database

Database User

Cluster

Version

Complete ?

Storage

Tablespace

Storage Definition

Initial Transactions

Maximum Transactions

Percent Free

Percent Used

Cached

Parallel

Parallel

Degree

Instances

Documentation

Non-Oracle Storage

Implementation Description

Implementation Notes

Related Topics

Clusters


Display only
The name of the cluster for which the implementation details are being specified.


Optional, 3 digits
Specifies a set amount of room in every block that is allocated to the cluster for future updates. The value entered in this field, when added to the value for the Percent Used property, must not exceed 100.


Optional, 3 digits
The minimum level of space usage that an Oracle database maintains for each block of the cluster. If the space used is less than the percentage used, the block becomes a candidate for row insertion. The block ceases to be a candidate for row insertion when free space falls below the percentage free.

The value entered in this field, when added to the value entered in the percentage free field, must not exceed 100.


Optional, 3 digits
The initial number of concurrent update transactions allocated for blocks belonging to the cluster. The range of values is:

Minimum	1
Maximum	255


Optional, 3 digits
The maximum number of concurrent update transactions for any given block belonging to the cluster. The range of values is:

Minimum	1
Maximum	255


Optional,
Specifies whether the blocks retrieved for this cluster are placed at the most recently used end of the Last Recently Used (LRU) list. When set to Not Cached, retrieved blocks are placed at the least recently used end of the LRU. Placing the data at the most recently used end of the LRU, rather than the least recently used end can improve performance. It useful to set this property to Cached for small lookup tables.

The options are:

<Null>
Cached
Not Cached


Indicates if parallel querying is to be used.

Default: No - Serial execution of an operation will be performed, rather than parallel.


Optional, 6 digits
The degree of parallelism. If this property is unspecified, the Server Generator will create a cluster with default degree of parallelism.


Optional, 6 digits
Defines how a table is split among the available instances of a Parallel Server for parallel query processing. An integer signifies that this cluster is to be split among the specified number of available instances.


The name of a set of storage parameters used to define future space allocation for the cluster in the  database.


The name of the tablespace in which the cluster will be created. If no tablespace is specified, the cluster will be created in the user's default tablespace.


Optional
Any additional storage parameters for databases other than Oracle.


Clusters

What do you need help with?

About clusters

Cluster definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About clusters

There are two types of cluster, index clusters and hash clusters. Both types of cluster provide a way of grouping common columns in one or more tables so that the columns are physically stored in the same data block on a database. This can improve performance when tables are frequently joined on a common set of columns. For example, if you always process employees by department number, it would be beneficial to cluster the Employee table by the Department Number column.

Hash clusters allow you to specify an algorithm for clustering a group of columns. Typically, a hash cluster is used when tables are queried using equality queries, e.g. return all rows for department 30.

Clusters can be created in the context of a Server Model Diagram and are represented by a green rectangle.

Cluster definition properties

Owning Container

Name

Version

Type

Size

Hash Cluster

Hashkeys

Hash Is

Documentation

Comment

Description

Notes

Related Topics

Cluster Columns

Cluster Implementations

Columns

Materialized views

Tables


Mandatory, 30 characters
A unique name  for the cluster.


Mandatory
Indicates whether the cluster is an index cluster or a hash cluster.

Default: Index cluster


Mandatory, 10 digits
The number of hash values for a hash cluster. Note that this number is rounded up to the nearest prime number to give the number of hash values. The minimum number for this property is 2.

Note: This property is relevant for hash clusters only.


Optional, 100 characters

The expression for the hash function of the hash cluster. If you do not enter an expression, then an internal hash function is used.

The hash function must evaluate to a positive value and must reference at least one column of datatype INTEGER or datatype NUMBER.

Note: This property is relevant for hash clusters only.


Optional, 2000 characters
A comment about this cluster.


Optional, 38 digits
The average amount of space in bytes required to store rows with the same cluster key value.


Columns / Oracle object type attributes

What do you need help with?

About columns

About Oracle object type attributes

Column / Oracle object type attribute definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

Column / Oracle object type attribute icons

The following icons are displayed next to columns and Oracle object type attributes to identify their datatypes.

About columns

A column provides a means of implementing an item of data in a table, view or a materialized view. Each column must have a name, a datatype and a maximum length. By default all columns are optional.

Optional Columns

By default, all columns allow the absence of a value, that is, a null. A column that allows null values is defined as optional. On a Server Model Diagram, optional columns are prefixed with (o). For example:

Mandatory Columns

To prevent null values from being entered in the rows of a column, you can define the column as mandatory. Mandatory columns enforce not-null constraints, and provide a mechanism for ensuring that a value is entered in a specified column or set of columns. For example, primary key columns are always mandatory.

On a Server Model Diagram, mandatory columns are prefixed with an asterisk (*). For example:

Given the table EMP, you might define a not-null constraint on the column EMPNO, to ensure that, for each new employee employed in the department, an employee number must be entered. You would therefore define the EMPNO column as mandatory.

Conversely, you might define the COMM column as optional, since not every employee might be entitled to commission, and nulls would therefore be allowed.

When the column definition has been entered into the repository, the column can then be created on the database using the Server Generator.

About Oracle object type attributes

An Oracle object type attribute (also referred to as type attributes) provides a means of implementing an item of data for an Oracle object type.

Defining the attributes of an Oracle object type is similar to defining columns for a relational table. Each Oracle object type attribute can be based on a built-in type, e.g. DATE, or another Oracle object type

--------------------------------------------------------------------------------------------------

Column / Oracle object type attribute definition properties

Owning Container

Table

Oracle Object Type

Name

Version

Sequence in Table

Complete ?

Domain

Def Template/Library Object

Scalar (Note: A scalar column stores a single value, e.g. a date. When defining a column, you can set Scalar properties or Object/collection properties)

Datatype

Average Length

Maximum Length

Decimal Places

Object (Note: An object/collection column is based on an Oracle object type or collection type)

Oracle Type

Object Type Inclusion

Scope Table

Store REF with ROWID ?

Definition

Optional ?

Uppercase ?

Default Value

Default Value Type

Sequence

Cluster Column

Volumes

Initial Volume

Final Volume

Default Display

Display ?

Display Datatype

Alignment

Display Length

Display Height

Display Sequence

Descriptor Sequence

Format Mask

Formatting

Prompt

Default Ordering

Order  By Sequence

Sort Order

Select Column (For relational views and materialized views only)

Base Column

Base Relation

Select Text

Denormalization

From Column

Via Foreign Key

Using Operator

Derivation

AutoGen Type

Server Defaulted ?

Server Derived ?

Derivation Expression

Derivation Expression Type

Source

Source Attribute

Validation

Suggestion List ?

Dynamic List ?

Where/Validation Condition

Where/Validation Type

Validation Error Message

Help

Hint

User Help Text

Documentation

Comment

Description

Notes

Related Topics

Key Components

Materialized views

Tables

Views


Display only
The name of the table, view or materialized view for which the column is to be defined.


Mandatory, 30 characters
A unique name for the column/attribute.


Optional
The name of the cluster column that implements this column as part of a cluster key.


Optional, 6 digits
A unique number used to determine the order in which the column is created on the table. Columns are created in alphabetical order if you do not specify an order.


Indicates whether the definition of the column is complete, and ready to be implemented on a database using the Server Generator. When this property is set to No, the column will be ignored by the Server Generator.

Default: Yes


Optional
The name of an existing domain to which this column/attribute belongs.  If the column has been generated (using the Database Design Transformer) from an attribute in a domain, this field displays the name of that domain.

When you associate a column with a domain, the column datatype and length fields are inherited from the domain definition. [ Note: If you change the column datatype, maximum length or valid values when it is associated with a domain, the column properties will override those defined at the domain-level.]


Optional
The type of data that can be entered into this column/attribute. A value is required for scalar columns only.  For example, DATE, NUMBER and TIME.

Tip:	Use the index to access additional information about datatypes.


Optional, 5 digits
The estimated average length of data that can be stored in this column. The average length must be less than the maximum length.

The average length is used when running Repository Reports to estimate the amount of space required to store tables in the database.


Mandatory or optional (depending on the datatype)
The maximum length of data that can be stored in this column/attribute. Note, this property is not mandatory for all datatypes, e.g., DATE, LONG, SOUND, CLOB.

In the case of character datatypes, this property is the length in bytes of the column. For single byte character sets, this corresponds to the length in characters.

In the case of numeric datatypes, this property specifies the number of digits in the number (not including the decimal point if it exists).

Values can be in the range of 1 to 65535.


Optional, 4 digits
The number of decimal places allowed for the column/attribute. This is only applicable to columns of type NUMBER and DECIMAL.


Indicates whether or not this column/attribute can contain null values.

If the column/attribute is optional it can contain NULL values. If the column/attribute is mandatory it cannot contain NULL values.


Optional
If the column (or attribute) is defined as part of an object datatype, then this property further qualifies whether that object is referenced or embedded.

Note:	This property is not applicable for collection columns.


 Display only
Identifies the Oracle object type for which the column/attribute is defined.


Optional
Identifies the Oracle object type, VARRAY or nested table that defines the structure of the data represented by this column/attribute.


Indicates whether values are stored in the table as uppercase. If values are to be stored in uppercase, they are converted from mixed case or lowercase before being inserted into the table.

The conversion takes place either:

•	client-side, via generated application code, i.e.  Forms, PL/SQL Web and Visual Basic applications.

•	server-side, via generated Table API code, i.e. Forms and PL/SQL Web applications only.

Note:  The width of a field in a generated application that displays values from this column might have to be greater when values are stored as uppercase.

Default: Values are not converted to uppercase. Mixed case values can be entered for the column.


Optional, 60 characters
A default value for the column/attribute that is supplied by the application generator products as a substitute for an omitted value for the column during an INSERT operation. Default column values work as though an INSERT statement actually specifies the default value.

Valid values can include any literal or expression that does not refer to a column, LEVEL, ROWNUM or PRIOR. The functions SYSDATE, USER, USERENV and UID are accepted.

Default values that consist entirely of blank spaces, or character strings that are to be displayed in quotation marks, should be entered in single quotes. Otherwise, quotation marks are not required.

Note: To specify whether the value entered is a literal string, a database function call, or a client function call set the Default Value Type property.


Indicates the nature of the default value.

Valid values: Literal, Database Function Call, Client Function Call


Optional
The name of a sequence used to create unique values for this column when a row is inserted in the database table. Sequence values may be sourced from a code controls table or an Oracle database sequence.

You can associate a column with a sequence if the column datatype is numeric and the target database is Oracle. The sequence must already be defined.


Optional, 30 characters
The name of an object in a template or object library.

Form Generator can use source objects in an object library to set properties of generated objects.


Indicates whether a default value should be supplied by application logic residing on the database server if no value is supplied by a client side application.

This tells the Generator it should requery the row after insert/update to display server derived data

Default: No


Optional, 3 digits
The percentage of rows that will have a value in this column when the table is in use. This value must be 100 if the column is mandatory (not null).

Valid values are in the range 0 to 100.


Optional, 3 digits
The percentage of rows that will have a value in this column when the table is initially created. This value must be 100 if the column is mandatory (not null).

Valid values are in the range 0 to 100.


Optional, 20 characters
The default display datatype to be used for the column in a generated application. Where applicable, the value will be defaulted to the datatype of the attribute from which the column is derived.

This display datatype can be modified when module usages are defined for the column.


Indicates whether any items based on the column will normally be displayed in the generated application.
Note: Surrogate primary key columns generated by the Database Design Transformer are not displayed by default.

Default: Yes


Optional
The default justification used if the column is displayed on a generated screen or report. The options are:

<Null>
Centered
Left
Right

The justification can be modified when module usages are defined for the column.


Optional, 5 digits
The default length for any items based on this column when displayed in a generated application. Where applicable the value is defaulted to the maximum length of the attribute from which the column is derived.

Valid values are in the range 0 to 65535.

If you use a format mask, you should increase the display length by 1 character greater than the length of the format, to enable the whole field to be displayed.

This value can be modified when module usages are defined for the column.


Optional, 6 digits
The default height for any items based on this column in a generated application.

This value can be modified when module usages are defined for the column.


Optional, 6 digits
A default number for ordering the column within a generated application. This property defaults to the column sequence generated by the Database Design Transformer.


Optional, 60 characters
A mask or display modifier that can be used to determine how an item is displayed in a generated application. For example, to mask a date in order to display the year only.


Optional, 70 characters
Specifies the type of highlighting used when the column is displayed on a report; for example, the column can be displayed in BOLD, REVERSE.


Optional, 132 characters
The default prompt for any items based on this column when displayed on a generated application.

This value can be modified when module usages are defined for the column.

Note:	This property value can be populated by the Database Design Transformer.


Optional, 132 characters
The default user hint text for any items based on this column that are displayed in generated applications. For example, in a form, this field is used to provide hint text that is displayed on the message line of the generated form.

This value can be modified when module usages are defined for the column.


The name of the column in the base table on which this view column or materialized view column is based.


The name of the underlying relational table, relational view or materialized view in which the Base Column is defined.


Optional
Identifies the table from which the REF values for the column/attribute are obtained.


Optional
A SQL SELECT statement that specifies the columns used in the view or materialized view.


Optional, 3 digits
A unique number to determine the order of this column in an ORDER BY clause. The order sequence guarantees that the rows returned by a query on the table always appear in the same order.

A value for this property is automatically generated, if the column has been generated by the Database Design Transformer and the column is derived directly from an entity attribute. A value is not generated by the transformer for surrogate primary key columns, foreign key columns or discriminator columns.


Optional
The normal sorting of the column in an ORDER BY clause. The options are:

Ascending	[The default.] The rows returned by the SELECT statement are returned in ascending order.
Descending	The rows are returned in descending order.


Optional, 2 digits
A number indicating that the column is to be used in a generated application as a descriptor column, instead of the primary key. More than one column can be used as a descriptor. The numeric sequence specified for composite descriptors determines the order in which they appear in the generated application. For example, users might commonly retrieve rows from an Employees table using a combination of descriptor columns, such as SURNAME, FIRST_NAME, as a substitute for the primary key EMPLOYEE_NUMBER. Descriptor columns form the basis of lookup table usages. Generators can use this information to decode the numeric identifier into the descriptive form.


Specifies whether the column value should be automatically generated in a client application, and the type of value to be generated. This option is used by the Generator products to maintain change history information for auditing purposes. Values for this column are set automatically in the client. Any items in the generated application that are based on columns whose AutoGen Type is not null are made non-enterable.

If the table has been generated using the Database Design Transformer, defaults for this option are automatically set. The available options are:

Option	Description
<null>	Values for this column are not automatically generated. The Database Design Transformer generally sets the AutoGen Type to null.
Created by	Sets the column value to the name of the user who created the row.
Date Created	Sets the column value to the date that the row was created.
Date Modified	Sets the column value to the date that the row was last modified.
Modified by	Sets the column value to the name of the user who last modified the row.
Seq in Parent	Sets the column value to the next unique number within the referenced primary key, when a new record is created. The Database Design Transformer sets the AutoGen Type to Seq in Parent if the column has been generated from an attribute whose format is NUMBER and that is also part of a unique identifier made up of attributes and relationships.


Optional, 2000 characters
A comment about this column/attribute.


Optional
The name of the column that contains the data from which the values in this column are derived.


Optional
The name of the foreign key that joins this table to the table from which this column is denormalized.


Optional, 19 characters
Where the data in this denormalized column is an aggregation of data in a number of rows, an aggregation operator is needed.


Indicates whether the column's value is derived on the database server, via a database trigger, and therefore should not be set or provided client side. If set to Yes, generated applications that use this column should requery the row after insert/update to display server derived value.

Default: No


Optional
The name of the entity attribute on which this column is based. If the column definition was generated by the Database Design Transformer, this defaults to the name of the entity attribute from which the column was generated.


Indicates whether a list of allowable values (defined either against the column or against an associated domain) is used at runtime as a suggestion list, rather than a list that strictly enforces the column's value. [You can enter values other than those in the list.] This setting is primarily required if you are going to implement an item with a  combo-box.

Yes	indicates that the list (domain) is used as a suggestion list.
No (Default)	indicates that the list values are enforced.


Indicates whether, at runtime, the value of a column is validated against a soft-coded database table, rather than being checked against a list of values that has been hardcoded in the generated code. This property is applicable when the column has valid values defined directly against it (using the Value and High Value properties), as opposed to being in a domain.[ only the predefined list of values can be entered in the column]

Yes	The value of a column is validated against a soft-coded database table. This means that the list of allowed values is to be loaded into a reference code table (CG_REF_CODES).
No (Default)	The values are hardcoded in the generated application and are validated from there. The Server Generator will generate check constraints to validate columns against the allowable values.


Optional
The SELECT statement that specifies the derivation of the column's value, where it is a product of other columns in the same row. The derived value is stored on the database and can be accessed by generated applications, such as forms. The keyword SELECT should be omitted, because it is automatically generated by the Server Generator.


Identifies the type of derivation expression that is used to specify the value of the column.
Valid values: <Null>, Function Call, SQL Expression


Optional
The validation condition that validates data entered against the column, failure of which causes the validation failure message to be raised. This property is specifically for item level validation, rather than block level validation, on generated Oracle Forms applications. The validation code is generated as part of the form that contains an item based on this column. Validation takes place in the generated application not on the server.

Note, to perform validation of column values on the server, define domains or valid values. Alternatively, define check constraints against the appropriate tables, views or materialized views.


 Optional
Indicates whether the Where/Validation Condition property defines a Function Call or a SQL Expression .


Optional
The error message to be used if the validation message fails.


Optional
Default help information to be displayed by generated applications, such as forms and Visual Basic applications, that reference this column. The help information that is displayed by the generated application can be modified when module usages are defined for the column.


Optional, 2 characters
Level of field e.g., as in COBOL - 88,01,02. This property is for documentation purposes only, and is not used by the generator products.


Indicates that the field is signed, when the datatype is not character. This property is for documentation purposes only, and is not used by the generator products.


Optional, 120 characters
Initial value of data item. Used as VALUE IS clause in COBOL. This property is for documentation purposes only, and is not used by the generator products.


Optional, 15 characters
Value to be stored if field is null e.g. SPACES, ZEROS. This property is for documentation purposes only, and is not used by the generator products.


Optional, 15 characters
The storage format for the field e.g. BIT,DISPLAY,COMP,COMP-1,COMP-2,COMP-3. This property is for documentation purposes only, and is not used by the generator products.


Identifies whether the ROWID is to be stored with the column/attribute REF value. Storing the REF and ROWID together can improve performance of dereferencing, but will use more space.

Default: No


Optional, 30 characters
The name of the field this field redefines. This property is for documentation purposes only, and is not used by the generator products.


Optional, 30 characters
Occurs text for the fields. This property is for documentation purposes only, and is not used by the generator products.


Communities

About communities

Defines Transparent Network Substrate (TNS) communities. A TNS community is a group of Servers that can run TNS-based products (e.g., SQL*Net Version 2) and can communicate using one common network protocol. This repository object definition is recorded for documentation purposes only, that is, none of its properties are used by the Generator products.

Use the Repository Object Navigator to create community definitions.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Community definition properties

Owning Container

Community Name

Version

Protocol

Documentation

Comment

Description

Notes

Related Topics

Community Databases


Mandatory, 30 characters
A unique Transparent Network Substrate (TNS) community name. This property is for documentation purposes only, and is not used by the generator products.


Mandatory, 40 characters
The protocol for this community (e.g., TCP/IP, DECNET, SPX/IPX). This property is for documentation purposes only, and is not used by the generator products.


Mandatory, 240 characters
A comment, or brief description, about this Transparent Network Substrate (TNS) community. This property is for documentation purposes only, and is not used by the generator products.


Community Databases

About community databases

Defines an association between a Transparent Network Substrate (TNS) community and a database. This repository object definition is recorded for documentation purposes only, that is, none of its properties are used by the Generator products.

Use the Repository Object Navigator to create community database definitions.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Community database definition properties

Owning Container

Community

Database

Version

Related Topics

Communities

Oracle Databases

Non Oracle Databases


Display only
The name of the member of the Transparent Network Substrate (TNS) community. This property is for documentation purposes only, and is not used by the generator products.


Display only
The name of the database that is to be a member of the Transparent Network Substrate (TNS) community.

Any database defined in more than one community can be considered as an interchange. This property is for documentation purposes only, and is not used by the generator products.


Community Members

About community members

Defines an association between a Transparent Network Substrate (TNS) community and a node. This repository object definition is recorded for documentation purposes only, that is, none of its properties are used by the Generator products.

Use the Repository Object Navigator to create community member definitions.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Community member definition properties

Owning Container

Community

Node

Version

Related Topics

Communities


Display only
The name of the member of the Transparent Network Substrate (TNS) community. This property is for documentation purposes only, and is not used by the generator products.


Display only
The name of the node that is to be a member of the Transparent Network Substrate (TNS) community.

This property is for documentation purposes only, and is not used by the generator products.


Database Object Grants

About database object grants

Specifies grant object privileges for database users and roles on database objects defined in the repository, i.e. tables, views, materialized views, sequences, PL/SQL definitions, directories, Java objects and queue implementations etc. Server Generator can use this information to create GRANT statements.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Database object grants definition properties

Owning Container

For

Database

Database User / Role

On

Database

Database User

Element Type

Version

Create Synonym ?

Privileges

All Privileges ?

Select ?

Insert ?

Update ?

Delete ?

Index ?

Alter ?

Reference ?

Execute ?

Read ?

With Grant Option ?

Dequeue ?

Enqueue ?

Documentation

Comment

Related Topics

Database User Roles

Database Users

Sequences

Materialized views

Tables

Views


Display only
The name of the user to be granted access privileges on the database object.


Display only
The name of the role to be granted access privileges on the database object.


Display only
The name of the element type to which access is to be granted. The element type can be table, view, materialized view, sequence, PL/SQL definition, directory or Java definition.


Indicates whether a synonym is automatically created by Server Generator when the database object is in a different schema to the user or role.

Default: Yes


Display only
The name of the table to which access is to be granted.


Display only
The name of the view to which access is to be granted.


Display only
The name of the materialized view to which access is to be granted.


Display only
The name of the sequence to which access is to be granted.


Display only
The name of the PL/SQL definition to which access is to be granted.


Display only
The name of the Java definition to which access is to be granted.


Display only
The name of the directory to which access is to be granted.


Display only
The name of the queue definition to which access is to be granted.


Indicates that the READ privilege is granted to the user or role.

Default: No


Indicates that the ALL access privilege is granted to the user or role.

Default: No


Indicates that the SELECT privilege is granted to the user or role.

Default: Yes


Indicates that the INSERT privilege is granted to the user or role.

Default: No


Indicates that the UPDATE privilege is granted to the user or role.

Default: No


Indicates that the DELETE privilege is granted to the user or role.

Default: No


Indicates that the INDEX privilege is granted to the user or role.

Default: No


Indicates that the ALTER privilege is granted to the user or role. This privilege applies to PL/SQL definitions.

Default: No


Indicates that the EXECUTE privilege is granted to the user or role.

Default: No


Indicates that the REFERENCE privilege is granted to the user or role.

Default: No


Indicates that the GRANT privilege is granted to the user or role.

Default: No


Indicates that the DEQUEUE privilege is granted to the user or role. This privilege applies to queue implementations.

Default: No


Indicates that the ENQUEUE privilege is granted to the user or role. This privilege applies to queue implementations.

Default: No


Optional, 240 characters
A comment or statement on the granting of privileges to this user or role.


Database Profiles

About database profiles

A database profile specifies a set of limits on database resources and parameters for password control. These limits can be applied to one or more database users within the Oracle database on which the database is defined.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Database Profile definition properties

Owning Container

Oracle_Database

Name

Version

Limits

Sessions_per_user

CPU Per_Session

CPU Per_Call

Connect_Time

Idle_Time

Logical_Reads_Per_Session

Logical_Reads_Per_Call

Private_SGA

Private_SGA_Units

Composite_Limit

Login

Failed_Login_Attempts

Password

Password_Lock_Time

Password_Lifetime

Password_Reuse_Time

Password_Reuse_Max

Password_Verify_Function

Password_Grace_Time

Related Topics

Databases

Database Users


The number of days for which an account should be locked after the specified number of failed login attempts. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default


Limits the total resource cost for a session. The total resource cost is a weighted sum of the following resources Cpu Per Session, Connect Time, Logical Reads Per Session and Private SGA. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default


Limits the total elapsed time of a session. This value is expressed in minutes. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default


Limits the CPU time for a call (a parse, execute, or fetch). This value is expressed in hundredths of seconds. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default


Limits the CPU time for a session. This value is expressed in hundredths of seconds. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default


The number of failed login attempts before lockout of the account. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default


Limits periods of continuous inactive time during a session. This value is expressed in minutes. Long-running queries and other operations are not subject to this limit. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default


Limits the number of data blocks read for a call (a parse, execute or fetch) to an integer number of blocks. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default


Limits the number of data blocks read in a session, including blocks read from memory and disk to an integer number of blocks. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default


Mandatory, 30 characters
A unique name for the database profile.


Mandatory
The name of the database for which the resources and parameters are defined


The grace period in days for changing a password after the first successful login. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default


The lifetime of the password in days after which the password expires. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default


The maximum number of password changes before the password is not allowed to be used again. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default

Note:	When Password Reuse Max is defined as an integer, Password Reuse Time should be defined as UNLIMITED. If not, an error will be raised (CDI-11020) and the profile won't be generated.


The number of days before which a password cannot be reused. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default

Note:	When Password Reuse Time is defined as an integer, Password Reuse Max should be defined as UNLIMITED. If not, an error will be raised (CDI-11020) and the profile will not be generated.


Identifies whether a password complexity check is made before the password is assigned. Null indicates that no password verification is performed. If set to Default a PL/SQL function is used to verify the password.

Suggested Values: Default, Null
Default: Default


Limits the amount of private space a session can allocate in the shared pool of the SGA to an integer number of bytes (if no units specified). Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default


Optional
The units in which Private SGA is expressed. A null value indicates bytes.

Valid Values: <Null>, Kilobytes, Megabytes


Limits the user to a specified number of concurrent sessions. Enter a value or choose from the suggested values.

Suggested Values: Default, Unlimited
Default: Default


Database synonyms

About database synonyms

A database synonym is an alias that is used to identify database objects in a database. An advantage of using a synonym is that if the name of the underlying database object is changed, only the synonym needs to be redefined, rather than the actual names of the database objects.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Database synonym definition properties

Owning Container

Element type

Name

Version

Scope

Complete ?

Documentation

Description

Notes

Related Topics

Databases


Indicates whether the definition of this object is complete and ready to be used by the Server Generator.

Default: Yes


Mandatory, 30 characters
Another name by which the database object is known.


Display only
The name of the object definition for which the synonym is defined. For example, the name of a table.


Display only
The name of the PL/SQL definition for which the synonym is defined.


Mandatory, 10 characters
Indicates whether the synonym is Public Or Private.

Valid Values: Private, Public
Default: Public


Display only
The name of the sequence for which the synonym is defined.


Display only
The name of the materialized view for which the synonym is defined.


Display only
The name of the table for which the synonym is defined.


Display only
The name of the view for which the synonym is defined.


Display only
The name of the Java definition for which the synonym is defined.


Database Triggers

About triggers

Trigger definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About triggers

A database trigger is defined using PL/SQL logic that is implicitly executed when an INSERT, UPDATE or DELETE statement is issued against its associated table or view.

Triggers are similar to stored procedures, except that, whereas procedures must be explicitly executed by a user or an application, a trigger is implicitly executed when an associated table is modified.

Triggers are defined using a trigger definition and an associated PL/SQL definition of the type TRIG_LOGIC.

The trigger definition defines the triggering event; i.e. the INSERT, UPDATE or DELETE statement that causes the trigger to fire. The PL/SQL definition of the type TRIG_LOGIC is used to define the trigger action, which contains the statements to be executed when the trigger is fired.

The Server Generator can be used to create the trigger on the target database.

Uses of Triggers

Components of a Trigger

Types of Trigger

--------------------------------------------------------------------------------------------------

Trigger definition properties

Owning Container

Table /View

Name

Version

Purpose

PL/SQL Definition

Complete ?

Enabled ?

Trigger

Time

Level

Insert ?

Delete ?

Update ?

Fire When Propagated ?

Trigger When Condition

Alias

New Alias

Old Alias

Documentation

Description

Notes

User Help Text

Related Topics

Tables

Trigger Column Usages


Display only
The name of the table for which the trigger is defined.


Display only
The name of the view for which the trigger is defined.


Mandatory, 30 characters
A unique name for the trigger.


Mandatory, 70 characters
The purpose or short description of the trigger.


Mandatory
The name of the PL/SQL definition that defines the trigger action. This definition contains the statements to be executed when the trigger is fired. The Type property of the PL/SQL definition must be set to TRG-LOGIC.

Note:  A PL/SQL definition may be associated with more than one database trigger.


Mandatory
The relative time when the trigger is to be executed; that is, when the trigger action is to be executed in relation to the triggering statement: before or after the triggering statement. The options are:

Trigger fires after triggering statement
Trigger fires before triggering statement - Default
Trigger fires instead of triggering statement


Indicates whether the trigger is a row or a statement trigger.

Row level  (Default)	The trigger is fired each time a row on the table is affected by the triggering statement.
Statement level	The trigger is fired once for the triggering statement, regardless of the number of rows in the table that the triggering statement affects.


Indicates whether an INSERT statement is to cause the trigger to fire.

Default: Yes (INSERT statement will cause the trigger to fire)


Indicates whether a DELETE statement is to cause the trigger to fire.

Default: Yes (DELETE statement will cause the trigger to fire)


Indicates whether an UPDATE statement is to cause the trigger to fire.

Default: Yes (UPDATE statement will cause the trigger to fire)


Indicates whether the trigger is to be enabled or disabled on the database.

Default: Yes


Indicates whether the trigger is ready to be created by the Server Generator.

Default: Yes

When set to False, this object will be ignored on generation.


Optional, 40 characters
The correlation name to be used by a row trigger when specifically referring to old values of a row. The default correlation name for referring to old values is the keyword OLD. If the name of the table for which the trigger is being defined is 'OLD' you should specify a value here to avoid confusion between the table name and the correlation name.


Optional, 40 characters
The correlation name to be used by a row trigger when specifically referring to new values of a row. The default correlation name for referring to new values is the keyword NEW. If the name of the table for which the trigger is being defined is 'NEW' you should specify a value here to avoid confusion between the table name and the correlation name.


Indicates whether or not the trigger is to fire when the data has been propagated, for example, in a multi-master replication environment.

Default: No

Note, this property is for information only. It does not necessarily result in code being generated by the Server Generator.


Optional
The condition that determines when the trigger logic action is to be performed. The keyword WHEN should be omitted, because it is automatically generated by the Server Generator. For example, if you enter the condition:

new.price < old.price

The Server Generator generates the following DDL statement:

WHEN (new.price < old.price)

Note, the action to be performed is recorded in a PL/SQL definition of type TRG-LOGIC.


Optional
Online information about the trigger.


Uses of Triggers

Triggers have many uses. For example, you might define a trigger to enforce data security, to ensure that modifications can be made to a table only within regular business hours.

In addition to providing security facilities, triggers can be used to:

•	generate derived column values

•	prevent invalid transactions

•	enforce complex security authorizations

•	enforce referential integrity across nodes in a distributed database

•	enforce complex business rules

•	provide transparent event logging

•	maintain synchronous table replicates

•	gather statistics on table access


Components of a Trigger

A trigger is made up of three parts:

•	a triggering event

•	a trigger restriction

•	a trigger action

Triggering Event

A trigger is fired by some event, known as the triggering event. The triggering event can be an INSERT, UPDATE or a DELETE statement for a specific table. For example:

   BEFORE INSERT OR UPDATE of price, current_flag
   ON flix.charge_bands
   FOR EACH ROW

If the triggering event consists of an UPDATE statement, a column or set of columns can be specified to identify which columns must be updated to fire the trigger.

Trigger Restriction

A trigger restriction specifies a Boolean expression that must be true for the trigger to fire. If the trigger restriction evaluates to false, the trigger action is not executed.

Trigger restrictions are specified for row-level triggers, that are fired for each row, and are used to control the execution of the trigger.

Trigger restrictions are defined using a WHEN clause.

For example:

   WHEN (new.price < old.price)

Trigger Action

The trigger action consists of a procedure that contains the PL/SQL and SQL statements to be executed when a triggering statement is issued and the trigger restriction evaluates to true. The structure of the trigger action might look like this:

   DECLARE ...
   BEGIN
      /* statements */
   END;

The trigger action can call other stored procedures.


Types of Trigger

There are two basic types of trigger:

•	row triggers

•	statement triggers

In addition to defining whether the trigger is a row-level trigger or a statement-level trigger, you can also specify when the triggering action is to be executed in relation to the triggering event.

Triggers can be fired before the triggering event is issued against the associated table, or after the triggering event.

Row Triggers

A row trigger is fired once for each row in the table that is affected by the triggering event.

For example, if an UPDATE statement updates multiple rows in a table, a row trigger is fired once for each row affected by the UPDATE statement. If no rows are affected, then the row trigger is not executed.

Statement Triggers

A statement trigger is fired once when the triggering event is issued. Statement triggers are fired regardless of the number of rows in the table that are affected by the triggering event. They are also fired even if no rows are affected.

For example, if a DELETE statement deletes several rows from a table, a statement trigger is fired only once, regardless of the number of rows that are deleted from the table.

Before Triggers

Before triggers are used when the trigger action should determine whether or not the triggering event should be allowed to complete.

By defining 'before' triggers, unnecessary processing of the triggering event is eliminated.

Before triggers can also be used to derive specific column values before completing a triggering INSERT or UPDATE statement.

After Triggers

An after trigger causes the trigger action to be executed after the triggering event is executed. For example, you might define an after trigger to log changes that have been made to a table.

After triggers can be used to ensure that the triggering statement completes before the trigger action is executed. They can also be used to perform different actions on the same triggering event, if a before trigger is already present.


Database User Roles

About database user roles

Database user roles record the roles that are granted to specific database users in the repository.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Database user role definition properties

Owning Container

Database

Database User

Role

Version

With Admin Option ?

Related Topics

Roles

Database Users


Mandatory
The role of which the database user is a member.


Mandatory
The name of the database user.


Indicates whether users who can perform this role can grant this role to other users.

Default: No


Database Users

About database users

Defines the users who will have access to the database that is defined for a given workarea. The Server Generator can use these definitions to generate GRANT statements. These GRANT statements may be run by an administrator, using Oracle SQL*PLUS or SQL*DBA, to enroll new users.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Database user definition properties

Owning Container

Database

Name

Version

Initial Password

Complete?

Database Profile

Tablespaces

Default Tablespace

Temporary Tablespace

Documentation

Comment

Description

Notes

Related Topics

Database User Roles

Tablespace Quotas

Database Object Grants

System Privileges


Mandatory, 30 characters
A unique name for the database user.


Mandatory
The name of the database on which the element will reside.


Optional
The name of the database profile from which the user derives limits for database resources and parameters for passwords.


Mandatory, 30 characters
The password to be used by the user.


Optional
The name of the default tablespace for the user. This identifies the physical tablespace into which this user's schema objects will be placed.


Optional
The name of a temporary tablespace for the user to store read only database objects. A temporary tablespace should be used for operations such as sorting that might need more memory than is available in the default tablespace.


Indicates whether the database user is ready to be created by the Server Generator.

Default: Yes


Optional, 240 characters
A comment about this database user.


Datastructure Items

What do you need help with?

About datastructure items

Datastructure item definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About datastructure items

A datastructure item is a 'component' of a datastructure. A datastructure can be a single datatype or a reference to a set of datatypes. You can define a datastructure item in terms of one of the following:

•	Datatype

•	Domain

•	Table

•	Column

•	Datastructure

•	Program data

•	Cursor

The PL/SQL code for generating the datastructure has the following format:

TYPE ds_name IS RECORD
(
dsi1 {datatype / table%ROWTYPE / table.column%TYPE / datastructure / variable%TYPE / cursor}
dsi2 {datatype / table%ROWTYPE / table.column%TYPE / datastructure / variable%TYPE / cursor}
...
)

"ds_name" is the name of the datastructure and "dsi1" and "dsi2" are the names of the datastructure items. Note that the declarations of the datastructure items contain precisely one of the items within the curly braces. For example:

dsi1 table.column&TYPE

--------------------------------------------------------------------------------------------------

Datastructure Item definition properties

Owning Container

Parent Datastructure

Name

Version

Usage Sequence

Defined By

Domain

Table

Column

Oracle Type

Datastructure

Program Datum

Cursor

Definition

Datatype

Length

Decimal Places

Default Value

Default Value Type

Optional ?

Documentation

Description

Notes

Related Topics

Columns

Datastructures


Display only
The datastructure of which this datastructure item forms a part.


Mandatory, 30 characters
The name of the datastructure item. An item is a field within the datastructure.


Optional, 3 digits
A number used to order the datastructure item when the datastructure is created.


Optional, 70 characters
The datatype of the datastructure item. A list of valid scalar datatypes (e.g. CHAR, NUMBER, DATE, LONG) is available.

Note: 	If you select a datatype for this datastructure item then you cannot specify values for the properties in the Defined by block.


Optional, 5 digits
For certain datatypes, the maximum length of the data that the datastructure item can contain.


Optional, 3 characters
For certain datatypes, the number of decimal places of the datastructure item.


Optional, 60 characters
A default value for the datastructure item.

To specify whether the value entered is a literal string or a database function call, set the Default Value Type property.


Mandatory
Indicates the nature of the default value, i.e. whether it is a literal value or a database function.

Default: Literal


Indicates whether or not the datastructure item is optional, i.e., whether or not it can contain null values.

Default: Yes


Optional
The domain on which this datastructure item is based. The generated datastructure item is given the datatype defined in the domain.

If you specify a domain, then you cannot specify values for the other fields in the Defined By block, nor can you specify a value for the Datatype field.


Optional
The name of the table on which this datastructure item is based, or the table that owns the column in the Column field. If you specify a table and leave the column field blank, then the Server Generator will base this datastructure item on the datatypes of the columns of the specified table.


Optional
The column on which this datastructure item is based. If you specify a column, then you cannot specify values for the other fields in the Defined By block, nor can you specify a value for the Datatype field.

Note: You need to specify a table before you can specify a column.


CQA Reference
Not in R2.0.


Optional
The name of the datastructure referenced by this datastructure item. If you specify a value for this field, the generated datastructure item contains a datastructure type instead of a simple datatype.

If you specify a datastructure, then you cannot specify values for the other fields in the Defined By block, nor can you specify a value for the Datatype field.

The list displays only those datastructures that are owned by the current PL/SQL definition or are owned by a PL/SQL package definition.


Optional
The program data referenced by this datastructure item. If you specify a value for this property, then you cannot specify values for the other fields in the Defined By block, nor can you specify a value for the Datatype field.

This list displays all program data owned by the current PL/SQL definition and all program data with the Public flag. Note that the Construct Type property in the program data must be set to VARIABLE.


Optional
Identifies the object type, VARRAY or nested table that defines the structure of the data represented by this datastructure item.


Optional
The name of the cursor referenced by this datastructure item. Note that the items in the list have the format "<MOD>.<CUR>", where "<MOD>" is the name of the PL/SQL definition that calls the cursor definition and "<CUR>" is the name of the cursor definition.

If you specify a value for this property, then you cannot specify values for the other fields in the Defined By block, nor can you specify a value for the Datatype field.


Datastructures

What do you need help with?

About datastructures

Datastructure definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About datastructures

Defines an additional PL/SQL composite datatype (i.e. a PL/SQL table, record or cursor).

Every constant and variable has a datatype. PL/SQL provides a variety of predefined scalar and composite datatypes (or datastructures). Datastructures have internal components that can be manipulated individually or as a unit.

PL/SQL tables and records can each comprise one or more datastructure items.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Datastructure definition properties

Owning Container

PL/SQL Definition

Name

Version

Type

Scope

Usage Sequence

Documentation:

Comment

Description

Notes

Related Topics

Datastructure Items

Records

Tables


Mandatory, 30 characters
The name of the datastructure. The name can be in upper-, lower- or mixed-case. This name can be used when declaring PL/SQL tables and records.


Mandatory
The PL/SQL composite datatype. The options are:

PL/SQL Cursor
PL/SQL Record
PL/SQL Table

Default: PL/SQL Record


Optional, 240 characters
A comment or brief description about the datastructure's usage.


Mandatory
The short name for the PL/SQL definition (i.e., package, function or procedure) where the datastructure is to be defined. If this entry is left blank, the datastructure will be defined in each package, procedure or function that has a program data construct based on this type.


Indicates whether the datastructure is public or private.

Default: Public


Optional, 6 digits

Specifies the order of datastructures when dependencies need to be managed. For example, if a datastructure has a datastructure item whose definition is another datastructure.


Directories

About database directories

A directory is a database object representing an operating system directory for administering access to, and the use of, BFILEs stored outside the database. It is an alias for a directory name on the server's file system where the external binary file LOBs are actually located. All directories for a database are created in a single namespace and are not owned by an individual's schema.

Access to BFILEs stored within the directory structure is controlled by granting object privileges on the directories to specific users. Privileges granted for the directory are created independently of the permissions defined for the operating system directory and so the two may or may not correspond exactly.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Directory definition properties

Owning Container

Oracle Database

Name

Version

Path

Complete?

Documentation

Description

Notes

Related Topics

Databases


 Identifies whether the directory definition is complete and ready to be used for generation.

Default: Yes


Mandatory, 30 characters
The name of the directory.


Identifies the name of the Oracle database for which the directory is defined.


Mandatory, 132 characters
The full pathname of the operating system directory in which the BFILEs are located.


Foreign keys

What do you need help with?

About foreign keys

Foreign key definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About foreign keys

A foreign key constraint is a type of referential integrity constraint for checking the integrity of data entered in a specified column or set of columns. This specified column or set of columns is known as the foreign key. The foreign key constraint specifies that values entered in the foreign key columns must match a value in the primary key or the unique key of another table, or of the same table. Thus, a foreign key constraint ensures that no erroneous data can be entered in related tables.

Note:	For this release, foreign key constraints cannot be recorded in the repository for object tables and object views.

Foreign key constraints can be defined:

•	between two different tables

•	on a single table (recursive foreign key)

On a Server Model Diagram, foreign key constraints are represented using crowsfoot connectors.

The many-end of the connector denotes the element on which the foreign key is defined. The one-end of the connector connects to the element whose primary key or unique key is referenced by the foreign key.

If the foreign key is recursive (pigs ear), both ends of the connector intersect the same element.

The connector indicates:

•	the optionality of the columns defined as part of the foreign key

•	whether the foreign key is transferable, i.e. whether it can be updated

The name of the foreign key constraint is displayed against the connector.

Mandatory and Optional Foreign Keys

Foreign key constraints can be mandatory or optional.

	A value entered in the column in the foreign key must match a value in the primary key (or unique key) column.
	A value entered for the column in the foreign key must match either a value in the primary key (or unique key) column, or else it must be null.
	A value in the foreign key column must match a value in the primary key (or unique key) column on the same table, or else it must be null. A recursive foreign key should always be optional.
Transferable Foreign Keys

A foreign key is transferable if the foreign key value can be disconnected from its associated primary key value and be reconnected to a different primary key value. In most cases, a foreign key will be transferable.

For example, the table MEMBERSHIPS has a foreign key column MT_CODE that references the primary key column # CODE of the MEMBERSHIP_TYPES table. The foreign key is transferable since, for any given membership held in the MEMBERSHIPS table, it is possible to change the membership to another membership type.

In this example, the private membership 1021 can be transferred to a corporate membership, and vice versa. The foreign key value does not have to be associated with any particular instance of the primary key.

Transferable foreign keys do not have any specific notation. They are represented on Server Model Diagrams using crowsfoot connectors.

Non-Transferable Foreign Keys

A foreign key is non-transferable if the foreign key value cannot be disconnected from a specific instance of the associated primary key. Non-transferable foreign keys must always be connected to a particular instance of the primary key. This type of constraint can be enforced only in the client application. The client generators enforce non-transferable keys by making the items based on the foreign key columns non-updateable.

For example, the MEMBERSHIPS table has a foreign key column CU_CUSTOMER_NUMBER that references the primary key column # CUSTOMER_NUMBER of the CUSTOMERS table. The foreign key is non-transferable since, during the course of a membership, a membership can be associated only with a specific customer. The membership 1021 is associated with the customer number DJ305, and while it exists, cannot be connected to a different customer number. An attempt to update the foreign key in the client with the value SC907 would be invalid, since the column is non-updateable.

Non-transferable foreign keys are represented on Server Model Diagrams by a diamond at the crows-foot end of the connector.

Hidden Arcs

Foreign keys that are part of an arc are denoted by a bar across the base of the connector. This indicates that there are other foreign keys that belong to the arc that are not displayed on the diagram.

The arc can be displayed on a Server Model Diagram, by including the foreign keys that are part of the arc.

Note:	When the key constraints are implemented an index will be automatically created on the database to enforce a UNIQUE or PRIMARY key integrity constraint.

Cascade delete rules for foreign keys

The cascade delete rules determine the action to be taken when an attempt is made to delete a related row in a join table. The delete rule for each foreign key is determined by the Delete Rule property. Each of the delete rules is represented on a Server Model Diagram as shown below.

Foreign Key Constraints between Different Tables

Because the tables in a database can be related by common columns, foreign key constraints can be defined to preserve the integrity of the data in related tables.

In the following example, both the tables EMP and DEPT contain the common column DEPTNO. A foreign key constraint is defined between the two tables to check the integrity of data entered in the column DEPTNO in the EMP table. Only legitimate department numbers, that are defined in the DEPT table, can be entered for the DEPTNO column in the EMP table.

An attempt to enter the department number '40' into a row in EMP would fail since 40 is not defined in the DEPTNO column in DEPT. Thus, the foreign key constraint defined between EMP and DEPT ensures that the data entered in the DEPTNO column on the EMP table is always valid.

To enforce that a value for the key columns must be specified, the key columns could be defined as mandatory.

Foreign keys can consist of more than one column. Composite foreign keys must reference a composite primary key or a unique key having the same number of columns .

Recursive Foreign Key Constraints

A foreign key constraint whose foreign key columns reference the primary key of the same table is known as recursive.

Given the table EMP, you might define a foreign key constraint between the columns MGR and EMPNO, to check that, for each manager number entered, an equivalent employee number must exist. This would ensure that the manager, identified by the manager number, must also be an employee of the company.

An attempt to enter the manager number 5832 would violate the constraint, since 5832 does not exist in the primary key column, EMPNO.

When the foreign key definition has been entered into the repository, the foreign key can then be implemented on the database using the Server Generator.

--------------------------------------------------------------------------------------------------

Foreign key definition properties

Owning Container

Table

Join Table

Name

Version

Complete ?

Enable ?

Mandatory ?

Transferable ?

Validation

Validate In

Defer Status

Error Message

Exceptions Table

Cascade Rules

Delete Rule

Update Rule

Arc

Arc Number

Arc Mandatory ?

Joining To

Primary Key Joined to

Unique Key Joined to

Source

Relationship

Documentation

Description

Notes

Related Topics

Check Constraints

Columns

Indexes

Primary Key Constraints

Tables

Unique Key Constraints


Optional, 6 digits
A number that identifies an arc in which this key is to be found.


Optional
The name of the entity relationship that this foreign key implements. Relationships are defined at the analysis level using the Oracle Systems Modeling tools. If the foreign key has been created using the Database Design Transformer, then this property defaults to the name of the relationship that it implements. This property is for documentation purposes only, and is not used by the generator products.


 Optional
The name of the primary key constraint on the join table. The specified primary key provides a derivation value for all or part of this foreign key.


 Optional
The name of a unique key constraint on the join table. The specified unique key provides a derivation value for all or part of this foreign key.


Indicates whether this arc is mandatory, that is, a value must be specified.

Default: No


Global Index Partitions

About global index partitions

A global index partition represents a partition into which an index has been divided. The index partition can have different physical characteristics to the index, for example, it can be stored in a different tablespace and can have its own storage parameters.

The partitioning of a global index is completely independent of the partitioning of its associated table. A global index is partitioned based on its own specific partition key, which is not necessarily the same as the partition key of the table.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Global Index Partition definition properties

Owning Container

Index

Name

Version

Usage Sequence

Value_Less_Than

Storage

Tablespace

Storage Definition

Init Trans

Max Trans

Percent Free

Related Topics

Index Storages

Storage Definitions

Tablespaces


Mandatory
The sequence in which the global index partition is to appear amongst other partitions for the same index in the generated Data Definition Language statements.


Mandatory, 240 characters
The 'VALUE LESS THAN' parameter for this global index partition. In the case of a composite partition key, the multiple parameters are separated by commas e.g. "6,5,0". Surrounding brackets are added by the Server Generator in the generated Data Definition Language statements.


Index Entries

About index entries

Index entries specify the columns or functions on which an index is to be based. For entries in a concatenated index, the sequence number denotes the order of the entries in the index.

If the index entry is ‘Function based’, the value for the index expression is derived from the ‘ Index function’, e.g. UPPER(column_name). Otherwise the value is derived via the assigned column for that index entry.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Index entries definition properties

Owning Container

Table

Index

Column

Version

Usage Sequence

Index Function

Type

Related Topics

Columns

Indexes


Display only
The name of the table for which the index entry is defined.


Display only
The name of the index for which the index entries exist.


Display only
For a column based index entry, the name of a column that is to be part of a column based index.


Column Qualified Attribute Reference
Not used in this release.


Mandatory, 6 digits
The sequence of this column or function in the index.


Optional, 2000 characters
For a function based index entry, the function expression to be used. The text you enter is free format and is not validated.


Identifies whether the index entry is based on a column or a function expression.


Index Storages

What do you need help with?

About index storages

Index storage definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About index storages

There are two types of index storage definition that you can record in the repository

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

User object index storages

A user object index storage definition records storage information specific to a user defined index for a particular database user. The index for which storage information is to be recorded may be:

•	the definition of an index in the context of a specific implementation of a table, materialized view or cluster for a database user

•	the index used to implement a primary key in the context of a specific implementation of a table for a database user

•	the index used to implement a unique key in the context of a specific implementation of a table for a database user

Implicit index storages

An implicit index storage defines storage for an index created implicitly by the database, such as an index on an object table or a materialized view index.

Index storage definition properties

Owning Container

Database

Database User

Table / Materialized view / Cluster

* Index

* Primary Key / * Unique Key

Index Type

**Implicit Index Type

Version

**Name

Storage

Tablespace

Storage Definition

Init Trans

Max Trans

Percent Free

Reverse or Nosort

Parallel

Parallel ?

Degree

Instances

Documentation

Non Oracle Storage

The following notation is used to identify which index storage properties are unique to each type of index storage

*User Object Index Storages only

**Implicit Index Storages only

Related Topics

Databases

Database Users


Display only
The name of the database user for which the index is defined.


Display only
The name of the table for which the index storage details are defined.


Indicates whether the storage details are for a local or global index. Note, an Oracle7 index is equivalent to an Oracle8 global index.

Valid Values: Global, Local
Default: Global


Optional, 3 digits
The initial number of transaction entries for the index.

Range: 1 - 255


Optional
Allows you to define storage for an index on a database that is not an Oracle database. You should use free format SQL DDL to define the index storage.


Optional, 3 digits
The maximum number of transaction entries for the index.

Range: 1 - 255


Mandatory, 3 digits
A percentage of space to allow for growth of the index. The default is 10.

Range: 0 - 999


The name of the cluster in which the index is created.


The name of the materialized view in which the index is created.


The name of the set of storage parameters that are required by the index.


Optional
The name of the tablespace in which the index is created.


Indicates whether parallel querying is to be used.

Default: No


Optional, 6 digits
The degree of parallelism. If this property is <Null>, the Server Generator will create an index with a DEFAULT degree of parallelism.


Optional, 6 digits
Specifies how an index is split among the available instances of a parallel server for parallel query processing.

An integer specifies that this index is to be split among the specified number of instances. If this property is <Null>, the Server Generator will create an index with DEFAULT instances.


Indicates whether Reverse or Nosort options are to be used for this index.


Display only
Identifies whether the implicit index storage is for an Oracle object type or a materialized view.


Optional, 30 characters
The name to be used for the implied index.


The name of the index or primary key for which the storage details are defined.


The name of the primary key that is implemented by the index.


The name of the unique key that is implemented by the index.


Indexes

About indexes

Indexes can be specified for relational tables, materialized views and clusters. They increase the speed with which rows can be retrieved. They can also be used to guarantee the unique nature of a column or set of column values in a table.

Within the repository, an index definition records the table, materialized view or cluster for which the index is defined. If the index is for a table or materialized view, its type must be specified using the Index Type property.

In the repository index entries are used to identify the columns or functions on which the index is based.  About

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Index definition properties

Owning Container

Table / Materialized view / Cluster

Name

Version

**Index Type

Complete ?

Compute Statistics ?

Supports

**Foreign Key

Documentation

Comment

Description

Notes

** Tables and materialized views only

Related Topics

Columns

Index entries

Index storages


Mandatory, 30 characters
A unique name for the index.


Indicates whether this index is ready to be created by the Server Generator.


Indicates whether statistics are to be collected on creation of the index.

Default: No


Mandatory
The name of the cluster that uses the index.


Mandatory
The name of the table that uses the index.


Mandatory
The name of the materialized view that uses the index.


The name of the foreign key used to reference the table using this index.


Indicates whether the index is to be used to maintain uniqueness or whether the index may contain duplicate keys or bitmaps. The options are:

Not-Unique	Specifies that the rows in the table can contain duplicate values in the columns that define the index.
Unique	Specifies that no two rows in the table can contain duplicate values in the columns that define the index.
Bitmap	Specifies that a bitmap index is to be used.


Optional, 240 characters
A comment about why the index is created and how it is to be used.


Java definitions

About Java definitions

Use Java definitions to model Java schema objects in the repository. The available Java definition types and their purposes are described below:

Java Definition Type	Description
CLASS	Defines the use of a compiled Java class, in the standard binary class format.
RESOURCE	Defines the use of Java data in standard portable format.
SOURCE	Defines the use of a Java source language program. The Java source code can optionally be specified within the Java Block property.
Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Server Generator uses these definitions to generate CREATE OR REPLACE JAVA statements.

--------------------------------------------------------------------------------------------------

Java definition properties

Owning Container

Short Name

Version

Name

Purpose

Type

Implementation Name

Planning

Status

Candidate ?

Size

Complexity

Project

Activity

Task

Time Estimate

Estimate Units

Invocation

Top Level ?

Java

Java Block

Documentation:

Release Notes

Description

Notes

Related Topics

Java implementations


The type of Java definition that is to be recorded in the repository:

Type	Description
Class	Compiled Java class in standard binary class format.
Resource	Java data in standard portable format.
Source	Java source language program.


Optional
The name assigned to the generated Java source or Java resource object. If left blank the Name property is used instead.

Note: This property is not applicable to Java class objects.


Optional
Defines Java source text. Note that this property is relevant for Java source definitions only.

This property is not applicable for Java class or Java resource objects.


Java implementations

What do you need help with?

About Java implementations

Java implementation properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About Java implementations

A Java implementation records implementation specific information for a Java definition (source, class or resource), i.e., how it is to be implemented on a database for a user.

Java implementations are also used to define how Java objects (source, class or resource) derive Java code. Java objects can be created:

USING Sub Query	Use Java code within LOB columns on the database (BLOB, CLOB or BFILE). An appropriate sub query must be supplied.
USING External BFILE	Use Java code  within a BFILE on an external file system. A database directory and filename must be supplied.
USING Key for LOB column	Use Java code within a column named LOB in the table CREATE$JAVA$LOB$TABLE. A key value must be supplied for the LOB column.
Note: 	Java source objects can also be created using Java source text defined within the Java Block property. If source text exists within the Java definition, no further code derivation details are required.

Java implementation properties

Owning Container

Database

Database User

Java Definition

Version

Complete ?

Creation

Create From

Database User

BLOB Name

Directory

File Name

Resolve ?

Force ?

Name Resolution

Resolver Clause

Scope

Global Synonym Name

Scope

Replication

Replication Group

Documentation

Implementation Description

Implementation Notes

Related Topics

Databases

Database Users

Java definitions


Mandatory
The name of the Java definition for which implementation details are being specified.


Use this property to specify whether Java code on which this Java object is to be based is stored within a user defined BFILE, BLOB, CLOB column, within the table CREATE$JAVA$LOB$TABLE, or in an external BFILE.

•	If the Java code is held within a BFILE, BLOB or CLOB on the database, choose the appropriate option and then use the Blob Name property to define a valid sub query.

•	If the Java code is held within an external BFILE, choose BFILE and then use the Directory and File Name properties to specify its location on the file system.

•	If the Java code is held within the table CREATE$JAVA$LOB$TABLE, leave the value of this property Null. Instead, use the Blob Name property to enter a key for the LOB column.

For Java source implementations only. Java source definitions can be based on Java source text stored directly within the repository, using the Java Block property. In this case, leave the value of this property Null.


For Java class definitions only. This property identifies the database user in which the object containing the Java file resides.

Note: This property is not currently used during database generation or capture.


For Java definitions deriving code from BLOB, CLOB, or BFILE columns on the database, this property defines the sub query that selects a single row and column of the type specified in the Create From property, i.e. BLOB, CLOB, or BFILE.

For Java definitions deriving code from a column named LOB in table CREATE$JAVA$LOB$TABLE.LOB, this property defines a value of the column NAME in this table, i.e. a key for the LOB column. To specify a key value, ensure that the Create From property is set to Null. If you are using, property dialogs select the option ‘USING Key for LOB column’.


For Java definitions that are based on external BFILEs, this property identifies the database directory definition that specifies the file system directory where the external BFILE is stored.

Note: This property is used when the Create From property is set to BFILE.


For Java definitions that are based on external BFILEs, this property specifies the BFILE name.

Note: This property is used when the Create From property is set to BFILE.


Indicates whether Oracle should attempt to resolve (or compile) the Java object created if the CREATE JAVA statement command succeeds.

•	When applied to a Java class, resolution of referenced names to other class objects occurs.

•	When applied to a Java source, source compilation occurs.

Note: This property applies to Java class and Java source objects only. It is not applicable for Java resource objects.

Default: No


Indicates whether the results of CREATE commands are to be rolled back, when RESOLVE is specified and the resolution or compilation fails.

Note: This property applies to Java class and Java source objects only. It is not applicable for Java resource objects.

Default: Yes


Optional
Defines the RESOLVER clause which is a search path, comprising a list of match strings and schemas, in CREATE JAVA and ALTER JAVA commands. The syntax is
    RESOLVER ((<match string> <schema name>) ...)

Where <match string> is either a Java fullname, a wildcarded fullname as can appear in a Java language import statement, or the single wildcard ’*’ that matches any name. <schema name> designates a schema to be searched for a corresponding library unit.

Example:

   RESOLVER (("a.specific.class" USERA)
   ("a.package.*" USERB)
   (* PUBLIC))

Note: Omit the word RESOLVER when entering the clause.


Optional, 30 characters
The name to be used by Server Generator when creating synonyms for this object.


The scope of visibility of the database object. This is used by the Server Generator to determine when database links and synonyms need to be created.

Valid Values: Database, World

Default: Database


Optional

The replication group property is not used as Java objects can not be replicated.


Key Components

About key components

Key components are definitions that record the columns that are used by primary key, unique key, foreign key and check constraints. For example, when a primary key constraint is recorded in the repository, the columns that are used to define the primary key are specified using key components.

When defined for check constraints, key components are for documentation purposes only, e.g. they are not used by the Server Generator.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Key component definition properties

Owning Container

Constraint

Constraint Type

Version

Column

Sequence in key

Conversion Format Mask

Join Columns/Attributes (For foreign keys only)

Join Column

Second Join Column

Documentation

Comment

Description

Notes

Related Topics

Columns

Foreign Key Constraints

Primary Key Constraints

Tables

Unique Key Constraints


Display only
The name of the constraint of which this key component forms a part.


Display only
The type of constraint (i.e., primary key, unique key, foreign key or check) to which this key component refers.


Display only
The name of the column that is used to define the key or that comprises part of the key.


Optional
Not used in R2.


Optional
The name of a column in the join table that is the derivation for all or part of this foreign key.

Note: This property is displayed only when the constraint is a foreign key constraint.


Optional
Not yet available.


 Optional, 60 characters
The format to be used when a date or number column is joined to a varchar2 column in a domain table. If a format is not specified here, the application generators use a set of rules to define the format.

Note, this property is not used by Server Generator. It applies only to key components of domain key constraints.


Optional
The name of a column in the join table that is the derivation for all or part of this foreign key.

Note: This property is displayed only when the constraint is a foreign key constraint.


Foreign CQA Reference2 Optional
Not yet available.


Optional, 6 digits
A number that defines the order of the columns in the key.


Optional, 240 characters
A description of the use of this column in this key.


LOB Storage

About LOB storages

A LOB storage represents a specification of storage information for a LOB and its index that can be used by one or more LOB columns within the same database.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

LOB Storage definition properties

Owning Container

Oracle Database

Storage Definition (Index)

Tablespace (Index)

Name

Storage

Storage Definition

Tablespace

Chunk

Chunk Unit

Init Trans (Index)

Max Trans (Index)

Cache ?

Logging ?

Percent Version

Documentation

Description

Notes


Mandatory
The name of the database on which the element will reside.


Optional
<TBD>


Optional
<TBD>


Optional
The name by which the LOB storage is identified. Note that this is different from the LOB name, which is held on COLUMN_LOB_STORAGE.


Optional
The name of the storage definition that defines the storage parameters that are used by this LOB storage.


Optional
The name of the tablespace on which this LOB storage is to be stored.


Optional, 38 digits
The unit of LOB value allocation and manipulation. Expressed in units indicated by ‘Chunk Unit’.


Optional
The unit of measure in which the ‘Chunk’ property is expressed. Choose from kilobytes or megabytes.


Optional, 3 digits
Specifies the initial number of transaction entries allocated within each data block that is allocated to the LOB index segment.


Optional, 3 digits
Specifies the maximum number of concurrent transactions that can update a data block that is allocated to the LOB index segment.


Optional
Indicates whether the Cache option is required, i.e. whether blocks retrieved are placed at the most recently used end or least recently used end of the LRU in the buffer cache when a full table scan is performed.

Default: No


Optional
Indicates whether LOGGING option is required, i.e. whether subsequent operations against the LOB storage that can execute without logging are to be logged in the Redo file.

Default: Yes


Optional, 2 digits
Specifies the maximum percentage of overall LOB storage space used for creating new versions of the LOB, i.e. older versions of the LOB data are not overwritten until this percentage of the overall LOB storage space is used.


Local Index Partitions
Local Index Partition

About local index partitions

A local index partition represents a partition into which an index has been divided. The index partition can have different physical characteristics to the index, for example, it can be stored in a different tablespace and can have its own storage parameters.

Each local index partition has exactly the same number of partitions (with exactly the same "VALUE LESS THAN" boundaries) as the number of partitions that have been defined for the table. The tablespace and the storage parameters for a local index partition do not have to be the same as those used for the table partitions.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Local Index Partition definition properties

Owning Container

Index/Primary Key

Name

Table_Partition

Version

Storage

Tablespace

Storage Definition

Init Trans

Max Trans

Percent Free

Related Topics

Storage Definitions

Table Partitions

Tablespaces


Mandatory
The name of the table partition to which the local index partition belongs.


Materialized Views

What do you need help with?

About materialized views

Materialized view definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About materialized views

Materialized views are copies of another table, view or materialized view. A materialized view reflects a recent state of the table, view or materialized view on which it is based, known as the base table, and is periodically refreshed at specified intervals, if defined.

Materialized views are a useful facility in distributed database systems, since queries can be issued against a copy of a local table, view or materialized view that is physically located at a remote site. Because the materialized view resides on a separate node to the base table, the materialized view provides a backup mechanism in the event of a system failure on the master database.

Materialized views can be created in the context of a Server Model Diagram, and are represented by a blue rectangle as shown below.

The materialized view EMP_SS shown above is an example of a simple materialized view; that is, each row in the materialized view EMP_SS is based on a single row in the base table EMP.

When the materialized view definition has been entered into the repository, run the Server Generator. This utility will generate a command file containing the SQL statements required to build the materialized views on an Oracle database.

Information about how a materialized view is refreshed, is recorded in the repository using materialized view implementations.

How Materialized views are defined

A materialized view is defined using a query on one or more base tables.

There are two types of materialized view:

•	simple

•	complex

Simple Materialized views

A materialized view that is based on a single table is considered to be a simple materialized view. Each row in the materialized view is based on a single row in the base table. The query that defines a simple materialized view does not contain joins on other tables, GROUP BY clauses or CONNECT BY clauses.

Complex Materialized views

A materialized view that is based on multiple tables is considered to be complex, since the defining query can contain joins on other tables, GROUP BY clauses or CONNECT BY clauses.

When the materialized view definition has been entered into the repository, the materialized view can then be created on the database using the Server Generator.

--------------------------------------------------------------------------------------------------

Materialized view definition properties

Owning Container

Name

Version

Alias

Display Title

Updateable ?

Storage

Cluster

SQL

Free Format Select Text

Select Text

Optimizer Hint Clause

Where/Validation Condition

Documentation

Comment

Description

Notes

User Help Text

Related Topics

Columns

Foreign Key Constraints

Primary Key Constraints

Materialized view Implementations

Synonyms

Tables

Unique Key Constraints

Views


Optional, 10 characters
A unique alias for the materialized view name. Typically, you use the initial letters of words in the materialized view name to define the alias. For example, CUSTOMER_ADDRESSES would take the alias CA.

Examples of how this property is used:

•	to provide a default table alias when constructing views based on this materialized view

•	to provide a default usage alias when defining an application module. In turn, the table usage alias is used within the FROM clause of any generated SQL statements issued by the generated application


Optional, 132 characters
A default title that can be used by the application generator products to label the part of the application that is based on this materialized view. For example, generated forms show block titles, Visual Basic applications show captions and generated reports show group titles.
This default value can be modified when application module usages are defined for the materialized view.


 Indicates whether the materialized view can be updated, that is, whether INSERT, UPDATE and DELETE statements can be performed on the materialized view. Only simple materialized views can be updated.
Default: No


 Optional
The name of the cluster in which the materialized view exists. It is useful to place a materialized view on a cluster if the same grouping of columns are frequently selected from a table or tables.


 Indicates that tables on which the materialized view is to be based are defined using a free format SELECT statement. This enables complex queries to be defined; for example, queries that contain group functions and nested statements. If you set this property to Yes, you can enter the SELECT statement in the Select Text property.

By default this property is set to No. This is because for all but the most complex queries, you should specify the base tables using the Relations Based On elements.

Caution:	If you change the value of this property from Yes to No, you will lose any text that you have entered in the Select Text property.


Optional
The SELECT statement that specifies the base tables and columns from which the materialized view is derived. For example, enter the SELECT statement, omitting the keyword SELECT.

DNAME, MIN(SAL), MAX(SAL), AVG(SAL)FROM EMP, DEPT

The SELECT keyword is generated automatically by the Server Generator. This property can be edited only if the Free Format Select Text property is set to Yes.

Note: A free-format query is not maintained by the repository if changes are made to the underlying base tables.


Optional
A hint clause to be used by the optimizer for optimizing where the materialized view is defined declaratively. The optimizer uses the hint to choose an execution statement plan for the SQL statement.


Optional
A restriction or join condition for the materialized view, specified in a WHERE clause. This clause defines a condition on the SELECT statement that must be met in order for rows resulting from the query to be returned.

Example of a SELECT statement with a qualifying WHERE clause:

SELECT ename, job, dept.deptno, dname
FROM emp, dept
WHERE emp.deptno = dept.deptno

Tip:	The word WHERE can optionally be omitted from the start of the clause.


Optional
Default help text or end-user text to be displayed by generated applications.


Materialized view Implementations

What do you need help with?

About materialized view implementations

Materialized view implementation definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About materialized view implementations

A materialized view implementation is a repository object definition that records implementation specific information for a materialized view definition, i.e., how the materialized view will be implemented on a database for a user. For example, materialized view implementations record storage details, such as, the name of the tablespace in which the materialized view will be created.

Materialized view implementations also record details for refreshing a materialized view. Materialized views can be refreshed by means of a materialized view log. A materialized view log is a table associated with the base table. The materialized view log is used to locate the rows that have been updated in the base table, so that the updated rows can be applied to the materialized view in order to refresh it.

There are three types of refresh statement that can be specified in a materialized view implementation, these are defined by the Refresh Type property. When a fast or force refresh is specified, a materialized view log is created on the same database as the base table.

In the following illustration, a materialized view has been taken of a base table that resides on a remote database.

A materialized view log has been created on the remote database, to log updates made to the base table. At predetermined optional intervals, that are specified in the materialized view definition, the appropriate rows in the materialized view log are applied to the materialized view in order to update it.

--------------------------------------------------------------------------------------------------

Materialized view Implementation definition properties

Owning Container

Database

Database User

Materialized view

Version

Complete ?

Scope

Global Synonym Name

Scope

Storage

Tablespace

Storage Definition

Init Trans

Max Trans

Percent Free

Percent Used

Cached

Refresh

Refresh Start Time

Refresh Type

Next Refresh Clause

Materialized view Group

Build Type

Optimization

Query Rewrite ?

Documentation

Implementation Description

Implementation Notes

Non-Oracle Storage

Related Topics

Databases

Database Users

Materialized views


Specifies whether the blocks retrieved for this materialized view are placed at the most recently used end of the Last Recently Used (LRU) list. When set to Not Cached, retrieved blocks are placed at the least recently used end of the LRU. Placing the data at the most recently used end of the LRU, rather than the least recently used end can improve performance. It is useful to set this property to Cached for small lookup tables.


Display only
The name of the materialized view for which the implementation details are being specified.


Optional
The name of a set of storage parameters that define future space allocation for the materialized view in the database.


The name of the tablespace where the materialized view will be created.

Note: If no tablespace name is specified, the Server Generator will create the materialized view in the user's default tablespace.


Optional, 3 digits
The initial number of transaction entries that are allocated within each block of the materialized view.


Optional, 3 digits
The maximum number of transaction entries that may update a data block.


Optional, 3 digits
A set amount of room in every block that is allocated to the materialized view for future updates to the data of the materialized view.


Optional, 3 digits
The minimum level of space usage that Oracle maintains for each block.


Optional, 120 characters
The first automatic refresh date. The date expression must evaluate to a future point in time.


Optional, 8 characters
The refresh type for the materialized view. The options are:

<Null>	The most suitable option is used at refresh time, i.e. Force.
Complete	Existing data in the materialized view is entirely replaced. No materialized view log is created.
Fast	The materialized view is updated only with the changes to the table, using the materialized view log. Fast is only possible if certain conditions are met.
Force	Oracle chooses between a fast or complete at refresh time. Fast is chosen if all conditions are met, otherwise a complete refresh is performed.


Optional, 240 characters
The date on which the materialized view will be refreshed relative to the last refresh.


The scope of visibility of the database object. This is used by the Server Generator to determine when database links and synonyms need to be created.

Valid Values: Database, World
Default: Database


Optional, 30 characters
The name to be used by Server Generator when creating synonyms for this object.


Optional
The name of a set of materialized views on the same database (but not necessarily in the same schema on that database) that are to be refreshed at the same time and at the same interval.


Optional
Identifies whether the materialized view is to be populated immediately after executing the DDL, or whether it is to be deferred.

Valid values: Null, Immediate, Deferred


Optional
Identifies whether the materialized view is eligible to be used for query rewrite.

Valid values: Null, Disabled, Enabled


Optional
Any additional storage parameters for databases that are not Oracle databases.


Non-Persistent Queues

About non-persistent queues

A non-persistent Oracle queue is a repository for messages, only allowing the sending of messages to subscribers and explicitly specified recipients who are local.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Non-Persistent queue definition properties

Owning Container

Name

Version

Multiple Consumers ?

Documentation

Comment

Description

Notes

User Help Text

Related Topics

Non-Persistent Queue Implementations

Queue Subscribers

Persistent Queues


Mandatory
Indicates whether the queue is to be used by a single consumer, or multiple consumers.

No	Queues created in the table can only have one consumer per message. This is the default.
Yes	Queues created in the table can have multiple consumers per message.
Default Behavior	The database default is used.
Note: 	Non-persistent queues do not inherit this characteristic from a queue table.

Default: Default Behavior


Non-Persistent Queue Implementations
Non Persistent Queue Implementations

About non-persistent queue implementations

The implementation of a non-persistent queue in an Oracle database.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Non-persistent queue implementation definition properties

Owning Container

Database

Non Persistent Queue

Complete?

Documentation

Implementation Description

Implementation Notes

Related Topics

Non-Persistent Queues

Queue Subscribers

Persistent Queues


Display only
The name of the non-persistent queue definition for which the implementation details are being specified. This property is set automatically when defining the implementation.


Other Databases

About other databases

This type of repository definition defines a database that is not an Oracle database. The information recorded in this element can be used by the Server Generator to produce CREATE DATABASE statements for databases that are not Oracle databases.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Other Database definition properties

Owning Container

Name

Version

Local Name

Non-Oracle Database Type

Complete ?

Node

Connection

TNS Alias

Connect String

Documentation

Comment

Description

Notes

Related Topics

Database User Roles

Database Users


Mandatory
Indicates which type of database (other than Oracle databases) this element represents. Note, this element is mandatory when the element is created, but cannot be updated.


Oracle Collection Types

About Oracle collection types

Oracle collection types are used to define datatypes. They provide support for collections of similar items, and can be implemented as either of the following:

•	Nested tables - These are useful where referential integrity is required and are suited to master-detail and one-to-many relationships. Nested tables can have attributes but no methods.

•	VARRAYs - These are useful for providing quick access to small or uniform-sized collections of objects in a table. VARRAYs do not have methods or attributes.

An example of when you could use a collection type is for managing orders and their associated order lines. The orders would be stored in a top-level outer table, while the order lines could be stored in a nested table or VARRAY. The nested table or VARRAY is recorded as a column (on a relational table) or an attribute (on an object relational table) on the outer table. This column/attribute embeds the collection type within the outer table and is designed to hold the order lines for each order.

Typically nested tables are used when there is no limit on the potential number of items to be stored. Conversely, VARRAYs always have a maximum number of elements, that is defined by the user.

Nested tables and VARRAYs cannot be referenced directly, but they can be referenced indirectly via the outer table.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Oracle collection type definition properties

Owning Container

Name

Version

Collection Type

VARRAY Limit

Collection of

Scalar Collection

Scalar Datatype

Scalar Maximum Length

Scalar Decimal Places

Object Collection

Object Datatype

REF ?

Documentation

Comment

Description

Notes


 Indicates whether the collection contains scalars or objects.

Default: Scalar


 Identifies the collection type, i.e. VARRAY or nested table.


 Mandatory, 30 characters
The name by which the Oracle type is identified.


 Optional, 2000 characters
A comment about the Oracle type.


If this is a collection of objects, this identifies whether this is a collection of REFs.

Default: No


Identifies the Oracle object type on which the collection is based.

Note:  For object collections this property is mandatory.


Identifies the datatype of elements in the collection, e.g. NUMBER, DATE, CLOB. This property is applicable only if the collection contains scalars.

Note:  For scalar collections this property is mandatory.


Optional, 4 digits
Identifies the number of decimal places on elements in the collection. This property is applicable only if the collection contains scalars.


Optional, 5 digits
Identifies the maximum length of elements in the collection. This property is applicable only if the collection contains scalars.


Optional, 6 digits
The size of the VARRAY, which must be specified when the collection type is VARRAY.


Oracle Databases

About Oracle databases

Defines an Oracle database definition in the repository. The information recorded in this element can be used by the Server Generator to produce CREATE DATABASE statements.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Database definition properties

Owning Container

Name

Version

Local Name

Oracle Version

Character Set

Complete ?

Node

Connection

TNS Alias

Connect String

Instances

Shared ?

Max Instances

Datafiles

Reuse Control File

Max Data Files

Logfiles

Archive Redo Files

Max Log files

Max Log History

Max Log Members

Documentation

Comment

Description

Notes

Related Topics

Database User Roles

Database Users


Mandatory
The version of the Oracle database server to be used when the database is created.


Optional, 40 characters
The character set that the database uses to store data. The character set cannot be changed after the database has been generated.


Indicates whether this Oracle database should reuse existing control files. When a control file is reused, any information that it already contains is ignored and overwritten.

Default: No


Indicates that multiple instances can access this database. This applies only at startup; uncheck the box if only one instance can access this Oracle database.

Default: Yes


Indicates whether a redo log file can be archived before reuse, thus preparing for the possibility of the media recovery as well as instance recovery. By default a redo log file can be reused without archiving its contents. The file can then be used for only instance recovery.

Default: No


Optional, 6 digits
The maximum number of redo log files that can ever be created for this Oracle database. This number sets the absolute limit, taking precedence over the INIT.ORA parameter LOG_FILES. The number defined here cannot be increased, except by re-creating the database.

The valid range is:

Minimum	2
Maximum	999999

The overhead incurred by entering a higher number is negligible, it affects only the size of the control file.

Note: You should check which values are valid for your operating system.


Optional, 6 digits
The maximum number of database files that can ever be created for this database. This number sets the absolute limit, taking precedence over the INIT.ORA parameter DB_FILES. The number defined here cannot be increased, except by re-creating the database.

The valid range is:

Minimum	1
Maximum	99999

The overhead gained by entering a higher number is negligible, affecting only the size of the control file.

Note: You should check which values are valid for your operating system.


Optional, 3 digits
The maximum number of instances that can ever simultaneously mount and open this Oracle database. This number sets the absolute limit, taking precedence over the INIT.ORA parameter INSTANCES.

The valid range is:

Minimum	1
Maximum	255

Note: You should check which values are valid for your operating system.


Optional, 6 digits
Maximum number of archived redo log files for automatic media recovery of Oracle databases with the Parallel Server option. Used to determine how much space in the control file to allocate for names of archived redo log files

Minimum	0
Maximum	Operating system specific

Note: You should check which values are valid for your operating system.


Optional, 6 digits
Maximum number of members, or copies, for a redo log file group. Used to determine how much space in the control file to allocate for the names of redo log files

The valid range is:

Minimum	1
Maximum	Operating system specific

Note: You should check which values are valid for your operating system.


Oracle Object Types

What do you need help with?

About Oracle object types

Oracle object type definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About object type definitions

Oracle object types provide a way of creating user-defined datatypes. These datatypes can be used in addition to the built-in datatypes provided by the server.

Note:	Oracle object types are also called user-defined types.

Some of the ways in which Oracle object types can be used are listed below:

•	to define a datatype of a column in a relational table

•	to create a table based on a specific Oracle object type, i.e. an object table

•	as part of the definition of another Oracle object type, i.e. as an attribute of the new Oracle object type

Oracle object types can be considered as templates for creating instances of objects. Typically, the objects have a set of common attributes and methods (operations), and may be structured in a hierarchy.

Oracle object type definition properties

Owning Container

Name

Version

Documentation

Comment

Description

Notes


Partition Key Entries

About partition key entries

A partition key entry defines the usage of a particular column in the partition key of a table or an index. Each partition key entry can be based on one column only. Partition key entries are stored against table implementations or index storages in the repository. They can be created for global index storage definitions, but not local index storage definitions.

When the definition has been recorded in the repository, the partition key entry can then be created on the database using the Server Generator.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Partition Key Entry properties

Owning Container

*Index

Table

Column

Version

Sequence_in Key

*For indexes only

Related Topics

Index Storages

Table Implementations


Mandatory
The name of the column that is used by the partition key.


Mandatory
The name of the index storage definition for which the partition key entry is defined.


Mandatory, 6 digits
The sequence of the column in the partition key of the table or index.


Mandatory
The name of the table implementation for which the partition key is defined.


Persistent Queues

About persistent queues

A persistent Oracle queue is a repository for messages, stored in the database in a queue table.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Persistent queue definition properties

Owning Container

Name

Version

Queue Table

Queue Type

Auto Commit ?

Max Retries

Retry Delay

Retention Time

Unlimited Retention Time ?

Documentation

Comment

Description

Notes

User Help Text

Related Topics

Persistent Queues

Queue Tables

Queue Subscribers

Non-Persistent Queues

Non-Persistent Queue Implementations


Optional
Indicates the queue table used to store this persistent queue.

Note:	Persistent queues must be assigned to a queue table for generation to take place.


Optional
Indicates whether the persistent queue is a normal queue, or an exception queue.

Normal:	The queue is a normal queue. This is the default.
Exception:	It is an exception queue. Only the dequeue operation is allowed on an exception queue.
<Null>	If this property is set to <Null>, it is generated using the database default which is 'Normal'.


Mandatory
Indicates whether or not messages are committed automatically. If set to ‘Default Behavior’,

Yes	Messages are committed automatically
No	An extra COMMIT statement is generated after the slash of the PL/SQL block.
Default Behavior	The database default is used.
Default: Default Behavior


Optional
Specifies the maximum number of times a dequeue with the REMOVE mode can be attempted.

Note: This property is not applicable if this queue is defined:

−	as an exception queue, i.e. the Queue Type property is set to ‘Exception’

−	or, if it is to be stored in a queue table that is defined with Multiple Consumers? set to Yes and Compatible Database Version set to 8.0


Optional
Specifies the delay (in seconds) before messages are processed again, after rollback.

If no value is defined, the default behavior is to retry the message as soon as possible. This property has no effect if the Max Retries property is set to 0.

Note:	This property is not applicable if this queue is defined:

−	as an exception queue, i.e. the Queue Type property is set to ‘Exception’

−	or, if it is to be stored in a queue table that is defined with Multiple Consumers? set to Yes and Compatible Database Version set to 8.0


Optional
Specifies the number of seconds a message is retained in the queue table after being dequeued from the queue.

If no value is defined, the default behavior is not to retain messages.

Note:	This property is not applicable if the queue is defined as an exception queue, i.e. the Queue Type property is set to ‘Exception’.


Mandatory
Indicates whether the retention time is unlimited, i.e. that messages are to be retained forever.

Note:	This property is not applicable if the queue is defined as an exception queue, i.e. the Queue Type property is set to ‘Exception’.

Default: No


Persistent Queue Implementations

About persistent queue implementations

The implementation of a persistent queue in an Oracle database.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Persistent queue implementation definition properties

Owning Container

Database

Persistent Queue

Complete?

Queue Table Database User

Max Retries

Retry Delay

Retention Time

Unlimited Retention Time ?

Documentation

Implementation Description

Implementation Notes

Related Topics

Non-Persistent Queue Implementations

Queue Tables

Queue Table Implementations

Queue Subscribers


Display only
The name of the persistent queue definition for which the implementation details are being specified. This property is set automatically when defining the implementation.


Mandatory
The database user containing the queue table where this persistent queue implementation is to be stored.


Optional
Specifies the maximum number of times a dequeue with REMOVE mode can be attempted.

If left blank, the value from the source persistent queue definition is used during generation.

Note:	This property is not applicable if the source queue is defined:

−	as an exception queue, i.e. the Queue Type property is set to ‘Exception’

−	or, if it is to be stored in a queue table that is defined with Multiple Consumers? set to Yes and Compatible Database Version set to 8.0


Optional
Specifies the delay (in seconds) before messages are processed again, after rollback.

If left blank, the value from the source persistent queue definition is used during generation.

Note:	This property is not applicable if the source queue is defined:

−	as an exception queue, i.e. the Queue Type property is set to ‘Exception’

−	or, if it is to be stored in a queue table that is defined with Multiple Consumers? set to Yes and Compatible Database Version set to 8.0


Optional
Specifies the number of seconds a message is retained in the queue table after being dequeued from the queue.

If left blank, the value from the source persistent queue definition is used during generation.

Note:	This property is not applicable if the source queue is an exception queue, i.e. it's Queue Type property is set to ‘Exception’.


Mandatory
Indicates whether the retention time is unlimited.

Note:	This property is not applicable if the queue is defined as an exception queue, i.e. the Queue Type property is set to ‘Exception’.

Default: No


PL/SQL Definitions

What do you need help with?

About PL/SQL definitions

PL/SQL definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About PL/SQL Definitions

PL/SQL definitions are used to specify PL/SQL code in the repository. You can define and maintain this program code for the PL/SQL development environment, using a set of PL/SQL definition types. PL/SQL definitions are also used to define call specs which publish Java methods on the database (often referred to as Java stubs).

Note:	PL/SQL definitions of type function and procedure are also used to store Oracle object type methods in the repository.

The available PL/SQL types and their purposes are described below.

Definition Type	Description
FUNCTION	Defines a function in the repository. Each function must have a return type, which is generated in the script that is output by the Server Generator. Functions and procedures are collectively referred to as subprograms.
PROCEDURE	Defines stored procedures in the repository, which are used to perform a specific task in the database. Procedures are similar in structure to functions, except that no return type is required. Functions and procedures are collectively referred to as subprograms.
PACKAGE	Defines a package in the repository. A package can call other functions, procedures, triggers and cursors.
TRIG_LOGIC	Defines the statements to be executed when a database trigger is fired.
CURSOR	Defines a cursor in the repository.
UNDEFINED PL/SQL	Defines PL/SQL that is not stored as a function, package, procedure, trigger or cursor.

Having defined code in a definition, Server Generator can be used to generate CREATE OR REPLACE statements and the program code, that can be used to implement the PL/SQL definition in the server.

PL/SQL implementations record in the repository whether a PL/SQL definition is part of a replication group. This information is specified using the Replication Group property. If a PL/SQL implementation is part of a replication group, that group can be used to replicate the PL/SQL definition on a different database. You can record which databases are to use replication groups in the repository. The Server Generator can use this information during generation.

--------------------------------------------------------------------------------------------------

PL/SQL definition properties

Owning Container

Short Name

Version

Name

Purpose

Type

Implementation Name

Scope

Member

Type Member Ordering

Planning

Status

Candidate ?

Size

Complexity

Project

Activity

Task

Time Estimate

Estimate Units

Invocation

Top Level ?

Deterministic ?

Return Type

Return Type (Scalar)

Return Type (Object)

Restrict References

WNDS ?

WNPS ?

RNDS ?

RNPS ?

Declaration

Free Format Declaration ?

Source Path

PL/SQL

PL/SQL Block

Package Specification

Private Declaration

Java

Java Class Definition

Java Method

Java Parameter List

Java Return Type

Documentation:

Release Notes

Description

Notes


Optional, 30 characters
The name assigned to the PL/SQL code that is generated from this definition by the Server Generator. If this property is left empty, the Server Generator uses the Short Name property value.

Note:	For functions and procedures that are included in packages, the name entered in this property does NOT have to be unique. This is because procedures and functions can be overloaded (e.g. with different arguments) if they exist within a package.


 Optional
Identifies the Oracle object type for which a type body is implemented by this PL/SQL definition.


Optional
The datatype of the value returned by the member function. For example, the type may be an Oracle object type.


The type of definition that is to be recorded in the repository:

- Cursor
- Function
- Package
- Procedure
- Trig-Logic

Note:	If you are creating an Oracle object type method you must set this property to Function or Procedure.


Mandatory
Determines whether other objects have access to this PL/SQL. The options are:

Private
Public

Default: Private

Note: Oracle object type methods are, by definition always ‘public’. Hence the Scope property is ignored when generating methods for Oracle object types.


Optional, 70 characters
The datatype of the value returned by a function. For example, Boolean, Date, Decimal, Integer.


Identifies whether the Reads No Database State constraint is required, i.e., does not query database tables.
Valid values: Yes, No, Default Behavior

Default: Default Behavior


Identifies whether Reads No Package State constraint is required, i.e., does not query package variables.
Valid values: Yes, No, Default Behavior

Default: Default Behavior


Indicates whether or not the PL/SQL definition contains free format text.
If set to Yes, the declaration section in the PL/SQL definition is to be free format text (i.e., entered using the Private Declaration and PL/SQL Block properties).

If set to No, the Server Generator constructs the declaration section from code defined within the Private Declaration property and associated repository definitions (i.e. Program Data, Datastructure and Sub Program Unit definitions).

Default: No


Optional
For PL/SQL packages, this defines initialization code for the package. It can also contain private declarations that are to be generated just before the initialization code, i.e. at the end of the package body. Other private declarations should be entered using the private declaration property.

For functions, procedures, triggers and cursors, this defines the PL/SQL body. BEGIN and END statements are required at the beginning and the end of the PL/SQL Block.

If BEGIN and END statements are omitted from the PL/SQL body and the ‘Use Parsing Technology in order to Add Begin/End (PARSER) preference’ is set to Yes, Server Generator can add the statements during generation.

Note:	Private declaration, i.e. any private subprograms, cursors, variables, constants and user-defined datatypes can be entered separately using the Private Declaration property. Alternatively, private declaration may be entered at the top of the PL/SQL Block.


Optional
Declares public functions, procedures, cursors, variables, constants and user-defined datatypes that can be accessed by subprograms and triggers outside the package. This property is relevant to PL/SQL packages only.

If the package is defined as 'free format', public function and procedure declarations are added to the package specification during generation. You do not need to specify these yourself.

Note:	Omit the CREATE PACKAGE statement as this is added automatically during generation.


Optional
Defines private declarations. For example, private functions, procedures, cursors, variables, constants and user-defined datatypes that cannot be accessed outside the package, function, procedure or trigger.

Note: For triggers, an additional DECLARE statement is required. If omitted, Server Generator adds the statement during generation.


Optional, 132 characters
The full name of the file that contains the source code for the PL/SQL definition.


Optional
Indicates whether the object type body defined by this PL/SQL definition has a Map or an Order member function. The Map and Order functions are used to compare and order object types. If no Map or Order function exists the object type can be tested for equality and inequality only.


Identifies whether Writes No Database State constraint is required, i.e., does not modify database tables.
Valid values: Yes, No, Default Behavior

Default: Default Behavior


Identifies whether Writes No Package State constraint is required, i.e., does not modify packaged variables.
Valid values: Yes, No, Default Behavior

Default: Default Behavior


Allows the system to use a saved copy of the function’s return result (if such a copy is available). The saved copy could come from a materialized view, a function-based index, or a redundant call to the same function in the same SQL statement. The query optimizer can choose whether to use the saved copy or re-call the function. The function should reliably return the same result value whenever it is called with the same values for its arguments. Therefore, do not define the function to use package variables or to access the database in any way that might affect the function’s return result, because the results of doing so will not be captured if the system chooses not to call the function.


Optional
Identifies the repository-held Java definition which contains the Java method that this call spec is to publish.

If the Java object is not defined in the repository (but will exist on the database) leave this field blank. Instead, fully qualify the name of Java method within the Java Method property (below).


Optional, 4000 characters
The exact name of the Java method this call spec is to publish.

If the Java Definition property (above) is specified, ensure that the name entered here identifies a method within this Java object.

If the Java Class Definition property is left blank, ensure that the name entered here fully qualifies the method, i.e. also specifies the Java object within which it exists.


Optional, 4000 characters
Lists the parameters of the Java method. Separate each one with a comma.

Parameters are mapped to PL/SQL arguments by their position in the list and must correspond one to one.


Optional, 4000 characters
The return type of the Java method.


About PL/SQL functions

A function is a named program unit that takes parameters and returns a computed value. A function consists of two parts:

•	a header

•	a body

The header begins with the FUNCTION keyword and ends with the RETURN clause, which specifies the datatype of the value returned. Arguments can be declared for the function, but are optional.

The function body begins with the IS keyword and ends with the keyword END, followed by an optional function name. The function body can consist of three parts:

•	a declarative section (optional)

•	an executable section (mandatory)

•	an exceptions section (optional)

For example:

header	FUNCTION balance (acct_id INTEGER) RETURN REAL
body	IS
private declarations	acct_bal REAL;	- Private Declaration property
	BEGIN
executables	/* executable statements  */	- PL/SQL Block property
exceptions	EXCEPTIONS /* exception handlers */	- PL/SQL Block property
	END;


About PL/SQL procedures

A procedure is a named PL/SQL block that can take parameters and be invoked. Procedures are used to perform specific actions. A procedure consists of two parts:

•	a header

•	a body

The header begins with the PROCEDURE keyword and ends with a procedure name and an optional parameter list. Procedures that do not define parameters do not require parentheses.

The procedure body begins with the IS keyword and ends with the keyword END, followed by an optional procedure name. The procedure body can consist of three parts:

•	a declarative section (optional)

•	an executable section (mandatory)

•	an exceptions section (optional)

For example:

header	PROCEDURE create_dept (new_dname CHAR, new_loc CHAR)
body	IS
private declarations	DECLARE  /* variables, constants, cursors */	- Private Declaration property
	BEGIN	- PL/SQL Block property
executables exceptions	/* executable statements  */      EXCEPTIONS /* exception handlers */ END;	- PL/SQL Block property


PL/SQL Packages
About PL/SQL packages

A package groups together related procedures, functions and cursors. The package, when it has been compiled, is stored in the Data Dictionary so that it can be accessed, like a library unit, by multiple applications. The package itself cannot be called, or have parameters passed to it; rather, the subprograms within it are referenced from other subprograms and from database triggers outside the package.

Packages provide a way of modularizing your application design, and enable you to hide implementation details stored within the package from other users.

A package is defined in the repository using a PL/SQL definition of type PACKAGE, and is made up of two parts:

•	package specification,

•	package body,

The package specification and the package body are created using the CREATE PACKAGE and the CREATE PACKAGE BODY commands respectively. When you define a package in the repository, these CREATE statements can be generated automatically using the Server Generator.

Package specifications

The package specification lists the package resources that are available to the application. The contents of the package specification must therefore be public; that is, the subprograms, cursors, variables, constants and user-defined datatypes within the specification can be accessed by subprograms and triggers outside the package.

The package specification can be compiled without the package body, which can be coded at a later stage in the development when you are ready to complete the application. If the specification declares only types, constants, variables and exceptions, the package body is unnecessary, because no implementation details are required.

Example of a package specification

Package bodies

The package body contains the implementation details of subprograms and cursors listed in the package specification. These subprograms and cursors become public to the application.

The package body can also include subprograms and cursors that are private; that is, that are internal to the package. This enables you to prevent specific programs from being accessed outside the package. Private subprograms and cursors are omitted from the package specification.

You should also define, in the package body, any variables, constants and types required by the subprograms that are internal to the package, i.e. Private Declarations.

The package body can optionally contain initialization code.

Example of a package body


Example of a package specification

/*  Package specification  */
CREATE PACKAGE emp_actions AS
   /*  Declare externally visible types, cursors, exceptions  */
   TYPE EmpRecTyp IS RECORD (emp_id, INTEGER, salary REAL);
   CURSOR desc_salary (emp_id NUMBER) RETURN EmpRecTyp;
   /*  Declare subprograms that can be called externally   */
   PROCEDURE hire_employee
      (ename CHAR,
       job CHAR,
       mgr NUMBER,
       sal NUMBER,
       comm NUMBER,
       deptno NUMBER);
   PROCEDURE fire_employee (emp_id NUMBER);
END emp_actions;


Example of a package body

/*  Package body  */
CREATE PACKAGE BODY emp_actions AS
   /*  Declare cursors listed in the package specification  */
   CURSOR desc_salary (emp_id NUMBER) RETURN EmpRecTyp IS
      SELECT empno, sal FROM emp ORDER BY sal DESC;
       ...
   /*  Define public and private subprograms  */
   PROCEDURE hire_employee
      (ename CHAR,
       job CHAR,
       mgr NUMBER,
       sal NUMBER,
       comm NUMBER,
       deptno NUMBER) IS
   BEGIN
      INSERT INTO emp VALUES (empno_seq.NEXVAL, ename, job,
            mgr, SYSDATE, sal, comm, deptno);
   END hire_employee;
   ...
   PROCEDURE fire_employee (emp_id NUMBER) IS
   BEGIN
      DELETE FROM emp WHERE empno = emp_id;
   END fire_employee;
END emp_actions;


About trigger logic

Trigger logic defines the action that is to be performed when a database trigger is executed. These actions are recorded in the repository using a PL/SQL definition of the type TRIG_LOGIC.

The PL/SQL definition of the type TRIG_LOGIC is used to define the trigger action, which contains the statements to be executed when the trigger is fired. The trigger definition defines the triggering event; i.e. the INSERT, UPDATE or DELETE statement that causes the trigger to fire.

Note:	Server Generator generates the DECLARE statement for triggers if one is not defined.

For more information about triggers, see Database Triggers.


About cursors

Oracle uses work areas called private SQL areas to execute SQL statements and to store processing information. A construct called a cursor enables you to name a private SQL area and access its stored information.

There are two types of cursor:

•	implicit. PL/SQL implicitly declares a cursor for all SQL data manipulation statements, including queries that return only one row.

•	explicit. An explicit cursor can be defined for queries that return more than one row, so that the rows can be processed individually.

An explicit cursor is declared in the declarative section of a PL/SQL block.

For example:

DECLARE
   CURSOR c1 IS
        SELECT empno, ename, job FROM emp
        WHERE deptno = 20;
        /*  statements  */


Type Body
Type Body - PL/SQL Definition Type

For internal use only.


PL/SQL definition implementations

About PL/SQL definition implementations

A PL/SQL implementation is a repository definition that records the information that is required by the Server Generator to implement a specific PL/SQL definition on a database. If PL/SQL definition implementation details are not specifically recorded in the repository for a PL/SQL definition, i.e. a PL/SQL definition implementation is not created, the Server Generator uses the default implementation settings to create a PL/SQL definition on a database.

When the PL/SQL definition implementation has been recorded in the repository, it can be used by the Server Generator when creating the associated PL/SQL definition on a database.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

PL/SQL definition implementation properties

Owning Container

Database

Database User

PL/SQL

Version

Complete ?

Scope

Global_Synonym_Name

Scope

Replication

Replication_Group

Documentation

Implementation Description

Implementation Notes

Related Topics

Database Users

PL/SQL Definitions


Optional, 30 characters
The name to be used by Server Generator when creating synonyms for this object.


Mandatory
The name of the PL/SQL definition for which implementation details are being specified.


Optional,
The name of the replication group to which the PL/SQL definition belongs.


The scope of visibility of the database object. This is used by the Server Generator to determine when database links and synonyms need to be created.

Valid Values: Database, World
Default: Database


Primary Keys

What do you need help with?

About primary keys

Primary key definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About primary keys

Each database table can have a single primary key constraint. The primary key constraint is used to identify or to reference the rows of a table using the values in the primary key constraint.

Note:	For this release, primary key constraints cannot be recorded in the repository for object tables and object views.

A primary key constraint provides a means of ensuring that no duplicate values can be entered for a specified column or set of columns. Primary key columns are always mandatory; that is, nulls are not permitted.

The column or set of columns specified as part of the constraint definition is known as the primary key. A primary key constraint should be defined for all the tables in the database, so that each row in a table can be uniquely identified, and so that no duplicate rows can be entered in the table.

On a Server Model Diagram, a primary key definition is denoted by the primary key indicator (#). A primary key definition can exist on a table without the primary key column having been specified. When specified, the column defined as the primary key is preceded by the primary key indicator #, as shown below.

Primary key columns are always mandatory, therefore the primary key column is also preceded by the mandatory symbol *.

Given the table EMP, you might define the EMPNO column as a primary key column, so that no duplicate employee numbers can be entered. By making EMPNO the primary key, an employee number would have to be entered for each new employee joining the company. No two rows in the table could be the same, since no duplicate employee numbers are allowed, therefore enabling each row in the table to be uniquely identified.

Some factors to consider when defining a primary key are:

•	Select columns for the primary key whose values are unlikely to change.

For example, defining the columns ENAME as the primary key of EMP would be an unsuitable choice, since the values for an employee name might change during the term of employment.

•	Select columns whose values cannot be null. Primary key columns are always mandatory. For composite primary keys, that consist of more than one column, ensure that a value can be entered for each column defined as part of the key.

•	Select columns for the key that can be used to uniquely identify the rows in the table.

For example, you might make the BOOKING_NUMBER column the primary key of the BOOKINGS table, since the booking number must be unique for each row in the table.

The primary key can optionally consist of more than one column, up to a maximum of 16 columns.

When the primary key definition has been entered into the repository, the primary key can then be implemented on the database using the Server Generator.

--------------------------------------------------------------------------------------------------

Primary key definition properties

Owning Container

Table

Name

Version

Complete ?

Enable?

Update ?

Validation

Validate In

Defer Status

Error Message

Exceptions Table

Source

Unique Identifier

Documentation

Description

Notes

Related Topics

Columns

Foreign Key Constraints

Key Components

Tables

Unique Key Constraints


Mandatory
The level at which the primary key constraint is to be enforced. The options are:

Client	The primary key will be enforced at application level only.
Server	The primary key will be enforced on the database only. This is the default value.
Both	The primary key will be enforced at application and database level.

Default: Both


Indicates whether this primary key constraint can be updated.

Default: No


Optional
Defines the Unique Identifier from which the primary key constraint is derived. This value can be populated by the Database Design Transformer or you can specify the value manually. To set this value manually, you must first create a mapping from the table definition to at least one entity definition. You can then choose the UID from one of these entities.


Program Data

About program data

Program data definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About program data

Defines program data constructs (variables, constants and user-defined exceptions) for PL/SQL definitions. These constructs are included in the DDL generated by the Server Generator.

PL/SQL definitions can store values in variables (scalar and composite) and constants, and raise error/warning messages where error conditions are encountered.

When you create program data in the repository, you choose how it is defined. The most simple way to define program data is by setting a datatype.

Instead of defining the same program data construct for several PL/SQL definitions you can share program data. Shared program data is where a program data construct is owned by a PL/SQL definition and is used by another PL/SQL definition, as the following example illustrates.

Package A	Package B		Procedure C
|	|		|
Program data (defined by domain) Scope : PRIVATE	Program data (defined by datastructure Scope : PUBLIC	------	Program data usage (based on program data defined for B)

A PL/SQL definition can share only program data constructs that have the Scope property set to PUBLIC. Only PL/SQL definitions of type package can have program data with Public scope.

Note:	For packages, procedures, functions and triggers (whose Free Format Declaration property is set to No), the Server Generator will use the PL/SQL definitions for constructing the DECLARE section in the PL/SQL block.

--------------------------------------------------------------------------------------------------

Program data definition properties

Owning Container

Module / PL/SQL

Name

Version

Construct Type

Scope

Usage Sequence

Read/Write

Read ?

Write ?

Defined By

Domain

Datastructure

Column

Table Definition

Oracle Type

Definition

Datatype

Length

Decimal Places

Default Value

Default Value Type

Optional ?

Delimiter

Exception

Oracle Error Code Number

Documentation

Comment

Data Construct Definition

Description

Notes

User Help Text


 Optional
Identifies the column definition that defines the program data. The datatype of program data that is defined using this property is declared using the %TYPE attribute.

For information about the %TYPE attribute, see the PL/SQL User's Guide and Reference Manual.


 Mandatory
The name of the definition for which the program data is defined.


 Mandatory, 30 characters
The full name of the program data construct being defined.


 Mandatory, 6 digits
The sequence number specifying the position of the program data constructs.


 Mandatory, 9 characters
The type of data construct. The options are:

Constant  (Default)
Exception
Variable


 Optional, 70 characters
The datatype of the program data constructs. This field is mandatory for Constant and Variable program data constructs where a domain or datastructure has not been specified.


 Optional, 6 digits
The maximum length of data that the program data construct can contain.


 Optional, 3 digits
The number of decimal places allowed for the program data construct. This field is applicable only for numeric program data constructs.


 Indicates that nulls are allowed in this program data construct (i.e., this program data construct is optional). When this property is No, this indicates that nulls are not allowed (i.e., the construct is mandatory).
Default: No


 Optional, 10 digits
Contains the Oracle error number to be used when program datum is an EXCEPTION_INIT pragma. Applies only when the Construct Type is set to Exception.


 Optional,
Identifies the Oracle Type that defines this program data construct.


 Optional, 60 characters
The default value for the program data construct. For Constant program data constructs, this field is mandatory.

Note: To specify whether the value entered is a literal string or a database function call, set the Default Value Type property.


 Mandatory
Indicates the nature of the default value, i.e. whether it is a literal value or a database function.

Default: Literal


 Optional, 70 characters
A delimiter to be used between data construct name and value


The scope of the program data construct. The options are:

Private (Default)
Public

With packages, program data with Public scope will be used to construct the package specification; program data with Private scope will be used to construct the data declarations in the package body. Only PL/SQL definitions of type package can have program data with Public scope.


 Optional, 240 characters
A comment or brief description about the use of this program data construct.


 Optional
The domain name for this program data construct, if applicable. When the domain name is entered, the datatype and length properties are entered from the domain definition.

Note: 	If the domain does not exist, the domain will be created on committing the program data construct record.


 Optional
The name of the datastructure for this program data construct.


 Optional
Identifies the table definition that defines the program data. If this property is set, the program data represents a row in a table. The record type of the row is declared using the %ROWTYPE attribute.

For information about the %ROWTYPE attribute, see the PL/SQL User's Guide and Reference Manual.


 Optional
Identifies the action to be taken when an exception occurs.


 Optional
Help text to be used for this program data construct.


 Display only
The name of the module that uses a program data construct that belongs to other modules.


 Display only
The name of a public program data construct that belongs to another module.


 Optional, 3 numbers
The sequence number specifying the position of the shared program data construct within the module.


 Indicates that the value of the shared program data construct is read.


 Indicates that a value is to be assigned to the shared program data construct.


Queues

About queues

There are two types of queues can be defined in the repository:

•	Persistent queues

•	Non persistent queues

Related Topics

Persistent Queue Implementations

Non-Persistent Queue Implementations

Queue Tables

Queue Subscribers


Mandatory, 30 characters
A unique name for the queue.

Note:	Restrict names of queues to 24 characters when generating to Oracle8.1, as this is the maximum length supported in Oracle8.1.


Optional, 2000 characters
A brief comment about this queue


Optional,
Default help text or end-user text to be displayed by generated applications.


Queue Implementations

About queue implementations

There are two types of queue implementation:

•	Persistent queue implementations

•	Non persistent queue implementations

Related Topics

Persistent Queues

Non-Persistent Queues

Queue Tables

Queue Subscribers


Mandatory
The name of the database on which the element will reside. This property is automatically set to the database definition in which the implementation is being defined.


Indicates whether the definition is complete, and ready for generation. When set to No, it is ignored by the Server Generator.

Default: Yes


Optional,
A multi-line text description of the element.


Optional,
Multi-line text notes about the element.


Queue Subscribers

About queue subscribers

A subscriber to the implementation of a persistent or non-persistent queue in an Oracle database.

Multiple subscribers (with different addresses) can be defined for a single queue implementation.

Note:	Subscribers are not defined for exception queues or single consumer queues.

Queue subscriber definition properties

Owning Container

Queue Implementation

Version

Name

Address

Protocol

Rule

Documentation

Description

Notes

User Help Text

Related Topics

Persistent Queues

Persistent Queue Implementations

Non-Persistent Queues


Mandatory
The name of the queue implementation associated with this subscriber.


Mandatory, 30 characters
Specifies the name of this queue subscriber.


Mandatory, 1024 characters
Specifies a protocol specific address for the subscriber.

To define a local subscriber a ‘null address’ is required.  In this case, enter the following literal string: null


Optional, 38 digits
Identifies which protocol is used to interpret the address and propagate the message.

Note:	This property is reserved for future use. It is not currently used by the database.


Optional, 4000 characters
Specifies a conditional expression based on the message properties, message data properties and PL/SQL functions.

A rule is specified as a boolean expression using syntax similar to the WHERE clause of a SQL query. This boolean expression can include conditions on message properties, user data properties (object payloads only) and PL/SQL or SQL functions (as specified in the where clause of a SQL query).

Currently supported message properties are priority and corrid. To specify rules on a message payload (object payload), use attributes of the Oracle object type in clauses. You must prefix each attribute with tab.user_data as a qualifier to indicate the specific column of the queue table that stores the payload.

The rule parameter cannot exceed 4000 characters.


Optional,
Default help text or end-user text to be displayed by generated applications.


Queue Tables
Queue Table Definitions

About queue table definitions

A queue table is a database table, based on an Oracle object type or a scalar type, that can contain one or more persistent queues.

Queue table definition properties

Owning Container

Name

Version

Oracle Type

Scalar Datatype

Sort List

Multiple Consumers?

Message Grouping

Auto Commit ?

Primary Instance

Secondary Instance

Compatible Database Version

Documentation

Comment

Description

Notes

User Help Text

Related Topics

Persistent Queues

Persistent Queue Implementations

Queue Subscribers


Mandatory, 30 characters
Specifies the name of this queue table. The name must be unique within all queues, queue tables and queue subscribers.

Note: Restrict names of queues to 24 characters when generating to Oracle8.1, as this is the maximum length supported in Oracle8.1.


Optional
Identifies the Oracle object type on which the queue table is to be based.

Note that queue tables can be based on Oracle object types only. An Oracle collection type must not be specified here.


Optional
Specifies a scalar datatype for this queue table, if it is not defined via an Oracle object type. The only valid datatype for Oracle queue tables is RAW. Any other datatype has to be defined via an Oracle object Type.


Optional
Identifies which of the queue table’s internal columns are to be used when sorting (in ascending order). The names of these internal columns are ENQ_TIME and PRIORITY, hence their specification here as valid sort values.

If no sort list is specified all the queues in this queue table will be sorted by the enqueue time in ascending order.  This order is equivalent to FIFO order.

Once a queue table is created with a specific ordering mechanism, all queues in the queue table inherit the same defaults. The sort order of a queue table cannot be altered once the queue table has been created on the database.

Valid values:	ENQ_TIME ENQ_TIME, PRIORITY PRIORITY  PRIORITY, ENQ_TIME


Mandatory
Indicates whether queues created in this table will be used by a single consumer or multiple consumers. If set to ‘Default Behavior’, the database default is used. Valid values are Yes, No and Default Behavior.

Default: Default Behavior


Optional
Message grouping behavior for queues created in this queue table.

None:	Each message is treated individually.
Transactional:	Messages enqueued as part of one transaction are considered part of the same group and can be dequeued as a group of related messages.


Mandatory
Indicates whether messages are to be committed automatically. If set to ‘Default Behavior’, the database default is used. Valid values are Yes, No and Default Behavior.

If set to No, a COMMIT statement is added after the slash of the PL/SQL block during DDL generation.

Default: Default Behavior


Optional, 38 digits
Applicable to OPS environments only. The primary instance (or owner) in which queue monitor scheduling and propagation for the queues in the queue table will take place.

If no value is defined, the default primary instance used is 0. This means that queue monitor scheduling and propagation will be done in any available instance.


Optional, 38 digits
Applicable to OPS environments only. The secondary instance (or owner) to be used if the primary instance is not available.

If no value is defined, the default secondary instance used is 0. This means that the queue-table will use any available instance.


Optional, 10 characters
The lowest version of the database that this queue table is compatible with. For example, the current possible values are '8.0' or '8.1'.


Optional, 2000 characters
A brief comment about this queue table.


Optional
Default help text or end-user text to be displayed by generated applications.


Queue Table Implementations

About queue table implementations

The implementation of a queue table in a specific database user.

A queue table implementation records implementation specific information for a queue table definition, i.e., how a queue table will be implemented on a database for a particular user.

Queue table implementation definition properties

Owning Container

Database

Database User

Queue Table

Version

Complete ?

Database User of Oracle Type

Storage

Storage Definition

Tablespace

Init Trans

Max Trans

Percent Free

Percent Used

Documentation

Implementation Description

Implementation Notes

Related Topics

Queue Tables

Persistent Queues

Queue Subscribers


Display only
The name of the queue table definition for which the implementation details are being specified.


Optional
The database user in which the Oracle object type will be implemented, i.e. the Oracle object type on which the queue table is based.

Note: This property is not applicable to scalar queue tables.


Optional
The name of a set of storage parameters used to define future space allocation for the table in the database.


Optional
The name of the tablespace in which the queue table will be created. If no tablespace is specified, the table will be created in the user's default tablespace.


Optional, 3 digits
The initial number of transaction entries that are allocated within each block in the queue table. The number specified must be in the range 1-255.


Optional, 3 digits
The maximum number of transactions that may update a block concurrently. The number specified must be in the range 1-255.


Optional, 3 digits
Specifies the amount of free space within every block that is allocated to the queue table. This amount is expressed as a percentage.


Optional, 3 digits
Specifies the minimum level of space usage (as a percentage) that Oracle maintains for each block.


Records

About records

Defines the records held in a record file, and the fields that comprise the record.

Use the Repository Object Navigator to create record definitions in the repository.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Record definition properties

Owning Container

Record File

Name

Version

Col. Prefix

Record Format

Record Size

Documentation

Comment

Description

Notes

Related Topics

Columns

Operating System Files


Mandatory
The name of the record file that holds this record.


Optional, 4 characters
A prefix to be attached to every field in the record.


Optional, 15 characters
The format for the record. The format can be either one of the following values or of a format that is applicable to your own environment. The options are:

<Null>
FIXED
FIXED/VARIABLE
SEGMENTED
VARIABLE


Optional, 10 digits
The length of the record or the maximum length for variable length records.


Relations - Based On

About relations based on

Relations Based On definitions record the names of the tables on which views and materialized views are based.

Note:	This element type is also referred to as a "relation selection".

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Relations based on definition properties

Owning Container

View

Table

Usage Sequence

Version

Alias

Used in Sub-Query ?

Related Topics

Records

Materialized views

Tables

Views


Display only
The name of the view or materialized view.


Display only
The name of the element on which the view or materialized view is based.


Mandatory, 6 digits
A number to place the relation definitions in the correct order.


Optional, 30 characters
An alias for the view or materialized view. This alias can be used to qualify columns in the SELECT and WHERE clause.


Indicates that the relation definition referred to by the view or materialized view is used within a sub-query of the WHERE clause.

This property is set to No by default and the only relation definitions that can be defined in the Relations - Based On element type are those in the first FROM clause. Setting this property to Yes enables the additional information regarding the WHERE clause to be used.


Role Grants

About role grants

Role grants are repository definitions that record details about which roles can grant privileges to other roles. These can be used to define a network of roles.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Role grant definition properties

Owning Container

To Role

Role Granted

Version

With Admin Option ?

Related Topics

Roles


Display only
The name of the role to which a role has been granted, i.e., the role specified by the Role Granted in property.


Display only
The name of the role that is granted to the To Role.


Indicates that the users in the role have the privilege to grant access to other users.

Default: No


Roles

About roles

Roles are named groups of related privileges that can be granted to users or other roles. Each role definition in the repository defines a role with common privilege requirements. System and object privileges can be granted to a role to enable that role to accomplish a specific task. When a role definition has been entered in the repository, run the Server Generator. This utility generates a command file containing the appropriate create database role and grant statements for the role.

When the role has been defined, it can be used by other elements (for example Database Object Grants) to limit the role's access to individual elements.

Note: 	Forms Generator will derive a Forms menu role for each role defined in the repository.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Role definition properties

Owning Container

Oracle Database

Name

Version

Default password

Complete ?

Documentation

Comment

Description

Notes

Related Topics

Database Object Grants

Role Grants

Database User Roles

Database Users

System Privileges


Mandatory
The name of the Oracle database for which this role is being defined.


Mandatory, 30 characters
A unique name for the role.


Optional, 40 characters
An initial password to prevent unauthorized use of the privileges granted to this role.


Optional, 70 characters
A comment or brief description about the role.


Indicates that the role is ready to be created by the Server Generator.

Default: Yes


Rollback Segments

About rollback segments

Rollback segments generally improve database performance by undoing changes in the database in the event of transaction rollbacks, media recovery, etc. You can define a rollback segment, the tablespace in which it will belong and the storage allocation for it. A tablespace may have multiple rollback segments.

When the definition has been recorded in the repository, the rollback segment can then be created on a database using the Server Generator.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Rollback segment definition properties

Owning Container

Oracle Database

Name

Version

Public ?

Complete ?

Storage

Tablespace

Storage Definition

Optimal Size

Optimal Size Unit

Documentation

Comment

Description

Notes

Related Topics

Oracle Databases

Other Databases

Storage Definitions

Tablespaces


Mandatory, 30 characters
A unique name for the rollback segment.


Indicates whether this rollback segment is ready to be created by the Server Generator.

Default: Yes


Indicates whether the rollback segment is generally available for use by any instance accessing the database. By default the rollback segment is private.

Default: No


Mandatory
The name of the Oracle database where the rollback segment will reside.


Optional
The name of the tablespace in which the rollback segment will be created. The tablespace must be online when a rollback segment is added to it. You can specify whether the tablespace should be online, using the tablespace's Online property.

If a tablespace is not specified, a rollback segment is created in the SYSTEM tablespace by default.


Optional
The name of a set of storage parameters used to define future space allocation for the rollback segment in the database.


Optional, 240 characters
A comment about the rollback segment.


Optional
The optimal size for the rollback segment.


Optional
The units in which the optimal size is expressed. If Kilobytes or Megabytes are not specified, then Bytes are used by default.


Sequence Implementations

About sequence implementations

A sequence implementation is a repository definition that records the information that is required by the Server Generator to implement a specific sequence definition on a database. If sequence implementation details are not specifically recorded in the repository, that is, a sequence implementation definition is not created, Server Generator uses the default implementation settings to create the sequence on a database.

This information is used by the Server Generator to create the associated sequence on a database.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Sequence Implementation definition properties

Owning Container

Database

Database User

Sequence

Version

Complete ?

Scope

Global_Synonym_Name

Scope

Specification

Start

Increment

Cache Value

Cycle ?

Order ?

Minimum

Maximum

Documentation

Implementation Description

Implementation Notes

Related Topics

Databases

Database Users

Sequences


Optional, 38 digits
Specifies the first sequence number to be created. You should use this property when you want to override the specified defaults. For example, you may want to start an ascending sequence at a value greater than its specified minimum value. The default value for ascending sequences is derived from the Minimum property and the default value for descending sequences is derived from the Maximum property.

Note, you can use scientific notation to enter this value, e.g. 1E23.


Optional, 38 digits
The number by which the sequence is incremented. This number may have either a positive or a negative value. Note, you can use scientific notation to enter this value, e.g. 1E23.


Optional, 38 digits
Specifies a pre-allocation of sequence numbers that can be cached in the memory. Such a pre-allocation will result in faster generation of sequence numbers.


Indicates whether the sequence continues to generate numbers after reaching either its maximum or minimum value. After an ascending sequence reaches its maximum value, it starts generating from its minimum value. After a descending sequence reaches its minimum value, it starts generating from its maximum value.

Default: No


Indicates whether the sequence numbers should be generated in the order of the request. It is not usually important to guarantee that the sequence numbers are generated in the order of the request. However, if you are using Oracle7 with the Parallel Server option set to parallel mode, and the sequence numbers are being used for a specific purpose, such as timestamps, you should set this option to Yes.

Default: No Display


Optional, 38 digits
Specifies the minimum value that the sequence will generate. Note, you can use scientific notation to enter this value, e.g. 1E23.


Optional, 38 digits
Specifies the maximum value for the sequence. Note, you can use scientific notation to enter this value, e.g. 1E23.


Optional, 30 characters
Name to be used by Server Generator when creating synonyms for this object.


The scope of visibility of the database object, used by the Server Generator to determine when database links and synonyms need to be created.

Valid Values: DATABASE, WORLD
Default: DATABASE


Display only
The name of the sequence for which implementation details are being specified.


Sequences

What do you need help with?

About sequences

Sequence definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About sequences

A sequence generates a serial list of unique numbers for numeric columns of a database table (e.g., for automatically generating unique keys and primary keys for tables).

The Sequence repository definition records the basic information to define a sequence, such as its name and whether it should be implemented as a row in a code controls table or as a sequence. Implementation specific information about a sequence, such as the minimum and maximum values that will be generated, can be entered using the Sequence Implementation repository definition.

Note:	To specify implementation details such as the number by which the sequence is to be implemented, you must record a sequence implementation definition in the repository. Sequence implementations are recorded in the context of a user on a database.

The Server Generator can be used to generate the SQL statements necessary to create the sequences in a database.

Sequence definition properties

Owning Container

Name

Version

Code Control ?

Purpose

Documentation

Comment

Description

Notes

Related Topics

Sequence Implementations


Mandatory, 30 characters
A unique name for the sequence.


Indicates whether a Code Controls table or an Oracle database sequence should be used to source the unique numbers when rows are created.

Code Control Sequence -  A code controls table guarantees sequential numbers with no gaps between them. You should use this setting if the numbering of the sequence is important, for example, for invoice numbers.

Oracle Sequence - an ORACLE sequence is  better than a code controls table if rows are being created concurrently, but the numbers are not guaranteed to be in an unbroken sequence.

Default: Oracle sequence


Optional, 70 characters
A short description of the purpose of the sequence.


Optional, 2000 characters
A single line statement or comment on this sequence.


Storage Definitions

About storage definitions

Defines a named set of storage parameters for use in the SQL STORAGE clause. These parameters affect both the time taken to access data and how efficiently space is used. The allocated storage minimizes the frequency with which objects are allocated additional space. The storage details defined here can subsequently be associated with other database object definitions (e.g., tablespaces, rollback segments, tables, etc.).

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Storage definition properties

Owning Container

Storage Label

Version

Extents

Initial Extent

Initial Extent Unit

Next Extent

Next Extent Unit

Min Extents

Max Extents

Unlimited?

Percentage Increase

Freelists

Freelist Groups

Freelists

Documentation:

Comment

Description

Notes


Mandatory, 30 characters
A unique name for the storage definition.


Optional, 240 characters
A single line statement or comment about the storage parameter.


Optional, 6 digits
The number of free lists for each of the free list groups for a table, cluster or index.


Optional, 6 digits
The number of groups of free lists for a table, cluster or index


Optional, 38 digits
The size of the first extent that will be allocated when the object is created (i.e., the original amount of space allocated to the object). If no units are specified, bytes are used by default.


Optional
The units in which the initial size is expressed. Bytes are the default units to be used if Kilobytes or Megabytes are not specified.


Optional, 38 digits
The size of every extent to be allocated, after the initial extent. If no units are specified, bytes are used by default.


Optional
The units in which the next size is expressed. Bytes are the default units to be used if Kilobytes or Megabytes are not specified.


Optional, 38 digits
The initial number of extents to be allocated (i.e., the total number of extents to be allocated when the segment is created).


Optional, 38 digits
The total number of extents that can ever be allocated. This total includes the first extent.


Optional, 38 digits
The percentage by which each following extent will grow over the last extent allocated.


Identifies whether extents should be automatically allocated as needed. If set to Yes, the Maximum Extents property values must be Null.

Default: No (i.e. extents are not automatically allocated)


System Privileges

About system privileges

Specifies system privileges for Oracle database users, or groups of users. A system privilege allows a user to perform a particular database operation or class of database operations. System privileges are not granted to specific named schema objects or structures.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

System privilege definition properties

Owning Container

Database

Database User / Role

Privilege Name

Version

With Admin Option ?

Documentation

Comment

Related Topics

Database User Roles

Database Users


Display only
The name of the database on which the privilege will be implemented.


Display only
The name of the user or role to be granted system access privileges. If a role has been specified, then you cannot enter a value for this property.


Display only
The name of the user or role to be granted system access privileges. If a user has been specified, then you cannot enter a value for this property.


Optional, 240 characters
A comment or statement on the granting of privileges to this user or role.


The type of privilege to be granted to the user or role, e.g., CREATE TRIGGER, CREATE ROLE.


Indicates whether the user or role has the privilege to grant access to other database users.


Tables

What do you need help with?

About tables

Table definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About tables

A table is the basic unit of data storage in a database. Data is stored in columns and rows. The number of columns is fixed, whereas the number of rows is arbitrary. Both relational table definitions and object table definitions can be recorded in the repository. When a table definition has been entered into the repository, the table can then be created on a database using the Server Generator.

You can create index organized tables (relational and object-relational) by setting the Index Organized property to Yes. Note, that Index organized tables cannot have unique keys and cannot be put in clusters. They also cannot be partitioned or replicated.

You can create global temporary tables by setting the Data Persistence property to Session or to Transaction. If you set it to Session, rows created in a database session will be deleted at the end of the session. If you set it to Transaction, rows created in a database session will be deleted whenever a commit is executed. Global temporary tables cannot be index organized, so the Index Organized property will have no effect if you set Data Persistence to Session or to Transaction.  Global temporary tables cannot contain foreign keys. You will have to delete foreign key definitions associated with the table definition if you want to create a global temporary table from that definition. For other restrictions on the use of global temporary tables, see the Oracle database documentation. If the generator encounters invalid conditions during generation, error messages will tell you about them.

About relational tables

On a Server Model Diagram, a relational table definition is represented by a yellow rectangle, as shown below.

In the example shown above, the table definition defines the types of data, represented by columns, to be stored. An ellipsis (...) at the bottom of the node indicates that there is insufficient space on the node to display all column definitions on the table definition.

Each relational table should have a primary key, so that each row in the table can be uniquely identified.

If a relational table is to be implemented on an Oracle8 (or later) database, it can have a nested object table, i.e. the table can have a column whose datatype is another table. Conceptually, the entire nested object is stored in a single column position, and is called a column object.

About object tables

Object tables cannot be created on pre-Oracle8 databases. They are based on Oracle object types, which are also referred to as user defined types. The objects that are stored in each row of the table, are uniquely identified by a system generated identifier, called an object identifier. This object identifier is maintained automatically by the database.

Although Oracle8 supports object table constraints, i.e. primary keys, foreign keys, unique keys and check constraints, only check constraints can be modeled using Designer.

--------------------------------------------------------------------------------------------------

Table definition properties

Owning Container

Name

Version

Alias

Col. Prefix

Display Title

Journal

Data Persistence

Object Type Table

Object Type

Volumes

Start Rows

End Rows

Storage

Index-organized ?

Cluster

Data warehouse

Data warehouse Type

Documentation:

Comment

Description

Notes

User Help Text

Visual Basic / C++

Insert Code

Update Code

Delete Code

Lock Code

Related Topics

Columns

Check Constraints

Foreign Key Constraints

Indexes

Object Types

Primary Key Constraints

Table Implementations

Unique Key Constraints


Optional, 10 characters
A unique alias for the table name. Typically, you use the initial letters of words in the table name to define the alias. For example, CUSTOMER_ADDRESSES would take the alias CA.

Examples of how this property is used:

•	to provide names for the generated script files from which Server API packages are generated

•	to provide a default table alias when constructing views and materialized views based on this table

•	to provide a default usage alias when defining an application module. In turn, the table usage alias is used within the FROM clause of any generated SQL statements issued by the generated application


Optional, 4 characters
A unique prefix for the columns for the table. The column prefix can be used by the Database Design Transformer when creating new columns for a table. Column definitions that exist prior to a prefix being specified are not updated.


Optional, 132 characters
A default title that can be used by the client generators to label the part of the application that is based on this table. For example, generated forms show block titles, Visual Basic applications show captions and generated reports show group titles. This default value can be modified when module usages are defined for the table.


Optional, 38 digits
An estimate of the number of initial rows that will be inserted into the table.

This property is for documentation purposes only. The information is not used by Server Generator.'


Optional, 38 digits
An estimate of the maximum number of rows that the table will hold.

This property is for documentation purposes only. The information is not used by Server Generator.'


Indicates whether this is to be an 'index organized' table.

Default: No


Indicates whether this is to be a global temporary table and, if so, whether rows created in a database session will be deleted at the end of the session or on every commit.

Permanent	The table created from this definition will not be a global temporary table.
Session	A global temporary table will be created from this definition. Rows created in a database session will be deleted at the end of the session.
Transaction	A global temporary table will be created from this definition. Rows created in a database session will be deleted whenever a commit is executed.


Mandatory
Indicates whether a journal table should be created for the table to record the changes made to the rows in the table after it has been generated.

The Server Generator generates the SQL commands required to create the journal table, using the naming convention <tablename>_JN. The options are:

Client	Identifies that the journal table will be updated directly by client applications that contain the appropriate INSERT/UPDATE statements. This allows client applications to have a field asking the user for a reason for the change.
Server	Identifies that database triggers, which call a procedure to do the journaling, are created on the table.
Client calls server procedure	Identifies that client applications can update the journal table by calling a procedure on the server. This allows server journaling and a reason to be specified from the client.
None (Default)	No journaling is to take place.


Optional
Identifies the Oracle object type on which the object table is to be based. For an existing object table definition, this property can be changed to reference a different Oracle object type. However, you cannot change an object table into a relational table by removing the Oracle object type reference from this property.


Optional
The name of the cluster in which data from this table will be implemented.


Optional
Default help text or end-user text to be displayed by generated applications.


Optional
Classifies the table as a fact or a dimension in a data warehouse application. This property is applicable only if the table is part of a data warehouse application system.


Optional
This can be used by the C++  Generator. It defines PL/SQL statements to be used in the generated code to insert a row in a table.


Optional
This can be used by the C++  Generator. It defines PL/SQL statements to be used in the generated code to update a row in the table.


Optional
This can be used by the C++  Generator. It defines PL/SQL statements to be used in the generated code to delete a row in the table.


Optional
This can be used by the C++  Generator. It defines PL/SQL statements to be used in the generated code to lock a row in the table.


Table Implementations

What do you need help with?

About table implementations

Table implementation definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About table implementations

A table implementation records implementation specific information for a table definition, i.e., how the table will be implemented on a database for a user.

Table implementations record in the repository whether a table is part of a replication group. This information is specified using the Replication Group property. If a table implementation is part of a replication group, that group can be used to replicate the table on a different database. You can record which databases are to use replication groups in the repository. The Server Generator can use this information during generation.

Table Implementation definition properties

Owning Container

Database

Database User

Table

Version

Complete ?

Scope

Global Synonym Name

Scope

Storage

Tablespace

Storage Definition

Init Trans

Max Trans

Percent Free

Percent Used

Cached

Locking

Locking Sequence

Parallel

Parallel ?

Degree

Instances

Materialized View Log

Materialized View Log ?

Tablespace (Log)

Storage Definition  (Log)

Init Trans (Log)

Max Trans (Log)

Pct Free (Log)

Pct Used (Log)

Index-organized Tables

Pct Threshold

Overflow Tablespace

Replication

Replication Group

Documentation

Implementation Description

Implementation Notes

Non-Oracle Storage

Related Topics

Databases

Database Users

Tables

Tablespaces


Display only
The name of the table for which the implementation details are being specified.


Optional, 3 digits
A number specifying the sequence in which tables are to be locked by each application, especially those that will insert, update and delete data.


Optional, 30 characters
The name to be used by Server Generator when creating synonyms for this object.


Optional
Used in the case of an index only table to specify the name of the tablespace that is used for overflow purposes.


Optional, 3 digits
Used in the case of an index only table to specify a percentage of the block size beyond which rowdata will be considered overflow.


Optional
The name of the replication group to which the table belongs.


The scope of visibility of the database object. This is used by the Server Generator to determine when database links and synonyms need to be created.

Valid Values: Database, World
Default: Database


Indicates whether a materialized view log is to be created for this implementation of the table.
Default: No


Optional, 3 digits
The INIT TRANS parameter for the materialized view log of this implementation of the table.

Range: 1 - 255


Optional, 3 digits
The MAX TRANS parameter for the materialized view log of this implementation of the table.

Range: 1 - 255


Optional, 3 digits
Amount of free space (as a percentage) in a block that is allocated to the table.

Range: 0 - 99


Optional, 3 digits
Minimum level of space (as a percentage) in a block that ORACLE maintains for each block.

Range: 1 - 99


Optional
The name of a set of storage parameters that are to be used to define future space allocation for the table in the database.


Optional
The name of the tablespace in which the log will be created.


The name of the tablespace in which the table will be created. If no tablespace is specified, the table will be created in the user's default tablespace.


The name of a set of storage parameters used to define future space allocation for the table in the  database.


Optional, 3 digits
The initial number of transaction entries that are allocated within each block in the table. The number specified must be in the range 1-255.


Optional, 3 digits
The maximum number of transactions that may update a block concurrently. The number specified must be in the range 1-255.


Optional, 3 digits
Specifies a set amount of room in every block that is allocated to a table for future updates to the data of the table. This amount is expressed as a percentage.


Optional, 3 digits
Specifies the minimum level of space usage that Oracle maintains for each block.


Specifies whether the blocks retrieved for this table are placed at the most recently used end of the Last Recently Used (LRU) list. When set to Not Cached, retrieved blocks are placed at the least recently used end of the LRU. Placing the data at the most recently used end of the LRU, rather than the least recently used end can improve performance. It is useful to set this property to Cached for small lookup tables.


Indicates if parallel querying is to be used.

Default: No - Serial execution of an operation will be performed, rather than parallel.


Optional, 6 digits
The number of query servers used in the parallel operation. If this property is not specified, the Server Generator will create a table with a DEFAULT degree of parallelism.


Optional, 6 digits
Specifies how a table is split among the available instances of a parallel server for parallel query processing.

An integer specifies that this table is to be split among the specified number of instances. If this property is not specified, the Server Generator will create a table with DEFAULT instances.


Optional
Any additional storage parameters for databases that are not Oracle databases.


Table Partitions

About table partitions

Tables can be decomposed into smaller pieces called partitions. Partitions are particularly useful where tables have grown so big that they have become difficult to manage. Each table partition definition that is recorded in the repository represents a partition into which a table is to be divided on a database.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Table Partition definition properties

Owning Container

Database

Database User

Table

Name

Version

Usage Sequence

Value_Less_Than

Storage

Tablespace

Storage Definition

Init Trans

Max Trans

Percent Free

Percent Used

Related Topics

Databases

Database Users

Tables


Optional, 3 digits
The initial number of transaction entries allocated within each data block allocated to the partition.


Optional, 3 digits
The maximum number of concurrent transactions that can update a data block allocated to the partition.


Mandatory, 30 characters
A unique name for the table partition.


Optional, 3 digits
The percentage of space in each of the partition's data blocks reserved for future updates.


Optional, 3 digits
The minimum percentage of used space that Oracle maintains for each data block.


Mandatory, 6 digits
The sequence in which this table partition is to appear amongst other table partitions in the generated Data Definition Language statements.


Optional
The name of the storage definition that defines the storage parameters for the table partition.


Optional
The name of the tablespace in which the table partition is to be stored.


Display only
The name of the table implementation for which this partition is defined.


Mandatory, 240 characters
The 'VALUE LESS THAN' parameter for this table partition. In the case of a composite partition key, the multiple parameters are separated by commas, e.g., "6,5,0". Surrounding brackets are added by the Server Generator in the generated Data Definition Language statements.


Tablespace Quotas

About tablespace quotas

Allocates space within a tablespace to named Oracle database users. To grant permissions on the tablespace, the administrator must have the RESOURCE privilege.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Tablespace quota definition properties

Owning Container

Database

Database User

Tablespace

Version

Quota

Quota Units

Documentation

Comment

Related Topics

Database Users

Tablespaces


Mandatory
The name of the database on which the tablespace quota will be implemented.


Mandatory
The name of the user for which the tablespace quota is being specified.


Mandatory
The name of the tablespace for which the space is being allocated.


Optional, 38 digits
The amount of space that is allocated to the user in the tablespace. A null value indicates an unlimited quota.


Optional
The units of space in which the quota is measured. The options are:

Kilobytes
Megabytes


Optional, 240 characters
A comment about this tablespace quota.


Tablespaces

About tablespaces

Defines a tablespace that can be used by tables, indexes, clusters and rollback segments.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Tablespace definition properties

Owning Container

Database

Name

Version

Complete ?

Online ?

Read Only ?

Temporary Tablespace ?

Storage Definition

Documentation

Comment

Description

Notes

Related Topics

Clusters

Indexes

Rollback Segments

Tables

Tablespace Quotas


Mandatory, 30 characters
A unique name for the tablespace.


Indicates whether the tablespace is to be made available to users (who have been granted access) immediately after it has been created on the database.

Default: Yes


Indicates whether this tablespace is ready to be created by the Server Generator.

Default: Yes


This property is updated by the Server Generator when a tablespace has been reverse engineered from an existing database into the repository. It indicates whether write operations are allowed on the tablespace. This property is for documentation purposes only, and is not used by the generator products.


Optional, 240 characters
A comment as to why the tablespace is required.


Mandatory
The database where this tablespace is to reside.


Optional
The name of a set of storage parameters that are to be used to define future space allocation for all objects in the tablespace.


Indicates whether the tablespace is temporary. A temporary tablespace is read-only and should be used for operations such as sorting, that might require more space than is available in the default tablespace.

Default: No


Trigger Column Usages

About trigger column usages

Defines a relationship between a database trigger and a column.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Trigger column usage definition properties

Owning Container

Database Trigger

Column

Version

Related Topics

Columns

Database Triggers


Mandatory
The database trigger used by the column


Mandatory
The column referencing the trigger


Unique Keys

What do you need help with?

About unique keys

Unique key definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About unique keys

A unique key constraint enables you to specify that no two rows of a table can have duplicate values in a specified column or set of columns. For example, given the table DEPT, you might define a unique key constraint on the DNAME column, to ensure that, for each department name entered, the department name must be unique.

Unique key constraints cannot be recorded in the repository for:

-	object tables and object views

-	index-organized tables.

An attempt to enter another row containing the department name SALES would violate the unique key constraint on the DNAME column.

Unique key constraints are defined by specifying the column or set of columns on which the constraint is to be enforced. The column or set of columns specified in the constraint definition is known as the unique key.

A unique key constraint that comprises more than one column is known as a composite key.

You might define a composite unique key to prevent the same combination of values from being entered in the key columns. For example, given the table CUST, you might make the columns AREA and PHONE part of a composite unique key.

This would prevent the same phone number from being entered for different customers, since for any row in the table, the combined value of the area code and the phone number must be unique.

An attempt to enter the area code 010 and the phone number 554 8879 would violate the composite unique key constraint, because a row containing the same combination is already entered in the table.

Note that duplicate values are allowed in both the AREA and the PHONE columns, since it is the combined values of these columns that must be unique.

Unique keys are often defined on columns with not null integrity constraints; i.e. mandatory columns, to enforce the input of a value in the columns of the unique key.

Note:  When the key constraints are implemented, the Oracle database server will automatically create an index to enforce a UNIQUE or PRIMARY key integrity constraint.

This information can be used when generating applications; for example, to order and restrict access to the use of tables and/or views and their respective columns.

When the unique key definition has been entered into the repository, the unique key can then be implemented on the database using the Server Generator.

--------------------------------------------------------------------------------------------------

Unique key definition properties

Owning Container

Table

Name

Version

Complete ?

Enable ?

Mandatory ?

Update ?

NULL is Discrete Value ?

Validation

Validate In

Defer Status

Error Message

Exceptions Table

Source

Unique Identifier

Documentation

Description

Notes

Related Topics

Columns

Foreign Key Constraints

Key Components

Primary Key Constraints

Tables


The level at which the unique key constraint is to be enforced. The options are:

Client	The unique key will be enforced at application level only.
Server	The unique key will be enforced on the database only. This is the default value.
Both	The unique key will be enforced at application and database level.

Default: Both


Indicates whether this unique key constraint can be updated.

Default: No


Indicates whether NULL is to be treated as a discrete value.

Default: No


Indicates that a value is required in the unique key.

Default: No


Optional
Defines the Unique Identifier from which the unique key constraint is derived. This value can be populated by the Database Design Transformer or you can specify the value manually. To set this value manually, you must first create a mapping from the table definition to at least one entity definition. You can then choose the UID from one of these entities.


Views

What do you need help with?

About views

View definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About views

A view provides different types of user with a restricted presentation of data that is stored in other tables or views. A view is defined using a query on the columns of one or more tables, or other views. To the user, a view appears as a single table, although it can be derived from multiple tables. When you have entered the definitions of your views into the repository, you can run the Server Generator. This will generate a command file containing the SQL statements required to build the views in a database.

Views provide a mechanism for restricting access to columns on certain tables or views, as a means of data security. Views can also be used to simplify queries by means of a join on a set of columns in multiple tables. Because the join is created in the view definition, routine queries can be performed by less frequent users of the database, without having to know how to perform the join.

Both relational view definitions and object view definitions can be recorded in the repository.

About relational views

On a Server Model Diagram, a relational view definition is represented by a gray rectangle, as shown below.

In the example shown, the view STAFF is derived from the columns on the EMP table. The view consists of a restricted set of columns derived from the base table, and is used to ensure that only the data required by a role can be accessed by that group. Data considered to be confidential, such as salary, is hidden.

About object views

Object views allow you to retrieve, update, insert and delete relational data as if they were stored as objects. This allows you to use the object oriented features of the database with existing relational data. If you want to build an object view that is based on an existing relational table or view, you can use the Oracle Object Type and Object View utilities.

Although, constraints, e.g. foreign keys, can be defined for object views on an Oracle8 database, they cannot be recorded in the repository with this release.

Note:	In this release, object view definitions cannot be represented on Server Model Diagrams.

When the view definition has been entered into the repository, the view can then be created on the database using the Server Generator.

--------------------------------------------------------------------------------------------------

View definition properties

Owning Container

Name

Version

Alias

Col. Prefix

Display Title

Object View

Object Type

OID Attribute List

SQL

Free Format Select Text ?

Select Text

Optimizer Hint Clause

Where/Validation Condition

Documentation

Comment

Description

Notes

User Help Text

Visual Basic/C++

Insert Code

Update Code

Delete Code

Lock Code

Related Topics

Check Constraints

Columns

Foreign Key Constraints

Primary Key Constraints

Synonyms

Unique Key Constraints

View Implementations


Optional, 10 characters
A unique alias for the view name. Typically, you use the initial letters of words in the view name to define the alias. For example, CUSTOMER_ADDRESSES would take the alias CA.

Examples of how this property is used:

•	to provide a default view alias when constructing materialized views and views based on this view

•	to provide a default usage alias when defining an application module. In turn, the usage alias is used within the FROM clause of any generated SQL statements issued by the generated application


Optional, 4 characters
A prefix for the columns in this view. The column prefix is used by the Server Generator when generating the column names that are to be implemented on the database.


Optional, 132 characters
A default title that can be used by the application generator products to label the part of the application that is based on this view. For example, a prompt on a Visual Basic application.
This default value can be modified when module usages are defined for the view.


Indicates whether tables on which the view is to be based are defined using a free format SELECT statement. This enables complex queries to be defined; for example, queries that contain group functions and nested statements. If you set this property to Yes, you can enter the SELECT statement in the Select Text property.

By default this property is set to No. This is because for all but the most complex queries, you should specify the base tables using the elements defined in the repository.

Caution:	If you change the value of this property from Yes to No, you will lose any text that you have entered in the Select Text property.

Default: No


Optional
The SELECT statement that specifies the base tables and columns from which the view is derived.

For example, enter the SELECT statement, omitting the keyword SELECT.

DNAME, MIN(SAL), MAX(SAL), AVG(SAL)FROM EMP, DEPT

The SELECT keyword is generated automatically by the Server Generator.
This property can be edited only if the Free Format Select Text property is set to Yes.

Note: A free-format query is not maintained by the repository if changes are made to the underlying base tables.


Optional, 2000 characters
A comma separated list of attributes of the object type that will be used as a key to uniquely identify each row in the object view.


Optional
A hint clause to be used where the view is defined declaratively. The optimizer uses the hint to choose an execution statement plan for the SQL statement.


Optional
Identifies the Oracle object type on which the object view is to be based. For an existing object view definition, this property can be changed to reference a different object type. However, you cannot change an object view into a relational view by removing the object type reference from this property.


Optional
A restriction or join condition for the view, specified in a WHERE clause. This clause defines a condition on the SELECT statement (that defines the view) that must be met in order for rows resulting from the query to be returned. For example, if the query is to retrieve data from more than one table, you can specify the join condition using a WHERE clause. If no condition is specified, all rows in the table are returned.

Example of a SELECT statement with a qualifying WHERE clause:

SELECT ename, job, dept.deptno, dname
FROM emp, dept
WHERE emp.deptno = dept.deptno

Tip:	The word WHERE can optionally be omitted from the start of the clause.


Optional
Default help text or end-user text to be displayed by generated applications.


Optional
This can be used by the C++ Generator. It defines PL/SQL statements to be used in the generated code to insert a row in a table.


Optional
This can be used by the C++ Generator. It defines PL/SQL statements to be used in the generated code to update a row in the table.


Optional
This can be used by the C++ Generator. It defines PL/SQL statements to be used in the generated code to delete a row in the table.


Optional
This can be used by the C++ Generator. It defines PL/SQL statements to be used in the generated code to lock a row in the table.


View Implementations

What do you need help with?

About view implementations

View implementation definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About view implementations

A view implementation represents a specific implementation of a view in a schema.

View implementations record in the repository whether a view is part of a replication group. This information is specified using the Replication Group property. If a view implementation is part of a replication group, that group can be used to replicate the view on a different database. You can record which databases are to use replication groups in the repository. The Server Generator can use this information during generation.

View implementation definition properties

Owning Container

Database

Database User

View

Version

Complete ?

Scope

Global Synonym Name

Scope

Replication

Replication Group

Documentation

Implementation Description

Implementation Notes

Related Topics

Databases

Database Users

Views


Display only
The name of the view for which the implementation details are being specified.


The scope of visibility of the database object. This is used by the Server Generator to determine when database links and synonyms need to be created.

Valid Values: Database, World
Default: Database


Optional
The name of the replication group to which the view belongs.


Optional, 30 characters
The name to be used by the Server Generator when creating synonyms for this object.


About constraints
Constraints

Constraints are rules that determine which operations are allowed on the columns and tables in a database. There are different kinds of constraints, e.g. primary key constraints are used to identify or reference the rows of tables and check constraints are used to validate specific conditions for rows in tables.


Indicates whether this constraint is ready to be generated by the Server Generator.

Default: Yes


Mandatory, 30 characters
A unique name for the constraint.

Tip:	It is helpful to name constraints using a naming convention such as <table_name>_<suffix>, where suffix is PK (primary key), FK (foreign key), UK (unique key) and CK check constraint.


Mandatory
Indicates whether the validation of the constraint on the database is to be deferred. The options are:

INITIALLY DEFERRED	The constraint is deferrable and, by default, checked at the end of the transaction.
INITIALLY IMMEDIATE	The constraint is deferrable and, by default, checked at the end of each DML statement.
NOT DEFERRED (Default)	The constraint is NOT deferrable and is checked at the end of each DML statement.
Note: For deferrable constraints you can use the SET CONSTRAINT(S) command to set, per transaction, whether a deferrable constraint is checked following each DML statement (IMMEDIATE) or when the transaction is committed (DEFERRED). The SET CONSTRAINT command cannot be used to change not deferrable constraints.


Optional, 70 characters
A user-defined error message to be issued instead of the default error message when data is entered that violates this constraint. In the absence of a user-defined error message, a default error message will be issued incorporating the column prompt.


Display only
The name of the element for which the constraint is defined.


Indicates whether the constraint is to be enabled or disabled when the table is generated on the database.

Default: Yes


Optional, 40 characters
The name of the table, view or materialized view where exceptions to this constraint are written. The exceptions table must be created in the same schema in which the table is to be created.


Databases

You have selected context-sensitive information for one of the properties common to the two types of database, Oracle databases and other databases. Select the relevant type:

•	Oracle Databases

•	Other Databases


Indicates whether this database is ready to be created by the Server Generator.
Default: Yes


Optional, 240 characters
A single line statement or comment on this database.


Mandatory, 40 characters
The implementation name of the database. This name uniquely identifies the database in a distributed environment and is required to be unique within the container.


Mandatory, 8 characters
A unique name for the database.


Optional
The name of the node on which this database is to reside.


Optional, 40 characters
The alias (e.g., '.LONDON') used for the TNS connection path to the Oracle database as defined in the configuration file TNSNAMES.ora. This alias is used by SQL*Net Version 2.

For more information, refer to SQL*Net Administrator's Guide.


Optional, 80 characters
The character string used by the user to connect to the Oracle database by SQL*Net.


Database Object Implementations

You have selected context-sensitive information for one of the properties common to these database object implementations. Select the relevant element type:

•	Table Implementations

•	View Implementations

•	Materialized view Implementations

•	Cluster Implementations

•	Sequence Implementations

•	PL/SQL Definition Implementations

•	Java Class Implementations

•	Queue Table Implementations


Display only
The name of the database user for which the definition will be implemented.


Indicates whether the definition is ready to be created by the Server Generator. If you attempt to generate data definition language statements when this property is set to No, then the generation process will fail.

Default: Yes


A multi-line text description of the element.


Multi-line text notes about the element.


Index Partitions

An index partition represents a partition into which an index has been divided. The index partition can have different physical characteristics to the index, for example, it can be stored in a different tablespace and can have its own storage parameters.

Select the relevant index partition type:

•	Global index partitions

•	Local index partitions


Display only
The name of the index storage definition for which the index partition details are specified.


Optional, 3 digits
The initial number of transaction entries allocated within each data block allocated to the partition.


Optional, 3 digits
The maximum number of concurrent transactions that can update a data block allocated to the partition.


Mandatory, 30 characters
The name of the index partition.


Optional, 3 digits
The percentage of space in each of the partition's data blocks reserved for future updates.


Optional
The name of the storage definition that defines the storage parameters that are used by the index partition.


Optional
The name of the tablespace on which the index partition is to be stored.


Java definitions / PL/SQL definitions / Modules

You have selected context-sensitive information for one of the properties common to Java definitions, PL/SQL definitions and application module definitions. Select the relevant element type:

•	Java

•	PL/SQL

•	Modules


Optional, 10 characters
The name or code of the activity that is to implement the definition. This property is for documentation purposes only, and is not used by the generator products.


Indicates whether the definition is a candidate definition. A candidate definition is a module that has been created from System Modeler data using the Application Design Transformer. To generate from a module, this property must be set to No.

Default: No


Indicates whether or not the design of this definition is complete. This property is for documentation purposes only, and is not used by the generator products.

Values: Not Started, In Progress, Completed
Default: Not Started


Optional
The complexity of the definition. This property is for documentation purposes only, and is not used by the generator products.

Values: <Null>, Average, Difficult, Easy
Default: <Null>


Optional, 8 digits
An estimate of the time needed to complete the definition. This property is for documentation purposes only, and is not used by the generator products.


Optional
The units of time in which the estimate is measured, for example, Day, Week, Month. This property is for documentation purposes only, and is not used by the generator products.


Mandatory, 40 characters
For application modules this is the name of the repository definition.

Note: For Java objects (source and resource only) this property is used during DDL generation if the Implementation Name property is not specified.


Optional, 12 characters
The name or code of the project that uses the definition. This property is for documentation purposes only, and is not used by the generator products.


Mandatory, 70 characters
The purpose or short description for documentation purposes.

These Generators use this property. Click for more information:


Mandatory, 20 characters
The short name. During application module generation this property is used as the basis for naming generated files and objects.

Note: For PL/SQL definitions (procedures, functions and packages) this property is used during DDL generation if the Implementation Name property is not specified.

These Generators use this property. Click for more information:


Optional, 6 digits
The estimated size of the definition. Use your own sizing units. This property is for documentation purposes only, and is not used by the generator products.


Optional, 132 characters
The name of the file containing the source code for this library module.

These Generators use this property. Click for more information:


Optional, 10 characters
The name or code of the task that is to implement this definition. This property is for documentation purposes only, and is not used by the generator products.


Indicates whether the module is at the top-level, rather than one that is normally executed in the context of another module, via a module network. This property is for documentation purposes only.

Default: No


Optional
Information on the production version of the module. This property is for documentation purposes only, and is not used by the generator products.


Join constraints -

supertype of foreign key constraint and domain key constraint

This topic is for internal documentation purposes only


The name of the table to which the current table is to be joined via the constraint.


 Mandatory
Indicates where the constraint is to be enforced. The options are:

Client	The constraint will be enforced by the client application only.
Server	The constraint will be enforced on the database only.
Both	The constraint will be enforced by the application and on the database.
None	The constraint will not be enforced.

Default: Both


 Indicates whether a value is required by the constraint. If set to Yes a value is mandatory and cannot contain null values. By default a value is optional does not have to be specified.

Default: No


 Indicates whether any items that are based on the constraint columns can be updated in a generated application, such as a form. If this property is set to Yes, the key columns will be transferable and the items based can be updated in generated applications. Typically, key columns will be transferable.

If this option is set to No, the key columns will be non-transferable and the items are made non-updateable in generated applications.

Default: Yes


 Determines the actions following an attempt to delete a related row in the join table. The options are:

Delete rule	Validate In	Description
Cascades	Server and client	Deletes a row from this table when the related row is deleted in the join table.
Restricted	Server and Client	Prevents deletion of a row in the join table when a related row exists in this table. This is the default delete rule.
Nullifies	Server and client	Sets a row in this table to NULL when a row in the related join table is deleted.
Defaults	Server and client	Sets a row in this table to the specified default value when a row in the related join table is deleted.
The Server Generator generates code to enforce the constraint on the Server if the Validate In property is set to Server or Both and the constraint can be enforced on the Server. The application generators can generate code to enforce the constraint in a generated application if the Validate In property is set to Client or Both and the constraint can be enforced on the Client.


 Determines the actions following an attempt to update a related row in the join table. The options are:

Update rule	Validate In	Description
Cascades	Client only	Updates a row in this table when the related row is updated in the join table.
Restricted	Server and Client	Prevents update of a row in the join table when a related row exists in this table. This is the default rule. This rule must be selected for the Server Generator to generate the foreign key constraint.
Nullifies	Server and client	Sets a row in this table to NULL when a row in the related join table is updated.
Defaults	Server and client	Sets a row in this table to the specified default value when a row in the related join table is updated.


Relation Definitions

You have selected context-sensitive information for one of the properties common to the four types of relation definitions. Select the relevant type:

•	Record

•	Materialized view

•	Table

•	View


Mandatory, 30 characters
The name of the element. This name should be unique within a container.


Optional, 2000 characters
A comment about the element.


Contents

* # $ K Argument item usages

* # $ K Bound items

* # $ K Constraint usages

* # $ K Custom action items

* # $ K Custom links

* # $ K Domain key constraints

* # $ K Generator action items

* # $ K Item groups

* # $ K Key based links

* # $ K Table usage links

* # $ K Languages

* # $ List of values inclusions

* # $ K Lists of Values (LOVs) components

* # $ K Module change history

* # $ Module component inclusions

* # $ K A Module components

* # $ K A Module sub-components

* # $ K Table usages

* # $ K Module weighting factors

* # $ K Modules

* # $ K Module networks / PL/SQL composition

* # $ K Navigation action items

* # $ K Oracle user module accesses

* # $ K Passed values

* # $ K Problems to modules

* # $ K Role module accesses

* # $ K SQL query sets

* # $ K System objective of modules

* # $ K Unbound items

* # $ K Windows

* # $ K Action items

* # $ K Items

* # Module Component Links

* # $ Module units


Argument item usages

About argument item usages

An argument item usage records the usage of an argument by an  item.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Argument item usage definition properties

Owning Container

Module / PLSQL

Argument

Module Unit

Item

Version

Operator

SQL Query Clause

Use PRIOR when adding to SQL ?

Related Topics

Arguments

Bound Items

Unbound Items


Mandatory
The operator to be used when applying the parameter value against the item that is specified in the WHERE clause of the query. For example if you set the operator to ">=" (greater than or equal to) the generated query takes the format ITEM_VALUE >= PARAMETER_VALUE. This property is relevant to Report Generator only.

Valid Values: !=, <, <=, <>, =, >, >=, Like, ^=

Default value is =


Display only
The name of the item using the argument.


Display only
The name of the argument being used.


Indicates the clause in a SQL query to which the join condition resulting from this argument item usage is to be added.


When binding an argument into a CONNECT BY clause, identifies whether the PRIOR operator is to be appended to the column involved.


Bound items

About bound items

Bound item definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About bound items

A bound item definition records the use of a database column by a generated application. Each bound item is recorded in the context of a table usage and specifies how the column is to be used by a generated application.

Note:	A bound item is always directly mapped to a single database column.

The following picture shows how bound items are represented on the Data view of Module Diagrams and Reusable Component Diagrams. Notice how the bound items are shown in the context of the table for which the underlying column exists.

Bound items are always displayed on the Data view of a diagram. They are shown on Display view only if they are to be displayed on generated applications.

When shown on a diagram, a bound item has an icon displayed to the left of its name. If the diagram is set to Data view, the icon identifies the datatype of the column on which the item is based. If the diagram is set to Display view, the icon identifies the Display Type of the item on a generated application.

If the item has an associated LOV component, the name of the LOV component is displayed to the right of the bound item on a Module Diagram.

--------------------------------------------------------------------------------------------------

Bound item definition properties

Owning Container

Module Unit

SQL Query Set

Table Usage

Column

Version

Name

Usage Sequence

Template/Library Object

Operations

Insert ?

Update ?

Query

Query ?

Range Search

Context Option ?

Display

Display ?

Prompt

Display Type

Show Meaning

Width

Height

Alignment

Format Mask

Formatting

Wrap Style

Item Group

Context ?

Relative Tab Stops

Start Tab

End Tab

Align Prompt ?

Definition

Datatype

Default Value

Default Value Type

Optional ?

Ordering

Order By Sequence

Sort Order

SQL

PL/SQL block

Help

Hint

User/Help Text

Documentation

Comment

Description

Notes

Related Topics

List of Values Components

Module Components

Table Usages

Unbound Items


Mandatory
The name of the underlying column on which the generated item is based.


Indicates whether the Oracle ConText Option 'contains' clause is to be used to query this item.

Default: No

These Generators use this property. Click for more information:


Mandatory
The name of the table usage for which the item is defined.


Optional
The type of item in the generated application. When a bound item is created, the Display Type defaults to the Display Type of the underlying column.

These Generators use this property. Click for more information:


Constraint usages

About constraint usages

A constraint usage represents the usage of a constraint (i.e. foreign key, unique key, primary key, check constraint or domain key constraint) within a particular base table usage.

Constraint usages are recorded in the repository because of the granularity to which preferences can be set for application generation. The ability to record preferences against a constraint usage provides the capability of varying constraint preferences at the individual constraint level within a table usage.

Note:	Preferences that are set against constraint usages are used by Form Generator only.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Constraint usages definition properties

Owning Container

Table

Constraint

Module Component

Table/View/Materialized view

Usage Alias

Version

Related Topics

Check Constraints

Domain Key Constraints

Foreign Key Constraints

Primary Key Constraints

Unique Key Constraints


Display only
The Table and Constraint properties identify the constraint on which the usage is based.


Display only
The Module Unit, Table/View/Materialized view and Usage Alias properties identify where the usage of the constraint occurs. Module unit is a generic term for module component, sub-component and LOV component.


Custom action items

About custom action items

Custom action item definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About custom action items

A custom action item represents an interface object that allows a specific piece of user defined code to be performed from a generated application. They can be created for module components, sub-components and windows whose language is set to one of the following:

•	Oracle Forms

•	Oracle Web PL/SQL

•	Visual Basic

For Oracle Forms applications, custom action items can be used to generate buttons only. For Oracle Web PL/SQL applications custom action items can be used to generate hyperlinks, image links and buttons. For Visual Basic applications custom action items can be used to generate both menu options and buttons.

When a custom action is created, the action that is to be performed can be specified by:

•	defining user defined code (also referred to as application logic) against the action item

•	specifying the name of a template/library object that provides the required functionality for the action item

--------------------------------------------------------------------------------------------------

Custom Action Item definition properties

Owning Container

Module Component

Window

Name

Version

Usage sequence

Default ?

Enable on Database Record ?

Template/Library Object

Display

Prompt

Icon Name

Create Button ?

Button Height

Button Width

Create Menu Item ?

Help

Hint

User Help Text

Documentation

Description

Notes

Related Topics

Modules

Module Components

Windows


Indicates whether a button is to be created for this custom action item.

Default: Yes

These Generators use this property. Click for more information:


Indicates whether a menu item is to be created for this custom action item.

Default: No

These Generators use this property. Click for more information:


Indicates whether the custom action item is always displayed, or only when a database record is being displayed.

Default: No  indicates that the generated item is always displayed.

These Generators use this property. Click for more information:


Custom links

About custom links

Custom link definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About custom links

Custom links are not used in this release of Oracle Designer.

--------------------------------------------------------------------------------------------------

Custom link definition properties

From

Module

Module Component

To

Module

Module Component

Version

Join

Join Condition

SQL Query Clause

Documentation

Description

Notes


 Specifies the join condition that connects the tables from which data is to be accessed. This join condition is placed in the SELECT clause specified in the SQL Query Clause property.


Domain key constraints

About domain key constraints

Domain key constraint definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About domain key constraints

Domain key constraints allow you to model domains using a table other than the predefined one normally used by Oracle Designer. You may want to do this for several reasons, e.g., you may already have a domain table that you would like to design capture and continue to use, or you may want more control over how domain values are shown within a model.

A domain key constraint allows a generated application to access a specific range of domain values, from a table containing multiple domains. The domain key constraint specifies that values entered in the domain key columns do not conflict with a predefined range of acceptable values.

For example, when entering information about employees on table EMP, it may be mandatory to specify a job type or name, e.g. permanent, temporary, part-time. The legitimate employment types could be stored in your domain table, from which the appropriate type can be selected. Thus the employment type entered for each employee would always be a valid type.

You create a domain key constraint between the table on which the value is used and the domain table that stores the available values, as illustrated below.

Note:	Domain key constraints cannot be created on Server Model Diagrams.

The domain table may contain several domains because each domain key constraint specifies a WHERE clause which is to be applied when querying on the domain table. To enforce that a value for the key columns must be specified, the key columns can be defined as mandatory.

If you specify that the constraint is to be validated in the Server, you must generate the Table API.

Domain key constraints can consist of more than one column, in which case you define a set of allowed values for a pair of columns.

Mandatory and Optional domain key constraints

Domain key constraints can be mandatory or optional.

Mandatory	A value entered in the column in the domain key constraint must match a value in the domain table.
Optional	A value entered in the column in the domain key constraint must match either a value in the domain table, or else it must be null.
Transferable domain key constraints

A domain key constraint is transferable if the domain key constraint column value can be disconnected from its associated domain value and be reconnected to a different domain value. In most cases, a domain key constraint column will be transferable.

For example, the table MEMBERSHIPS has a domain key constraint column MT_CODE that references the column # DOMAIN_VALUE of the DOMAIN_TYPES table. The domain key constraint is transferable since, for any given membership held in the MEMBERSHIPS table, it is possible to change the membership to another membership type.

For example, private membership can be transferred to corporate membership, and vice versa.

Non-transferable domain key constraints

A domain key constraint is non-transferable if the domain key constraint column value cannot be disconnected from a specific instance of the associated domain value. Non-transferable domain key constraints must always be connected to a particular domain value. This type of constraint can be enforced only in the client application. The client generators enforce non-transferable keys by making the items based on the domain key constraint columns non-updateable.

For example, a CAR_SALES table for a garage has a column MANUFACTURER that identifies which company built the car. The domain key constraint is non-transferable since, during the course of a car's life, it will be associated with only one manufacturer and while it exists, cannot be connected to a different manufacturer. An attempt to update the foreign key in the client would be invalid, since the column is non-updateable.

Cascade delete rules for domain key constraints

The cascade delete rules determine the action to be taken when an attempt is made to delete a related row in the domain table. The delete rule for each domain key constraint is determined by the Delete Rule property.

--------------------------------------------------------------------------------------------------

Domain key constraint definition properties

Owning Container

Table

Join Table

Name

Version

Complete ?

Mandatory ?

Transferable ?

Validation

Where Clause

Validate In

Defer Status

Error Message

Cascade Rules

Delete Rule

Update Rule

Documentation

Description

Notes


 Specifies the WHERE condition used to retrieve values from a table containing multiple domains, e.g. COL2='3'.


Generator action items

About generator action items

Generator action item definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About generator action items

A generator action item represents a button on a generated Visual Basic application. This type of action item allows a standard piece of generator functionality (such as Commit) to be invoked from the generated application.

Generator Action Item definition properties

Owning Container

Module Component

Window

Name

Version

Generator Item Type

Usage Sequence

Default ?

Template/Library Object

Display

Prompt

Icon Name

Button Height

Button Width

Help

Hint

User Help Text

Documentation

Description

Notes

Related Topics

Modules

Module Components


Indicates the type of standard generator functionality the generator action item is to invoke. For example, you may want to override the default caption for the Commit button.

These Generators use this property. Click for more information:


Item groups

About item groups

Item group definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About item groups

An item group is a collection of items that is treated as a single layout object, and which defines display settings for its items. Item groups can be defined within module components and sub-components and can also be nested within other item groups.

Note:	Report Generator and Web PL/SQL Generator also use an item groups to define break groups.

On Module Diagrams and Reusable Component Diagrams, an item group is represented as a box drawn around the items that are to be grouped, as shown below.

From Module Diagrams and Reusable Component Diagrams, item groups can be created and maintained from the Display view only.

--------------------------------------------------------------------------------------------------

Item group definition properties

Owning Container

Module Component / Sub-component

Name

Version

Parent Item Group

Template/Library Object

Display

Prompt

Layout Format

Orientation

Stacked ?

Relative Tab Stops

Tab Stop Scope

Start Tab

End Tab

Reports Break Group

Break Group ?

Break Group Direction

Help

User/Help Text

Documentation

Description

Notes

Related Topics

Modules

Items


Mandatory
The name of the module component for which the item group is defined.


Mandatory
The name of the sub-component for which the item group is defined.


Mandatory, 30 characters
A unique name for the item group.

Note Report Generator and Web PL/SQL Generator also use item groups to define break groups.

These Generators use this property. Click for more information:


Optional, 130 characters
A prompt (or label) to identify the group of items in the generated application.

These Generators use this property. Click for more information:


 The style in which the item group is to be generated. Valid values for the different types of generated applications are:

	Forms	Reports	Web
Standard	Yes	Yes	Yes
Address	No	Yes	No
Multi-record	Yes	No	No
Form	No	Yes	No
Tabular	No	Yes	No
Across	No	Yes	No
Default: Standard

These Generators use this property. Click for more information:


 Used by Form Generator to identify whether the items in the group are to be laid out horizontally or vertically.

Default: Vertical

These Generators use this property. Click for more information:


Indicates to Report and Web PL/SQL Generator whether this item group is used as a 'break group'. For Report Generator, this property is also used to define a matrix report.

Default: No

These Generators use this property. Click for more information:


Optional
Indicates to Report Generator the style to be used when the item group is used as a reporting break group.

Valid Values: Across, Down, Intersection

These Generators use this property. Click for more information:


Indicates whether this is one of a number of item groups that will be stacked upon each other in the generated application. By default, the item group is permanently displayed, i.e., not stacked.

Default: No (Not stacked)

These Generators use this property. Click for more information:


Optional, 10 digits
The numeric relative tab stop to use when aligning the left edge of the item group with the left edge of other items and item groups. This property is not used if the Tab Scope property is set to 'None'.

These Generators use this property. Click for more information:


 Optional, 10 digits
The numeric relative tab stop to use when aligning the right edge of the item group with the right edge of other items and item groups. This property is not used if the Tab Scope property is set to 'None'.

These Generators use this property. Click for more information:


Specifies whether Form Generator aligns items inside the item group with items outside the item group that have the same relative tab stops.

Valid values are:

Valid Values	Meaning
None (Default)	Form Generator ignores relative tab stops.
Self	Items within the item group are not aligned with items outside the item group.
Parent	Items within the item group are aligned with items outside the item group.
These Generators use this property. Click for more information:


Optional, 30 characters
The name of an object in a [Visual Basic] template or [Oracle Forms] object library, on which this item group is to be based.

These Generators use this property. Click for more information:


Optional
The name of the item group within which this item group is to be displayed in the generated application.

These Generators use this property. Click for more information:


Optional
End-user text or help text for generated applications. Item group help text can be included within generated MS Help files.

These Generators use this property. Click for more information:


Key based links

About key based links

Key based link definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About key based links

A key based link identifies a relationship between two module components that is based on a key constraint. These types of links are used by the application generators to pass context information between different parts of a generated application or between different generated applications.

Each key based link is based on a foreign key, domain key, primary key or unique key. The origin and destination of a key based link is always a table usage. The table usages must not be in the same module component. Links between table usages within the same module component, sub-component and List of Values component are called table usage links.

When represented on Module Diagrams, key based links can be seen from the Data view only.

These types of links are stored as definitions in the Oracle Designer Repository and have their own properties such as “FKey on 'From' Component ?”.

Types of key based links

•	Master-detail links represent foreign key/domain key constraint relationships between table usages. They are shown on Module Diagrams as a vertical line with a 'crowsfoot' displayed at the detail end of the link, as shown below. The 'crowsfoot' is attached to the module component table usage whose underlying table contains the foreign key or domain key constraint.

This type of link is used to provide detailed information for a chosen record. For example, you may want to show all of the employees for a department. In this example, the Departments table provides the master information, i.e., a department, and the Employees table provides the details, i.e., the employees in a chosen department.

Master-detail links are used by Form Generator, Report Generator, Visual Basic Generator and Web PL/SQL Generator.

•	Inverted master-detail links represent foreign key/domain key constraint relationships between table usages. This type of link represents an unusual structure, and is therefore rarely used. When shown on a Module Diagram, this type of link is shown as a vertical line with a 'crowsfoot'. The 'crowsfoot' is attached to the detail end of the link, as shown below. The module component table usage, to which the 'crowsfoot' is attached, represents the table that contains the foreign key or domain key constraint

This type of link is typically used to provide 'master' information for a chosen 'detail' record. For example, you may want to show the department in which an employee works. Note that, for this type of link, only one department will be shown for an employee.

Inverted master-detail links are used by Report Generator and Web PL/SQL Generator.

•	Same table links represent primary key relationships between table usages. They are shown on Module Diagrams as a vertical line with no 'crowsfoot', as shown below. This type of link is used to provide additional information about a record, on two different parts of a generated application. Same table links are always used to link two usages of the same table.

Same table links are used by Report Generator, Visual Basic Generator and Web PL/SQL Generator.

•	Across module links represent domain key, foreign key and primary key relationships between table usages in different modules. They are shown on Module Diagrams as a horizontal line. If the link represents a foreign key or domain key relationship, a 'crowsfoot' is displayed at one end of the link. If the link represents a primary key relationship, no crowsfoot is shown. The names of both the module component and the table usage, to which the link is connected, are shown on the external module.

This type of link is used to provide information based on a foreign key, primary key or domain key, to a different generated application.

Different module links are used by Visual Basic Generator and Web PL/SQL Generator.

See also Module Networks.

--------------------------------------------------------------------------------------------------

Key based link definition properties

Owning Container

From

Module

Module Component

From Table Usage

To

Module

Module Component

Version

To Table Usage

Key

Join Constraint

Primary Key

Join

SQL Query Clause

Fkey on 'From' Component ?

Documentation

Description

Notes

Related Topics

Module Components

Table Usages


Mandatory
The name of the foreign key or domain key constraint that links the two module components.


Mandatory
The name of the primary key constraint that links the two module components.


Identifies whether the foreign key that implements the link is defined on the 'From' table usage or the 'To' table usage. This property is required only when the 'From' and 'To' table usages are based on the same underlying table, because when the usages are based on different tables the foreign key location is clear.

Default: No


Mandatory
The name of the table usage from which the key based link originates.


Mandatory
The name of the table usage that identifies the destination of the key based link.


Table usage links

About table usage links

A table usage link identifies the relationship between two table usages in the same module component, sub-component or List of Values component. The relationship is always via a foreign key constraint or a domain key constraint. Links that go between table usages in different module components are called key based links.

These types of links are used by the application generators to understand the relationship between bound items from different table usages and to form the links between tables in the SQL queries they generate.

When represented on Module Diagrams and Reusable Component Diagrams, table usage links can be seen from the Data view only.

These types of links are defined by setting properties against Table Usage repository definitions.

Types of table usage links

•	Lookup links represent the foreign keys or domain keys that are used to create lookup table usages. A lookup link can exist between a table usage of any type and a lookup table usage, although it is usually only from a base or another lookup table usage. The example below shows how a lookup link is represented on a diagram. The 'crowsfoot' is attached to the table usage for which the foreign key or domain key is defined.

Lookup links are used by Form Generator, Report Generator, Visual Basic Generator and Web PL/SQL Generator.

•	Single row SQL aggregate and sub-query links represent the foreign keys or domain keys that are used to create single row SQL aggregate table usages and sub-query table usages. These types of links can be connected to both base table usages and lookup table usages. The 'crowsfoot' is attached to the table usage for which the foreign key or domain key is defined.

Single row SQL aggregate and sub-query links are used by Report Generator and Web PL/SQL Generator.

•	Treewalk links are based on recursive foreign keys or domain keys. They are used by Report Generator and Web PL/SQL Generator to search up or down a table, from a specified point, to present data in a hierarchical order. Treewalk links can present hierarchical data from one or more tables.

If a treewalk link is based on a single table, then the link starts and ends on the same table usage. This can be represented on Module Diagrams and Reusable Component Diagrams, as shown below. This type of link is defined for base table usages only.

If a treewalk link is based on more than one table, it is represented on Module Diagrams and Reusable Component Diagrams as shown below. Note, to implement a treewalk link as shown below, more than one foreign key or domain key must exist between the two tables, e.g., one to implement the lookup link and one to implement the treewalk link.

Treewalk links are used by Report Generator and Web PL/SQL Generator.


Languages

Language elements define the languages that are available for use by modules, e.g. Oracle Forms. When you create a module in the repository, you must specify the module's language. The System Folder contains a predefined set of languages that you can use. You can also create additional languages for modeling purposes. Any languages that you create cannot be used by the Generator products.

Use the Repository Object Navigator to create language elements in the repository.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Language definition properties

Owning Container

Name

Version

Type

Module Defaults

Source Directory

Runtime Directory

Command Line

Documentation

Comment

Description

Notes

Related Topics

Modules

Module Weighting Factors


Mandatory, 40 characters
The name of this language.


Optional
A classification for modules written in this language: Report, Screen, Utility or null.  The Application Design Transformer uses this value to classify modules for menu generation.


Optional, 240 characters
The default source directory of the modules that are written in this language.


Optional, 240 characters
The default runtime directory of modules that are written in this language.


Optional, 100 characters
The default command line used to invoke modules that are written in this language.


Optional, 240 characters
A brief description or comment for this language.


List of values inclusions

About lists of values inclusions

A list of values inclusion is a repository definition that records the usage of a List of Values component by a module and the item with which the List of Values component is associated.

On Module Diagrams, a LOV inclusion is represented by default as a gray rectangle to the left of a LOV component, as shown below. If the LOV component is associated with an item the name of the item is displayed on the LOV inclusion diagram element, otherwise the LOV component is unassociated.

For more information about lists of values, see About lists of values.


The order of the list of values relative to other lists of values in the module.


 The name of the item associated with the list of values.


Optional, 6 digits
For Form Generator - X coordinate of the top left hand corner of the LOV.

These Generators use this property. Click for more information:


Optional, 6 digits
For Form Generator - Y coordinate of the top left hand corner of the LOV.

These Generators use this property. Click for more information:


 Optional, 2000 characters
A list of mappings between items in the list of values and in the module component. Items in the list should be separated by commas, e.g., EMP.ENAME = MYLOV.ENAME, EMP.EMPNO = MYLOV.EMPNO, where EMP is the alias of the module component and MYLOV the alias of the LOV component.

These Generators use this property. Click for more information:


 Controls whether a search or query dialog is displayed prior to displaying the LOV. This allows the user to specify search criteria to reduce the number of rows displayed in the list and, consequently, reduce the time taken to display the LOV.

These Generators use this property. Click for more information:


 An extra restriction to be applied to the resulting query, e.g., my_dtu_alias.job = emp.job and my_dtu_alias.startdate < sysdate. This condition is in addition to the LOV table usage's WHERE Clause of Query property and Validation WHERE Clause property.

These Generators use this property. Click for more information:


 Indicates where the additional restriction is to be inserted in the SQL statement.

These Generators use this property. Click for more information:


 Indicates the mode in which the list of values is available, i.e., Data Entry, Query or Data Entry and Query.

These Generators use this property. Click for more information:


 Optional, 70 characters
The title displayed for the included list of values component in a generated application. This property is useful for identification purposes when a single LOV component is included more than once in a module.

These Generators use this property. Click for more information:


Lists of Values (LOVs) components

About LOV components

LOV component definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About lists of Values components

This type of repository definition records information about lists of values to be used in generated applications. Lists of Values (LOVs) are used in generated applications to assist with data entry and validation, thus helping to guarantee the integrity of data.

Note:	In generated applications, lists of values are displayed in separate windows or popups, from which the required value can be chosen.

Within the repository, LOV components allow lists of values to be modeled separately from other information that is to appear on a generated application. A LOV component may be either reusable (i.e., common to more than one module) or specific to a single module.

LOV components are ordinarily associated with a bound or unbound item. One or more LOV components can be associated with a single item, typically because a different LOV is required for Query rather than Data Entry. Another reason could be that the item is in a reusable module component. Here, each inclusion of the reusable module component may require a different list of values to be displayed according to the context of the module in which the module component is included.

Note:	If you do not associate an LOV with an item you must define the appropriate application logic to display the LOV when required.

The values a LOV returns to its calling module component are defined by a "free-format" text string comprising mappings between LOV items and module component items. The Return List property may define mappings to items in any module component in the module, although typically this would be the same component as the item with which the LOV is associated.

On Module Diagrams, a LOV component is represented by default as a gray rectangle, as shown below. LOV components are always displayed after all module components and sub-components on the diagram.

LOV inclusion elements are displayed to the left of each LOV component, identifying items with which the LOV component is associated.  About

Each item with which an LOV component is associated has the name of the LOV displayed next to it on a Module Diagram.

List of Values component definition properties.

Owning Container

Module

Name

Version

Short Description

Template/Library Object

Module

Usage Sequence

Item

Return List

Filter Before Display ?

Restriction

Used For

Additional Restriction

Restriction Clause

Placement

X Position

Y Position

Display

Title

Layout Style

Rows Displayed

Title Override

Size

Width

Height

Help

User/Help Text

Help Context ID Prefix

Documentation

Description

Notes

Related Topics

Modules

Module Components

Module sub-components

Table Usages


Optional, 30 characters
For Form Generator - The name of a template, or object in the object library on which the generated list of values is to be based.

These Generators use this property. Click for more information:


Optional, 3 digits
A prefix for generated Help context IDs to ensure they are unique throughout an entire application. This prefix must be unique for every module and reusable module component included in the Help file.


Optional
Not used by the Generator products.


Mandatory
The name of the module within which the list of values has been included.


Module change history

About module change history definitions

Logs the changes that are made to a module and records the location in which those changes are being made. The control of versions and releases of modules is thus made easier if your repository is not under version control.

Use the Repository Object Navigator to create module change history definitions in the repository.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Module change history definition properties

Owning Container

Module / PLSQL / Java Def

Reference

Version

Change History

Developer

Directory

Version

Date Out

Date Complete

Short Description

Date Transferred Back

Transferred By

Related Topics

Modules


Display only
The name of the module that is affected by the changes.


Mandatory, 10 characters
A unique reference for the change. This field can be a reference to your 'Change Control' system.


Mandatory, 20 characters
The name of the person who is implementing the change.


Mandatory, 30 characters
The location (e.g., a directory) in which the change is to be implemented.


Mandatory, 10 characters
The version of the module or the phase of development.


Mandatory, date
The date when the module was copied into the developer's working area ready for the change to be made. The default is today's date.


Optional, date
The date when the change was completed.


Mandatory, 240 characters
A description of the change to be made to the module.


Optional, date
The date when the module is returned to the production or system test environment.


Optional, 30 characters
The name of the person who transferred this module to the production or system test environment.


Module component inclusions

A module component inclusion is a repository definition that records the association between a module component, or sub-component, and the module within which it is included.

For more information about module components, see About module components.

Related Topics

Modules

Module Components

Module sub-components


The name of the module within which the module component is included.


The name of the module component within which the element is included.


Optional
Used in conjunction with the Placement property to define module components that are to be positioned side-by-side on a generated application. This property specifies the name of a module component to the right of which this module component will be displayed.

For Form Generator - This property also applies to sub-components.

These Generators use this property. Click for more information:


Optional
Determines how generated module components are placed in the context of a window placement item (specified using the Window property). Valid values for each Generator are shown in the table below:

Forms	Visual Basic
New Tab canvas page
New content canvas	Stacked
New stacked canvas
Same content canvas
Same Tab canvas page
Same stacked canvas
Right of

For Form Generator - This property also applies to sub-components.

These Generators use this property. Click for more information:


Optional, 6 digits
For Form Generator - If the module component/sub-component is generated as the first block/layout region in a window, this specifies the default X coordinate of the top left corner of the window.  If the module component/sub-component is generated as the first block/layout region of a stacked canvas, this specifies the X coordinate of the top left corner of the view of the stacked canvas on the underlying content canvas.

These Generators use this property. Click for more information:


Optional, 6 digits
For Form Generator - If the module component/sub-component is generated as the first block/layout region in a window, this specifies the default Y coordinate of the top left corner of the window.  If the module component/sub-component is generated as the first block/layout region of a stacked canvas, this specifies the Y coordinate of the top left corner of the view of the stacked canvas on the underlying content canvas.

These Generators use this property. Click for more information:


Mandatory, 6 digits
The order of the module component relative to other module components in the module.

For Form Generator - This property also applies to sub-components.

These Generators use this property. Click for more information:


Optional
The name of the window definition within which the module component is to be placed. In the generated application, the module component details are shown within the layout object that is generated from this window definition.

For Form Generator - This property also applies to sub-components.

These Generators use this property. Click for more information:


 Specifies whether Form Generator aligns items inside the module component with items outside the module component that have the same relative tab stops.

Valid values are:

Valid Values	Meaning
None (Default)	Form Generator ignores relative tab stops.
Self	Items within the module component are not aligned with items outside the module component.
Parent	Items within the module component are aligned with items outside the module component.
These Generators use this property. Click for more information:


 Optional, 30 characters
Specifies an object library implementation source object for generated canvases. Form Generator uses this property to determine an object library implementation source object when creating a new canvas (i.e. when the placement property is set to 'new content canvas'/'new stacked canvas'/'new tab canvas'). If a template/library object for a placement of 'same stacked canvas', 'same content canvas' or 'same tab canvas' is defined, the specified implementation object is ignored.

These Generators use this property. Click for more information:


 The name of the component that is placed to the right of the module component. This property is used when the module component's Placement property is set to 'Right of'.


About module components
Module components

About module components

Module component definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About module components

Module components are the building blocks of client application design. They are used to define discrete groups of information, which in turn are held within module definitions. Each module component may or may not contain table usages. A module component that does not contain table usages is referred to as a control block.

A module component may be either reusable (i.e., common to more than one module) or specific to a single module.

Like modules, each module component has a specified language, e.g., Oracle Forms. When included in a module of the same language, a module component can represent:

•	a block on a generated form

•	a zone on a generated Visual Basic application

•	a group on a generated report

•	a record list on a generated PL/SQLWeb application

Note:	The language of a module component must be the same as the module by which it is used. During generation, the application generators ignore any module components that do not have an appropriate language.

On Module Diagrams, a module component is represented by a gray rectangle, as shown below.

Specific module components can be edited graphically using Module Diagrams. Reusable module components can be edited graphically using Reusable Component Diagrams.

--------------------------------------------------------------------------------------------------

Module component definition properties

Owning Container

Module

Name

Version

Short Description

Template/Library Object

Language

Module Level ?

Sub-component

Usage Sequence

Placement

Window

Placement

Right of Component

Placement Template/Library Obj

X Position

Y Position

Relative Tab Stops

Tab Stop Scope

Data

Datasource Type

Datatarget Type

Operations

Insert ?

Delete ?

Update ?

Query

Query ?

Autoquery ?

Display

Title

Layout Style

Rows Displayed

Overflow

Size

Width

Height

View Width

View Height

Help

User/Help Text

Help Context ID Prefix

Documentation

Description

Notes

Related Topics

Modules

Module sub-components

Table Usages


Mandatory
The type of application that is expected to be generated from this module component.

These Generators use this property. Click for more information:


Mandatory
The name of the module within which the module component has been included.


Indicates whether a generated module component should automatically query records. A value of 'Default Behavior' indicates that the Generator decides.

These Generators use this property. Click for more information:


Mandatory, 16 characters
The type of data source from which the generated module component retrieves data. Valid values for each Generator are shown in the table below:

Form Table	Web PL/SQL Query	Visual Basic Query
View
Query
PL/SQL Procedure
Valid Values: None, PL/SQL Procedure, Query, Table, View
Default: Table

These Generators use this property. Click for more information:


Mandatory, 16 characters
The type of data target through which the generated module component writes data. Valid values for each Generator are shown in the table below:

Form Table	Web PL/SQL PL/SQL Procedure	Visual Basic Table
Transactional Triggers
PL/SQL Procedure
Valid Values: None, PL/SQL Procedure, Table, Transactional Triggers
Default: Table

These Generators use this property. Click for more information:


Indicates whether new records can be added using this module component. If set to Yes, INSERT operations are allowed.

These Generators use this property. Click for more information:


Indicates whether QUERY operations are allowed using this module component. If set to Yes, QUERY operations are allowed.

These Generators use this property. Click for more information:


Indicates whether records can be updated using this module component. If set to Yes, UPDATE operations are allowed.

These Generators use this property. Click for more information:


Indicates whether records can be deleted using this module component. If set to Yes, DELETE operations are allowed.

These Generators use this property. Click for more information:


Optional, 30 characters
The name of a template, or object in the object library on which the generated module component is to be based.

These Generators use this property. Click for more information:


Indicates whether or not this is a 'module-level' module component. Module-level components must be specific to a particular module and they contain only unbound items (they do not contain table usages). For example, module-level computed report summaries.

Default: No

These Generators use this property. Click for more information:


Determines what action Form Generator takes if the canvas generated for this module component is not wide enough to show a row on a single line. The options are:

<Null>	Overflow information is not displayed.
Overflow Area Below	An overflow area is created below any context items.
Overflow Area Right	An overflow area is created to the right of any context items.
Spread Table	A spread table is created to the right of any context items for the overflow.
Wrap Line	Multi-line rows are created if a row does not fit on a single line.
These Generators use this property. Click for more information:


Optional, 6 digits
For Form Generator - If the module component is generated as the first block on a stacked canvas, this specifies the height of the view on the stacked canvas.

These Generators use this property. Click for more information:


Optional, 6 digits
For Form Generator - If the module component is generated as the first block on a stacked canvas, this specifies the width of the view on the stacked canvas.

These Generators use this property. Click for more information:


Optional, 3 digits
A prefix for generated Help context IDs to ensure they are unique throughout an entire application. This prefix must be unique for every module and reusable module component included in the Help file.

These Generators use this property. Click for more information:


Optional
End-user text or help text for generated applications.

Language	Use in generated application
Oracle Forms	Help text can be generated in MS Help format or displayed in a specified Oracle Forms module.
Web PL/SQL	Text defined here can appear on the module component's Record List, View Form, Insert Form or Delete Form.
Visual Basic	Help text can be generated in MS Help format.
These Generators use this property. Click for more information:


About module sub-components
Module sub-components

About module sub-components

Module sub-component definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About module sub-components

Module sub-components are used to define multi-region blocks for generated Oracle Forms applications.

Each module sub-component may or may not contain base and lookup table usages. If a sub-component does contain table usages, it must have the same base table as the owning module component, otherwise errors will be reported during application generation.

On Module Diagrams, a module sub-component is represented by a gray rectangle connected to a primary module component via a sub-component link, as shown below.

Note:	If a reusable component has a sub-component prior to being included in a module, the sub-component is available to the module. However, if a sub-component is added to a reusable component after the reusable component has been included in a module, then the sub-component is not available to the module.

--------------------------------------------------------------------------------------------------

Module sub-component definition properties

Owning Container

Module

Module Component

Version

Name

Short Description

Sub-component

Usage Sequence

Placement

Window

Placement

Right of Component

Placement Template/Library Obj

X Position

Y Position

Relative Tab Stops

Tab Stop Scope

Display

Title

Layout Style

Rows Displayed

Overflow

Size

Width

Height

View Width

View Height

Documentation

Description

Notes

Related Topics

Modules

Module Components

Table Usages


Display only
The name of the module component with which the sub-component is associated.


 Determines what action Form Generator takes if the canvas generated for this module component is not wide enough to show a row on a single line. The options are:

<Null>	Overflow information is not displayed.
Overflow Area Below	An overflow area is created below any context items.
Overflow Area Right	An overflow area is created to the right of any context items.
Spread Table	A spread table is created to the right of any context items for the overflow.
Wrap Line	Multi-line rows are created if a row does not fit on a single line.
These Generators use this property. Click for more information:


Optional, 6 digits
For Form Generator - If the sub-component is generated as the first layout region on a stacked canvas, this specifies the width of the view on the stacked canvas.

These Generators use this property. Click for more information:


Optional, 6 digits
For Form Generator - If the sub-component is generated as the first layout region on a stacked canvas, this specifies the height of the view on the stacked canvas.

These Generators use this property. Click for more information:


Table usages

About table usage links

Table usage definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About table usages

A table usage records details about a database table that is used by a generated application. Any given table may be used one or more times. Table usages can be created within module components, module sub-components and List of Values (LOV) components. The application generators determine from the components which tables are to be used by a generated application.

Note:	It is recommended that each table usage name (specified by the Usage Alias property) is unique from all other table usage names and component names (including reusable components) in a module.

Links between table usages within a single module component, sub-component or List of Values component are called table usage links.

On a Module Diagram or Reusable Component Diagram, a table usage is represented by a rectangle within a module component, sub-component or LOV component as shown below:

The following types of table usage exist:

•	 Base table usages

A base table usage is the main table within a module component, sub-component or LOV component. The operations that can be performed on a base table are specified against the owning component, using the Usage flags.

•	 Lookup table usages

A lookup table, as its name suggests, can provide lookup, or additional, information only to a base table. Lookup tables cannot be updated.

•	 Single row SQL Aggregate table usages

A single row SQL aggregate table usage is used to define a SELECT statement that returns a single result for every row queried in the master (base) table. This type of table usage is used by Form Generator (for LOV generation only), Report Generator and Web PL/SQL Generator.

For example, to create a report that shows the sum of the employee salaries for each department, a module component would need to contain the Departments table (the base table usage) and the Employees table (a single row SQL aggregate table usage). In addition to the table usages, an unbound item of type SQL Aggregate must also be defined in the module component. The unbound item is used to store the derivation text that identifies the value that is to be returned, e.g. a SUM function

•	 Sub-query table usages

A sub-query table usage is used to define a SELECT statement that is nested within another SELECT statement. Sub-query table usages are useful where the rows that are to be selected from a table must satisfy a condition that depends on the data in that table. This type of table usage is used by Form Generator (for LOV generation only), Report Generator and Web PL/SQL Generator.

•	Untyped table usages

An untyped table usage is created when the Usage Type property for the table usage is set to Null. This type of table usage can be created during design recovery of a client application into the repository. You should ensure that there are no untyped table usages in a component before using the application generators.

--------------------------------------------------------------------------------------------------

Table usage definition properties

Owning Container

Module Unit

SQL Query Set

Table/View/Materialized view

Usage Alias

Version

Name in Database

Partition

Usage Type

Query

WHERE Clause of Query

Select Distinct?

Link

Link To

Via Join Constraint

Outer Join ?

Lookup

Validation WHERE Clause

Sub Query

Not Exists ?

Tree Walk

Via Pig's Ear Join Constraint

Via Network Join Constraint

Connect By Clause

Start With Clause

Direction

Documentation

Comment

Description

Notes

Related Topics

List of Values Components

Modules

Module Components

Tables

Items


Mandatory
The name of the SQL Query Set to which the table usage belongs.


Optional
A CONNECT BY clause that restricts the number of rows returned in a hierarchy of data.

These Generators use this property. Click for more information:


 Mandatory, 30 characters
A unique name for the table usage within the component. This property is used within the FROM clause of generated SQL statements and to identify columns in PL/SQL procedures and function calls. If you do not enter a value in this property, a default is automatically provided.

Note: It is recommended that each table usage name (specified by the Usage Alias property) is unique from all other table usage names and component names (including reusable components) in a module.

Note: Some of the generator products impose a limit on the number of characters that you should enter for this property. These Generators use this property. Click for more information:


Display only
The name of the component for which the table usage is defined.


Optional, 100 characters
The name to be used by Generators instead of the table/view/materialized view name within the FROM clause of generated queries. This name is used without any user/schema prefix, regardless of preference settings (TABOWN). A suggestion list displays the Global Synonym Names for all implementations of the relation but free-format text may also be entered here.

These Generators use this property. Click for more information:


Optional
The name of a partition to which use of this table is restricted.

These Generators use this property. Click for more information:


Display only
The name of the table, view or materialized view that the module is to use.

Note: Some of the generator products impose a limit on the number of characters that should be used for the name of the table, view or materialized view on which the usage is based.


Determines whether a base table usage, a lookup table usage or a Single Row SQL Aggregate table usage has an associated outer join. A value of 'Default Behavior' means that the Generator decides.

Note, only Report Generator uses this property for base table usages.

These Generators use this property. Click for more information:


Indicates whether the query is required to do SELECT DISTINCT. Applies to base table usages only.

Default: No

These Generators use this property. Click for more information:


Optional

The type of table usage. The options are: base, lookup, sub-query or single row SQL aggregate.

These Generators use this property. Click for more information:


Defines a link between two table usages in conjunction with the Via Join Constraint property. The list contains all of the table usages for the module. The table usages are identified by their aliases.

The table usage from which the link is being created must have a higher sequence number than the table usage that is selected from this list.


Defines a link between two table usages in conjunction with the Link To property. This list contains all of the foreign keys that exist for the tables used by the module.


Optional, 240 characters
A comment on the use of this table by the module.


Optional
SQL expression to restrict values from a lookup table that are available when entering or modifying data.

These Generators use this property. Click for more information:


Defines a treewalk link that is based on more than one table. Note, you must specify the table usage to which the lookup table usage is linked, using the Link To property. You must also specify the key that implements the link, using the Via Join Constraint property.

These Generators use this property. Click for more information:


Indicates whether the sub-query should be a logical 'NOT EXISTS'. This property is only relevant when the Table Usage Type is defined as SUB-QUERY.

These Generators use this property. Click for more information:


Optional
A WHERE/Validation condition to be applied to the table. Note that you should not enter the "WHERE" keyword itself.

Defines a SQL expression to:

•	restrict the values returned from a query on a table (base tables and lookup tables)

•	restrict the values from a lookup table that are available when querying data (lookup tables only)

These Generators use this property. Click for more information:


Optional
A START WITH clause which provides a starting point for the hierarchy of data.

These Generators use this property. Click for more information:


Defines a treewalk link that is based on a single table.

These Generators use this property. Click for more information:


Controls the direction of the treewalk.

Default: Down


Module weighting factors

About module weighting factors

Records, displays and maintains the standard estimates for building the modules.

Estimating the resource requirement and managing the build stage of an implementation is an important task. It is helpful to assess the resource capability allocated to a project and derive standard estimates of 'effort required' to build each type of module.

A module weighting factor definition can be created using the Repository Object Navigator.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Module weighting factors definition properties

Owning Container

Language

Complexity

Type

Version

Estimate

Units

Related Topics

Modules


The module type (e.g., Screen, Cursor).


The complexity of this module. The options are:

Average
Difficult
Easy


Display only
The language in which the module is written.


Optional, 8 digits
An estimate of the time needed to complete this type of module.


Optional, 10 characters
The units of time in which the estimate is measured.

Note:  It is advisable to use the same units for the build estimates of modules that are to be used together.


Modules

About modules

Module definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About modules

A module definition is used to record details about client applications in the repository. A property (called Language) identifies the type of information that is recorded by the module. For example, if the language is set to Visual Basic, then the module definition records details for a Visual Basic application.

The icons shown below are displayed next to modules to identify the module language.

Icon	Module Language
	Oracle Common Library
	Oracle Forms
	Oracle Reports
	Oracle Web PL/SQL
	Visual Basic
	All non generatable modules, i.e., PASCAL, COBOL
In addition to the icons that identify a module's language, the following icons are used to identify whether a module is a candidate module or whether it is of type menu or library. These icons override the module language icons. For example, the icon displayed beside a module of language Oracle Forms and type menu will be the menu icon and not the form icon.

Icon	Module Type
	Menu module
	Library module
	Candidate module, i.e., generated by the Application Design Transformer. Changing the module's Candidate property to No will change the icon to the correct language for the module.

It is possible to generate different types of applications from a module definition without changing the module language. For example, an Oracle Forms application can be generated from a Visual Basic module definition, using the Oracle Designer Generate As utility. When a module definition is used to generate a different type of application, the generators provide default values where information is missing and ignore any information that is not relevant to the type of application that is being generated.

Module definitions from which applications are to be generated should contain at least one module component. These components specify the tables and columns that are to be used by a generated application. In addition to module components, sub-components and Lists of Values components can also be used to further enhance the module design.

Reusable components can also be used by modules to support the reuse of common functionality.

Module definitions can be created and maintained using Module Diagrams. These diagrams present the module definition graphically and provide both a Data and a Display view.

On Module Diagrams, the default representation of a module definition is a green rectangle, as shown below.

Note:	This example shows a Module Diagram that is set to Data view.

--------------------------------------------------------------------------------------------------

Module definition properties

Owning Container

Short Name

Version

Name

Language

Purpose

Implementation Name

Module Type

Display

Top Title

Bottom Title

Short Title

Layout Format

Planning

Status

Candidate ?

Prevent generation ?

Size

Complexity

Project

Activity

Task

Time Estimate

Estimate Units

Invocation

Top Level ?

Command Line

Return Type

Runtime Path

Source

Source Path

Help

User/Help Text

Help File Name

Help Graphic File Name

Help Context ID Prefix

Documentation

Release Notes

Description

Notes

Related Topics

Item Groups

Languages

List of Values Components

Module Components

Module Networks

Oracle User Module Accesses

Parameters (i.e., Arguments)

Table Usages


Optional
The type of application expected to be generated from this module definition. To create a module definition that can be used for generation, the module language must be set to one of the predefined languages defined in the System Folder. Therefore, the System Folder must be visible to your workarea when you create module definitions.

Note:	When changing a module's language, the languages for module components within that module remain unchanged. Instead of changing the module language you can use the Copy with New Language utility to create a new module (and components) with the required language.

These Generators use this property. Click for more information:


Optional, 30 characters
A base name for the generated files and objects. The Implementation Name takes precedence over the Short Name.

Note: Some of the generator products impose a limit on the number of characters that you should enter for this property. These Generators use this property. Click for more information:


Indicates whether an application can be generated from this module. If set to Yes, an application cannot be generated from the module definition. This property may be used to ensure that completed applications do not get overwritten.

Default: No


The format in which the generated application is laid out.

Language	Format	Resulting Layout
Oracle Forms	Master/Detail	Default layout; detail block displays information about record in master.
Oracle Forms	LOV	Form module generated as query-only list of valid values.
Oracle Forms	Navigator	Form module generated as a navigator style form.
Oracle Reports	Control Break	Tabular layout style for all groups.
Oracle Reports	Label	Address layout style for all groups.
Oracle Reports	Master/Detail	Form layout style for groups with child groups and tabular layout style for groups with no child groups.
Oracle Reports		Across layout style for all groups within the Across master hierarchy. Tabular layout style for all groups in the down master/cell hierarchy.
These Generators use this property. Click for more information:


Optional, 70 characters
The main title for this module in the generated application.

These Generators use this property. Click for more information:


Optional, 70 characters
The title for the bottom of generated report page or screen.

These Generators use this property. Click for more information:


Optional, 70 characters
The title used on menus, buttons or hyperlinks generated to navigate to this module.

These Generators use this property. Click for more information:


Indicates the way in which you expect to implement the module in a given language. The DEFAULT value represents the way modules are most frequently implemented in a specific language.

For example, if you intend to implement a module in the Oracle Forms language, use DEFAULT to indicate that you expect to implement the module as a form. If you intend to implement a module in Oracle Reports, use DEFAULT to indicate that you expect to implement the module as a report.

These Generators use this property. Click for more information:


Optional, 70 characters
The datatype of the value returned by the module. This property is not used by the generator products.


Optional, 2000 characters
The command line used to invoke this module within the generated application.

These Generators use this property. Click for more information:


Optional, 132 characters
The full pathname of the runtime file. To ensure portability of generated applications, it is recommended that you do not specify a Runtime Path.

These Generators use this property. Click for more information:


Optional, 100 characters
The name of the compiled Windows Help file (.HLP) created for this module and its associated module network. Specify this property only against the top-level module of a Help file. If this property is not defined, this module's Help text will be incorporated into the Help file of the nearest parent module, where the property is defined.

These Generators use this property. Click for more information:


Optional, 60 characters
The name and file extension of the graphic file used to illustrate the module topic. Acceptable file formats are Bitmap (.BMP), Windows Metafiles (.WMF) and Multi-resolution Bitmaps (.MRB).

These Generators use this property. Click for more information:


Optional, 3 digits
A prefix for generated Help context IDs to ensure they are unique throughout an entire application. This prefix must be unique for every module and module component included in the Help file.

These Generators use this property. Click for more information:


Optional
End-user text or help text for generated applications.

Language	Use in generated application
Oracle Forms	Help text can be generated in MS Help format or displayed in an Oracle Forms module.
Web PL/SQL	User text appears on the module Startup Page (and About Page).
Visual Basic	Help text can be generated in MS Help format.
These Generators use this property. Click for more information:


Module networks / PL/SQL composition

About module networks

Module network definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About module networks / PL/SQL Composition

Module networks and PL/SQL compositions describe relationships between modules / PL/SQL definitions.

For client modules, a module network describes:

•	the modules calling a particular module (the calling modules are referred to as parent modules)

•	the modules that are called by a particular module (the called modules are referred to as child modules)

For PL/SQL definitions, a PL/SQL composition (also called module network) describes the structure of packages and calls between PL/SQL definitions.

Note:	The modules that are called within a module network are referred to as 'called modules'. The PL/SQL definitions that are called within a PL/SQL composition are referred to as 'sub program units'.

The Oracle Designer generators can use a module network to provide mechanisms (e.g., buttons, menus) to call child modules from parent modules in generated applications.

For example, a generated application might comprise a form and a report (Form A and Report B) generated from two different repository module definitions (Module A and Module B). To enable a user running Form A to call Report B, you would define a module network in which Module A was the parent module and Module B the child. Form Generator could then generate a button in Form A to call Form B. You might visualize such a module network as follows:

If you created a third repository module (Module C) and defined it as the parent of both module A and module B, you could generate Module C as a menu with two options enabling users to access both Form A and Report B. You might visualize such a module network as follows:

On Module Diagrams, links are used to represent module networks. However, module network links can be seen only when Module Diagrams are set to Data view.

--------------------------------------------------------------------------------------------------

Module network definition properties

Owning Container

Parent Module / PL/SQL / Java

Child Module / PL/SQL / Java

Version

Called Sequence

Method Of Use

Related Topics

Modules


Display only
The name of the parent module, i.e., the module calling or including the child module.


 Display only
The name of the child module, i.e., the module called by or included by the parent module.


 Mandatory, 3 digits
The sequence of the module under the parent. The lower numbers in the sequence are called first.


 Optional, 9 characters
The method by which the module is called by its parent. The options are:

<Null>	The type is unspecified.
Call	The child module is invoked by the parent module.
Include	The child module is included within the parent module. This method is used to include PL/SQL procedures and functions within a package.


Navigation action items

About navigation action items

Navigation action item definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About navigation action items

A navigation action item represents an interface object that allows navigation either within a generated application or to another generated application.

Navigation action items can be created for module components, sub-components and windows whose language is set to one of the following:

•	Oracle Forms

•	Oracle Reports

•	Oracle Web PL/SQL

•	Visual Basic applications

For Oracle Forms modules and Oracle Reports modules, navigation action items can be used to generate buttons only. For Oracle Web PL/SQL modules navigation action items can be used to generate hyperlinks, image links and buttons. For Visual Basic applications navigation action items can be used to generate both menu options and buttons.

Each navigation action item has a source and a destination, which can be represented graphically on Module Diagrams. Navigation links are used to identify the source, destination and direction of the navigation action item. From Module Diagrams, navigation links can be seen from Display view only.

If two module components in the same module are linked together via a key based link and the module components do not appear in the same window, a navigation action item is created automatically. Similarly, if a module network link is created between two modules, a navigation action item is created automatically.

--------------------------------------------------------------------------------------------------

Navigation action item definition properties

Owning Container

Module Component

Window

Name

Version

Usage sequence

Default ?

Template/Library Object

Navigate To

To Module Component

To Module Network

Display

Prompt

Icon Name

Create Button ?

Button height

Button Width

Create Menu Item ?

Help

Hint

User/Help Text

Documentation

Description

Notes

Related Topics

Modules

Module Components

Windows


Indicates whether a button is to be created for this navigation action item.

Default: Yes

These Generators use this property. Click for more information:


Indicates whether a menu item is to be created for this navigation action item.

Default: No

These Generators use this property. Click for more information:


 Identifies the module component to which this navigation action item navigates in a generated application.

These Generators use this property. Click for more information:


 Identifies the module to which this navigation action item navigates in a generated application.

These Generators use this property. Click for more information:


Oracle user module accesses

About Oracle user module accesses

Records the modules to which an Oracle user or role has access.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Oracle user module access definition properties

Owning Container

Database User

Module

Version

With Grant Option ?

Related Topics

Modules


 Display only
The user/role to be granted access to the module.


 Display only
The module to which the user/role has access.


 Indicates whether the user/role will be allowed to grant permissions for the module to other users. Set this to Yes if the user/role will have the authority to grant privileges for this module to other users/user groups.

Default: No


Passed values

About passed values

A passed value is a repository definition that records details about values that are to be passed from a calling module to a called module. Passed values are used during the design of Oracle Forms modules and Oracle Reports modules only.

There are two types of passed values:

•	argument passed values, which are passed from a calling module into user-defined arguments in the called module

•	named passed values, which are passed from a calling module into predefined (or standard) arguments

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Passed value definition properties

The property palette that is displayed for argument passed values shows the properties listed below.

Owning Container

Parent Module

Child Module

*Module Argument

**Name

Version

Passed From

Argument in Caller

Item in Caller

Value

Documentation

Description

Notes

* Argument passed values only

**Named passed values only

Related Topics

Modules

Module Networks


 Display only
Identifies the status of the module or PL/SQL definition in the module network.


 Mandatory
The name of the called argument (in the called module) into which the value will be passed.


 Mandatory
The name of the called value (in the called module) into which a value will be passed.


 Optional
The name of the argument whose value is to be passed to the called module.


 Optional
The name of the item whose value is to be passed to the called module.


 Optional, 240 characters
A literal value to be passed to the argument of the called module.


Problems to modules

About problems to modules

Records the resolution of a problem by the implementation of a module or several modules.

Use the Repository Object Navigator to create problem to modules definitions.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Problems to modules definition properties

Owning Container

Problem

Module / PLSQL / Java Def

Version

Contact

Documentation

Comment

Related Topics

Modules


 Display only
The name of the problem.


 Display only
The name of the module, PL/SQL definition or Java definition with which the problem is associated.


 Optional, 70 characters
A comment or brief description about this instance of the problem solution.


 Optional, 30 characters
The person or committee that can be contacted about this instance of the problem solution.


Role module accesses

About role module accesses

Role module accesses are repository definitions that record the modules to which roles have access.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

Role module access definition properties

Owning Container

Role

Module

Version

With Grant Option ?

Related Topics

Roles


Display only
The name of the role that has access to the module.


Display only
The name of the module to which the role has access.


Indicates whether the role has the authority to grant access privileges to other users.

Default: No


SQL query sets

About SQL query sets

A SQL query set is a repository definition that enables you to define a query that can be combined with a module component's or LOV component's base table query. The main query is defined by a module/LOV component and additional queries are defined by SQL query sets.

The application generators, e.g. Report Generator, create the combined query by inserting a UNION operator between the main query and the queries defined in each SQL query set. For example, in the following query, SQL Statement A is defined by the module component and SQL Statements B and C are defined by SQL query sets:

(SQL statement A) UNION (SQL statement B) UNION (SQL statement C)

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

SQL query set definition properties

Owning Container

Module Component / List of Values

Name

Version

Usage Sequence

Documentation

Description

Notes

Related Topics

List of Values Components

Module Components


Mandatory
The name of the module component to which the SQL Query Set belongs.


Mandatory
The name of the LOV component to which the SQL Query Set belongs.


Mandatory, 30 characters
The name of the SQL Query Set.


Mandatory, 6 digits
The sequence of the SQL statement within the set of queries involved in the set operation.


System objectives of modules

About system objectives of modules

Records the association between a system objective and the implementation of modules. For example, the achievement of a specific transaction rate can be the objective of a module.

Use the Repository Object Navigator to record system objectives of modules in the repository.

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

System objective of module definition properties

Owning Container

Objective

Module / PLSQL / Java Def

Version

Module Objective

Date Placed

Value

Unit Of Measure

Date Required

Achievement Comment

Conformance

Documentation

Comment

Related Topics

Modules


 Display only
The name of the objective.


 Optional, 70 characters
A comment or brief description about this association.


 Display only
The name of the associated module definition.


 Optional, 20 characters
The date on which the system objective was set for this module.


 Optional, 30 characters
A comment about the progress of the module and achievement of the objective.


 Optional, 15 characters
The value of implementing the module to achieve the system objective (e.g., a financial statement on implementing the module).


 Optional, 15 characters
The unit of measure for the value defined in the previous field.


 Optional, 20 characters
The date on which the module should be implemented to achieve the system objective.


 Optional, 70 characters
The level of conformance with the system objective that this module will achieve.


Unbound items

About unbound items

Unbound item definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About unbound items

An unbound item definition records the use of an item by a generated application. The item is referred to as unbound because its value does not map directly to a database column. For example, totals and summary fields can be implemented using unbound items. Each unbound item is recorded in the context of a module component, sub-component or List of Values component definition.

The following picture shows how unbound items are represented on the Data view of Module Diagrams and Reusable Component Diagrams.

If the item has an associated LOV component, the name of the LOV component is displayed to the right of the bound item on a Module Diagram.

--------------------------------------------------------------------------------------------------

Unbound item definition properties

Owning Container

Module Unit

SQL Query Set

Name

Version

Unbound Type

Maximum Length

Usage Sequence

Template/Library Object

Operations

Insert ?

Update ?

Query

Query ?

Range Search

Display

Display ?

Prompt

Display Type

Show Meaning

Width

Height

Alignment

Format Mask

Formatting

Wrap Style

Item Group

Context ?

User Text Areas

Relative Tab Stops

Start Tab

End Tab

Align Prompt ?

Definition

Domain

Datatype

Default Value

Default Value Type

Optional ?

Ordering

Order By Sequence

Sort Order

Computed

Reset Level

Reset Group

SQL

Derivation Text

PL/SQL Block

Validation

Dynamic List?

Help

Hint

User/Help Text

Documentation

Comment

Description

Notes

Related Topics

List of Values Components

Module Components

Bound Items


Optional
An expression used to derive a value for the generated item. To ensure uniqueness, use the item name within the derivation expression when referring to columns. For example, these are some valid SQL expressions for a module component containing items based on columns SAL, COMM, F_NAME, L_NAME:
SALARY + nvl(COMMISSION,0)
FIRST_NAME||' '||LAST_NAME

These Generators use this property. Click for more information:


Optional
The name of a domain to be associated with this unbound item. If specified, the datatype, length fields and allowed values are derived from the domain definition.

These Generators use this property. Click for more information:


Optional, 80 characters
Indicates the name of the group at which this computed item is to be reset. This property is relevant only when the unbound item is defined as COMPUTED and where the Reset Level property is set to NAMED GROUP.

These Generators use this property. Click for more information:


Optional, 16 characters
This property is relevant only when the unbound item is defined as Computed. It indicates the level at which a computed item is to be reset, i.e. Current Group, Parent Group, Module, Named Group or Page. If the reset level is specified as Named Group, then the Reset Group property is populated with the name of the group at which the computed item is reset.

Valid Values: Current Group, Module, Named Group, Page

Note:	Page is not used by Web PL/SQL Generator

These Generators use this property. Click for more information:


Applicable when an unbound item has valid values defined directly against it, as opposed to being in a domain. If the allowable values for the unbound item are held against a column or domain, the Dynamic List property of those elements should be used. If set to Yes the value of the unbound item is to be checked against a table (i.e. soft coded).

Default: No

These Generators use this property. Click for more information:


The types of unbound item that may be defined for generated applications. Valid options for the different types of generated applications are:

	Forms	Reports	Web	Visual  Basic
Computed	Yes	Yes	Yes	No
SQL Aggregate	No	Yes	Yes	No
SQL Expression	Yes	Yes	Yes	No
Client-side function	Yes	Yes	Yes	No
Server-side function	Yes	Yes	Yes	No
Target specific	No	Yes	No	No
Custom	Yes	No	Yes	Yes
Default: SQL Expression

These Generators use this property. Click for more information:


 Optional, 10 digits
The maximum length of data that the unbound item can contain.

These Generators use this property. Click for more information:


Optional
The type of item in the generated application.

These Generators use this property. Click for more information:


Windows

About windows

Window definition properties

Note:	To get help about a specific property in the application, click ? and then click on the property. Alternatively, click on the property name from the list of properties in this help topic.

--------------------------------------------------------------------------------------------------

About windows

A window definition records information, in the repository, about how information will be structured in a client application. Window definitions are always defined in the context of a module and you can define more than one window within a module.

The following table shows which application generators use window definitions and what they represent on generated applications:

Generators	What gets generated...
Form Generator	A window in a form.
Report Generator	A new report within a report.
Visual Basic Generator	A Visual Basic form in a VB application.
Web PL/SQL Generator	A Web page in a Web PL/SQL application.

Note:	When a window layout element is used to create a report within a report, the layout element identifies where information should be divided into a separate report. The Report Generator creates a button on the main report that is used to access the separate report.

Window definitions can be represented graphically on Module Diagrams using window layout elements, as shown below. The window layout elements can be created and viewed from the Display view only.

Window layout elements can be drawn around module components and/or action items. When a window layout element is created, its size and position in the generated application are unspecified. For Form generation you can use the Window definition's properties to control the size and position. However, for other generated applications, such as Visual Basic applications, the size and position of windows are controlled by templates.

--------------------------------------------------------------------------------------------------

Window definition properties

Owning Container

Module

Name

Version

Template/Library Object

Display

Title

Scrollable ?

Width

Height

Placement

X Position

Y Position

Documentation

Description

Notes

Related Topics

Modules

Module Components


Mandatory
The name of the module for which the window is defined.


A unique name for the window definition.

These Generators use this property. Click for more information:


Optional, 240 characters
The display title for the generated window.

These Generators use this property. Click for more information:


Indicates whether the generated window should be scrollable.

Default: No

These Generators use this property. Click for more information:


 The name of a template, or object in the object library on which the generated window is to be based.

These Generators use this property. Click for more information:


Optional, 6 digits
Identifies the default width of the generated window.

These Generators use this property. Click for more information:


Optional, 6 digits
Identifies the default height of the generated window.

These Generators use this property. Click for more information:


Optional, 6 digits
Identifies the default X-coordinate of the generated window.

These Generators use this property. Click for more information:


Optional, 6 digits
Identifies the default Y-coordinate of the generated window.

These Generators use this property. Click for more information:


Action items

Action items provide you with the option to take a certain action when using a generated application.

Action Item Type	Description
Navigation action items	Allow navigation within the same generated application or to a different generated application.
Generator action items	Perform a piece of standard generator functionality, e.g. Commit or Next Block, from Visual Basic applications only.
Custom action items	Perform a specific piece of user defined code from a generated application.
The following table shows the types of action items that can be used by each type of generated application and whether the action item can be implemented as a button or a menu item. A line (-) denotes where a type of action item is not used by a generator.

	Action item type
	Navigation	Custom	Generator
Form	Button	Button	-
Web PL/SQL	Link/Button	Link/Button	-
Report	Button	-	-
VB	Menu/Button	Menu/Button	Button
Action items can be seen from the Module Diagram Display view. Navigation action items use links to identify whether they navigate to a module component within the same module, or to a different module.


Mandatory, 30 characters
A unique name for the action item.

These Generators use this property. Click for more information:


Optional, 6 digits
The height of the button generated from the action item.

These Generators use this property. Click for more information:


Optional, 5 digits
The width of the button generated from the action item.

These Generators use this property. Click for more information:


Indicates whether the action item is the default action to be performed.

Default: No

These Generators use this property. Click for more information:


Optional
Multi line help text for the action item.

These Generators use this property. Click for more information:


Optional, 132 characters
A single line of text to inform the user of the generated application about the  purposes of this action item.

These Generators use this property. Click for more information:


Optional, 40 characters
The filename of the graphic (or icon) to be used if the action item is generated as an iconic button.

These Generators use this property. Click for more information:


Optional, 30 characters
The name of an object in a [Visual Basic] template or [Oracle Forms] object library, on which this action item is to be based.

These Generators use this property. Click for more information:


Mandatory
The name of the module component, or sub-component, for which this action item is defined.

These Generators use this property. Click for more information:


Optional, 130 characters
The caption or label to identify the action item in the generated application. For example, if a button is to be generated, this property defines the button caption (or label).

These Generators use this property. Click for more information:


Optional, 6 digits
The order in which action items within the same window, module component or sub-component are displayed.

These Generators use this property. Click for more information:


Mandatory
The name of the window for which the action item is defined.

These Generators use this property. Click for more information:


Items

Item definitions record information about data that is to be processed by generated applications. For example, an item definition identifies whether a field on a generated application has a default value and whether that value can be updated.

There are two types of item definitions that can be recorded in the repository:

Item Type	Description
Bound Items	These identify the database columns whose values are to be used by generated applications. In addition they specify details about how the columns are to be used. Each bound item maps directly to a column on a database.
Unbound Items	These provide information for generated applications, that cannot be directly mapped to a single database column. For example, totals and summary fields can be implemented using unbound items.
Note:	In addition to bound and unbound items, action items can also be recorded in the repository. These are used by generated applications to provide users with the option to perform certain actions.  About

The example below shows how bound and unbound items are represented on the Data view of Module Diagrams and Reusable Component Diagrams.

Notice how bound items are displayed within table usages. Each table usage identifies the table that contains the columns to which the bound items are mapped. Unbound items are simply displayed within the relevant module component, sub-component or List of Values component.

Related Topics

List of Values Components

Modules

Module Components

Table Usages


Indicates that this item will be used to identify records (or rows) in the generated application.
Context items are the subset of displayed items that together provide sufficient information for a user to identify a row. For example, in a module component based on EMPLOYEES this may involve just the ENAME item, whereas a module component based on ORDERS may require a combination of ORDER_ID and ORDER_DATE.

Default: No

These Generators use this property. Click for more information:


Optional
Indicates the datatype of the item, e.g., Date, Number, Time, etc.

For bound items, a value is displayed if the datatype of the column is different to that of the item. If they are the same, this value is <Null>.

Valid Values: <Null>, CHAR, DATE, DATETIME, NUMBER, RAW

These Generators use this property. Click for more information:


 60 characters
The default value of the item. This is the value displayed for the item when a new record is created.

These Generators use this property. Click for more information:


 Mandatory
Indicates the nature of the default value, i.e., whether it is a literal or a function.

Default: Literal

These Generators use this property. Click for more information:


Indicates whether the item is displayed by the generated application.

Default: Yes

These Generators use this property. Click for more information:


Optional, 60 characters
Defines how values from numeric or date columns are displayed in the generated application.

Note:	For a date format mask to be Y2K-compliant, the year element must be set to one of the following: YYYY, RRRR, RR.

For example:

Numbers:	9,999  $999.99  9.99
Dates:	DD-MON-YYYY, DD-MON-YYYY HH:MI:SS, DD-MON-YYYY, DAY DD/MM/YYYY.
These Generators use this property. Click for more information:


Optional, 6 digits
The number of lines for the generated item.

These Generators use this property. Click for more information:


Optional, 5 digits
The width of the generated item.

These Generators use this property. Click for more information:


Optional
End-user text or help text for generated applications.

Language	Use in generated application
Oracle Forms	Help text can be generated in MS Help format or displayed in a specified help form.
Visual Basic	Help text can be generated in MS Help format.
These Generators use this property. Click for more information:


Optional, 3 digits
Allocated by MS Help Generator. This suffix is combined with the Help context ID prefix on the module and module component, to form a unique number within the context of a help file.


Optional, 70 characters
Additional formatting to be applied to column values when they are displayed in a generated application. This property is used by the following Generators:

Language	Type of formatting
Reports	A valid Reports highlighting format, e.g., Bold, Flash, Reverse, Underline
Web PL/SQL	A PL/SQL function that returns HTML, e.g., Bold, Italic, URL, MailTo, etc.
These Generators use this property. Click for more information:


Optional, 132 characters
A single line of text to inform the user of the generated application what the item is used for.

These Generators use this property. Click for more information:


Optional, 30 characters
The name of a template, or object in the object library on which this item is to be based.
For bound items, this property defaults to the value specified for the column on which the item is based.

These Generators use this property. Click for more information:


Indicates that the user is allowed to enter a value for the column when a new record is created. Set this property to No when the column value is generated automatically, e.g., by system-generated unique identifiers.

For unbound items, this option is used only if the unbound item type is set to Custom.

Default: No

These Generators use this property. Click for more information:


Optional
Specifies the name of the item group where this item is to be placed.

These Generators use this property. Click for more information:


Optional
The horizontal alignment of values displayed within a text item.

Valid Values: <Null> Center, Left, Right

These Generators use this property. Click for more information:


Mandatory
The name of the module component, sub-component or list of values for which the item is defined.


Mandatory, 30 characters
A unique name for the item.

Note: Some of the generator products impose a limit on the number of characters that you should enter for this property. These Generators use this property. Click for more information:


Indicates whether the item is optional. This means that the user need not enter a value for the column prior to saving a new or modified record, i.e., the value may be 'null'. If this property is set to No (i.e., the column is mandatory) additional code is generated to check that the user provides a value for the column when a record is being created or updated.

Default: For unbound items the default is No  (Mandatory). Bound items default to the value specified for the underlying column. For example, a bound item will, by default, be optional if its underlying column is optional.

These Generators use this property. Click for more information:


Optional, 6 digits
Indicates that this item is to participate in the ORDER BY clause of the SQL statement used to query rows for the component. The number specified here specifies the position within the ORDER BY clause. Items from both base and lookup table usages can be incorporated within the ORDER BY clause.

This property can be used in conjunction with the Sort Order property to define the order in which records are returned from the database.

These Generators use this property. Click for more information:


Optional
PL/SQL statements and/or calls to PL/SQL functions and procedures. To ensure uniqueness, refer to columns using item names.

Note:	Do not enter more than one line of text for this property.

These Generators use this property. Click for more information:


Optional, 130 characters
The prompt (or label) associated with the item in the generated application.

These Generators use this property. Click for more information:


Mandatory
Indicates whether or not a pair of To/From range controls is generated for items displayed on query forms or dialogs.  If set to No a single control is generated. A value of 'Default Behavior' indicates that the Generator decides.

Valid Values: Yes, No, Default Behavior
Default: Default Behavior

These Generators use this property. Click for more information:


Optional, 240 characters
A comment on the use of the item by the module.

These Generators use this property. Click for more information:


Indicates that the item can be used when entering a query condition, i.e., the user may enter search criteria for the underlying column, prior to executing a query against its associated component. If set to Always the item must be entered as part of the query.

Default: No

These Generators use this property. Click for more information:


Optional
Defines how meanings (or abbreviations) of allowable values are displayed in the generated application.  Valid values are:

<Null>	Allowable value (or code) is displayed, e.g. O
Abbreviation only	Abbreviation of the allowable value is displayed, e.g. OPN
Meaning Alongside Code	Allowable value is displayed together with its associated meaning, e.g. O Open. This setting is relevant only for text fields, i.e., not radio groups, pop lists, etc.
Meaning only	Meaning of the allowable value is displayed, e.g. Open
These Generators use this property. Click for more information:


Optional
Defines whether column values are displayed in ascending or descending order. If null, the default is ascending. This property can be used in conjunction with the Order By Sequence property to define the order in which records are returned from the database.

Valid Values: <Null>, Ascending, Descending

These Generators use this property. Click for more information:


Mandatory
The name of the SQL Query Set to which the item belongs. Items can be defined for SQL Query Sets or module components, sub-components or Lists of Values components.

These Generators use this property. Click for more information:


Optional, 10 digits
The numeric relative tab stop to use when aligning the left edge of the item with the left edge of other items and item groups. This property is not used if the Tab Scope property is set to 'None'.

These Generators use this property. Click for more information:


 Optional, 10 digits
The numeric relative tab stop to use when aligning the right edge of the item with the right edge of other items and item groups. This property is not used if the Tab Scope property is set to 'None'.

These Generators use this property. Click for more information:


Indicates whether the start of prompts of vertically aligned items are also to be vertically aligned. This property is not used if the item is part of an item group or module component whose Tab Stop Scope property is set to 'None'.

Default: No

These Generators use this property. Click for more information:


Indicates whether text exceeding the display length should be allowed to 'wrap' around to the next line, or whether it should be truncated.

Valid Values: Wrap, Truncate
Default: Wrap

These Generators use this property. Click for more information:


Indicates that the user is allowed to modify the column value when updating an existing record. This property should be set to No where you want the user to be able to view but NOT modify the contents of the column, e.g., primary key columns.

For unbound items, this option is used only if the unbound item type is set to Custom.

Default: No

These Generators use this property. Click for more information:


Mandatory, 6 digits
The order of the item with respect to other items in the component. Use a Module Diagram to define the sequence of items.

These Generators use this property. Click for more information:


Optional
Boilerplate text in the generated report or the name of the file containing an image, OLE object or multimedia button to import into the generated report.

These Generators use this property. Click for more information:


Module Component Links

For information about links between module components, see key based links.

For information about modules that call other modules, see module networks.


 Mandatory
The name of the module component from which the link originates.


 Mandatory
The name of the module component that identifies the destination of the link.


 Mandatory
The name of the module from which the link originates.


 Mandatory
The name of the module that identifies the destination of the link.


Identifies where in the SQL statement the JOIN condition will be placed.


Module units

Module unit is the collective name given to:

List of Values Components

Module Components

Module sub-components


Mandatory 30 characters
A unique name for the module component, sub-component or list of values.

Note: Some of the generator products impose a limit on the number of characters that you should enter for this property. These Generators use this property. Click for more information:

Module component
Module sub-component
LOV


Optional, 70 characters
The title displayed for this module component, sub-component or list of values in the generated application.

These Generators use this property. Click for more information:

Module component
Module sub-component
LOV


Optional
Determines how a module component, sub-component or list of values is presented in the generated application. Valid values for each Generator are shown in the table below:

Reports	Web PL/SQL	Visual Basic
Across	List	List
Address	List/Form	List/Form
Form	Form	Form
Tabular		Context
These Generators use this property. Click for more information:

Module component
Module sub-component
LOV


Optional, 6 digits
If set for a module component/sub-component that is generated as the first block/layout region on a content canvas or stacked canvas, this specifies the height of the canvas.

If set for an LOV, this specifies the height of the generated LOV.

These Generators use this property. Click for more information:

Module component
Module sub-component
LOV


Optional, 6 digits
If set for a module component/sub-component that is generated as the first block/layout region on a content canvas or stacked canvas, this specifies the width of the canvas.

If set for an LOV, this specifies the width of the generated LOV.

These Generators use this property. Click for more information:

Module component
Module sub-component
LOV


Optional, 10 digits
The preferred number of rows created for this module component or sub-component in the generated application.

These Generators use this property. Click for more information:

Module component
Module sub-component
LOV


Optional, 60 characters
A brief description of the module component, sub-component or list of values.


Distributed Processing

About distributed processing

Documents an association between a node and a repository element in the situations where a repository element is implemented by more than one node. This association is recorded for documentation purposes only, that is, none of its properties are used by the generator products.

Distributed processing definition properties

Owning Container

Node

Module / PL/SQL / Java Definition

Version

Frequency

Forecast Frequency

Frequency UOM

Required Response

Urgency

Documentation

Design Note

Comment

Related Topics

Nodes


 Display only
The node that implements this PL/SQL definition, Java definition or module definition.


 Display only
The repository element that is implemented by this node.


 Optional
A brief note about the distributed processing definition.


 Optional, 16 characters
An estimate of the frequency with which the current node will run the element with which it is associated.


 Optional, 20 characters
The unit of measure for the forecast frequency.


 Optional, 20 characters
Response required when this node runs the element with which it is associated.


 Optional
A brief note about the urgency of the element run at this node.


 Optional
An optional comment.


Network Connections

About network connections

Records the link between two nodes when describing a distributed capability. This repository element is recorded for documentation purposes only, that is, none of its properties are used by the generator products.

Network connection definition properties

Owning Container

From Node

To Node

Version

Protocol

Line speed

Line Speed

Line Speed UOM

Availability

Available From

Available To

Documentation

Comment

Related Topics

Nodes


 Display only
The node from which this connection is made.


 Display only
The node to which this connection is made.


 Optional
A comment or brief description about this network connection.


 Optional, 30 characters
The protocol by which the connection between two nodes is made (e.g., LAN).


 Optional, 15 characters
The rate at which information/data can be transferred over the link.


 Optional, 15 characters
The unit of measure for the line speed (e.g., baud or bits per second).


 Optional, 20 characters
The date on which the link between the two nodes was created, or will be available.


 Optional, 20 characters
The date on which the link was, or will be, removed.


Nodes

About nodes

Records details about a specific processing and storage capacity device. The device may be a single machine, two linked machines, or a part of a machine. This repository element is recorded for documentation purposes only, that is, none of its properties are used by the generator products.

Node definition properties

Owning Container

Name

Version

Type

Primary Usage

Availability

Specification

Manufacturer

Model

Processor Data

Responsibility

Responsibility of

Phone

Documentation

Comment

Description

Notes

Related Topics

Oracle Databases

Other Databases

Distributed Processing

Network Connections


 Mandatory, 30 characters
The name by which the node is usually known.


 Optional
A comment or brief description about the node.


 Mandatory, 20 characters
The type of node that is being defined (e.g., Client Applications, Database Server).


 Optional, 30 characters
The manufacturer of this node (e.g., IBM, DEC, ICL).


 Optional, 30 characters
The model of this node (e.g., MicroVAX II).


 Optional, 70 characters
The main use for this node (e.g., development, production).


 Optional, 30 characters
The person or committee responsible for this node.


 Optional, 30 characters
The telephone number of the person or committee responsible for this node.


 Optional
The processor details for this node (e.g., the number of processors or the processor/disk capacity).


 Optional
The availability of this node (e.g., 24 hours, 9 - 5 weekdays).


Public Database Links

About public database links

A public database link is a repository definition that records information about linking a database to another database. Each public database link defines a path to a remote database. The remote database is available to all users of the database on which the database link is defined.

Public database links apply one way only. For example, a public database link from database X to database Y does not imply a link from database Y to database X. If the link is to exist from database Y to database X, then it must be explicitly defined.

Public Database Link definition properties

Owning Container

From Database

To Database

Version

Related Topics

Databases


 Mandatory
The name of the database on which the public database link is defined. All users who have access to this database will have access to the remote database (identified by the To Database property).


 Mandatory
The name of the database to which the link points.


Replication Group Propagations

About replication group propagations

Replication group propagations are repository definitions that record the names of the databases on which replication groups are replicated. They also record the propagation method that is to be used to update replication groups.

The databases that are to use replication groups must have schemas and database objects of exactly the same names as those contained in the replication group on the master site. However, these schemas and database objects do not have to be defined in the repository. The contents of the replication group at the 'master site', and the databases in which changes are to be replicated must be defined in the repository. The Server Generator creates Data Definition Language statements for schemas and database objects at the 'destination site'.

The information recorded is used by the Server Generator when creating replication groups.

Replication Group Propagation definition properties

Owning Container

Oracle Database

Replication Group

Replicated on Database

Version

Propagation_Method

Setup_Method

Documentation

Description

Notes

Related Topics

Databases

Replication Groups


 Mandatory
The name of the Oracle database for which the replication group is defined.


 Mandatory, 10 characters
The method by which data is to be propagated from the master site.

Valid Values: Asynchronous, Synchronous, Unknown
Default: Asynchronous


 Mandatory
The name of the database on which the replication group is replicated. Any changes that are made to the replication on the master site are propagated to this database.


 Mandatory
The name of the replication group that is to be replicated on a different database.


 Mandatory, 10 characters
The method by which data in the replicated environment is to be set up.

Valid Values:	Automatic, is via propagation
Manual, is via SQL script or import/export
Default: Automatic


Replication Groups

About replication groups

A replication group identifies a set of related database object implementations that are to be replicated on one or more databases.

Each replication group is defined for a specific database, known as the 'master site'. The database objects that comprise the replication group must all be implemented in schemas on the 'master site', although not necessarily all in the same schema.

When the definition has been recorded in the repository, the replication group can then be created on a database using the Server Generator.

Replication Group definition properties

Owning Container

Oracle Database

Name

Version

Documentation

Comment

Description

Notes

Related Topics

Databases

Replication Group Propagations


 Mandatory
The name of the Oracle database for which the replicated group is defined.


 Mandatory, 30 characters
Name of the replication object group. This name must be unique within the owning database.


 Optional, 2000 characters
A brief comment on the replication group


Materialized View Refresh Groups

About materialized view refresh groups

A materialized view refresh group identifies a set of materialized view implementations on the same database that are to be refreshed at the same time and at the same time interval. The materialized view implementations that are included in the group do not have to be in the same schema.

Materialized view refresh group definition properties

Owning Container

Oracle Database

Name

Version

Refresh Details

Next_Date

Interval

Implicit_Destroy ?

Rollback_Segment

Push_Deferred_RPC ?

Refresh_After_Errors ?

Documentation

Description

Notes

Related Topics

Databases

Rollback Segments

Materialized views


 Mandatory
The name of the Oracle database on which the materialized view group exists.


 Indicates whether the refresh group is to be automatically deleted when it no longer contains any members.
Default: No


 Optional, 240 characters
The function used to calculate the next time to refresh materialized views in the group, used in conjunction with the NEXT_DATE property. For example, NEXT_DAY(SYSDATE + 1, "MONDAY").


 Mandatory, 30 characters
A unique name for the materialized view refresh group.


 Optional, 12 characters
The date on which the next refresh is to occur. For example, 'SYSDATE'.


 Indicates whether changes from the materialized view are to be pushed to its associated master before refreshing the materialized view

This property is applicable to updateable materialized views only.

Default: Yes


 Indicates whether the refresh is to proceed even if there are outstanding conflicts logged in the DefError table for the materialized view's master.

This property is applicable to updateable materialized views only.

Default: No


 Optional
The name of the rollback segment to be used when the refresh of the materialized view group is taking place. The list shows all rollback segments that have been defined for this database.


The Navigator window

Related Topics

The Navigator window contains a list of the repository contents, arranged in a tree structure, for example:

The actual contents of the display depend on how you are using the repository, and on the level of the tree structure selected when the window was opened.

Opening a Navigator window

You can open any number of Navigator windows. How

Each Navigator window can be open at any one of the following hierarchy levels:

•	the entire repository

•	private workareas

•	shared workareas

•	a single workarea

•	all configurations

•	a single configuration

•	all containers

•	a single container

For example, if you are using version control and you open the window at the level of the entire repository, you see the following:

Repository

This shows the name (or the alias) of the database where this repository resides.

Private Workareas and Shared Workareas

The area named Private Workareas, when expanded, lists all the workareas that you own and which are not currently accessible to other users. Shared Workareas shows all the workareas that either you or other users have made available for shared access. About

Configurations

A configuration is a grouping together of specific versions of specific repository objects, and is typically used when constructing a build of a particular application. About

Configurations are shown in the Navigator window with the configuration name first, with different versions of the configuration nested under it, like this:

In this way you can see all the versions of the configuration in the repository. If a configuration is not under version control, only one nested name is shown, with no version number.

All Containers

Expanding All Containers in the Navigator window lists all the containers to which you have access, regardless of their workarea.

The area named Lost+Found provides access to repository objects that do not currently reside in a container. This can occur, for example, if a folder (but not its contents) was inadvertently deleted.

Contents of the Navigator window

The Navigator window displays a tool palette to the left of the tree structure.

Each item in the Navigator window is called a node and represents a workarea, an element type heading, a repository object or a reference. You can specify how you want the nodes to be arranged by choosing from a number of view options. About

If you start the Repository Object Navigator from another tool, you may find that the Navigator window is opened at the level of the workarea you are already using:

Here, the node named Folders, when fully expanded, lists the various containers of this type that are visible in this workarea. About

The node named Wastebasket refers to the workarea wastebasket. This is a storage area that contains repository objects which have been marked for deletion from the current workarea. These objects have not been physically removed from the repository, and can be either restored or destroyed. Each workarea has a wastebasket, and there is also a global wastebasket (under the All Containers node). About


Icons in the Navigator window

Nodes in the Navigator window have an icon displayed next to them. Each icon indicates what the corresponding node represents, for example:

At the highest level of the tree structure are the workarea and container icons:

	Workarea
	Folder
	Mapped container
A mapped container is one that has been associated with a particular file or directory in a file system (i.e., outside the repository). Mapping is used for uploading and downloading files to and from the repository. About

At the next level are the element type icons. Each element type has its own icon, for example:

Besides these, there are other icons that have a particular meaning:

	Checked-out object
	Shortcut
	Collapse/expand
	Referenced element


Names in the Navigator window

The top-level node indicates the level in the repository hierarchy at which the Navigator window was opened. For example, if you open the Navigator window at the Private Workareas level, you see a list of workareas like this:

If you expand a workarea node, immediately below the workarea name you see the various containers that have been created and which are visible in that workarea:

When you expand a container, you see the element types for which there are instances in that container (provided that element type headings are displayed):

Expanding an element type shows you the names of individual repository objects of that element type that are owned by the current container:

In repository terms, each of these names identifies the primary access controlled (PAC) element of the repository object.

Expanding a PAC element name displays various secondary headings:

The first group of secondary headings shows the possible secondary access controlled (SAC) elements that can be defined for the current PAC element of the object. The headings that are displayed differ depending on the PAC element type; for example, for a domain you can create only Allowable Values and Sub Domains. SAC elements are dependent on the PAC element from which they derive, and cannot exist in their own right.

Every repository object can also display the secondary headings Inclusions and Usages, and some have the headings Security or Preferences (or both) as well. It is possible to hide the Inclusions and Usages headings, so you may not see these even if data is defined for them.

Inclusions shows you the configurations, workareas and other items in which an object is included, as well as any containers in which the object is referenced:

Usages shows you the types of reference that are possible for a particular PAC or SAC element of an object, together with any instances of those references. The possible types of reference are different for each element type. In our example of a domain, the usages look like this:

Security indicates the repository users who have access to the current object, either directly or through the granting of roles:

Preferences shows the preference sets or non-default preferences that have been defined for the current object. About


Group tabs view

Related Topics

In group tabs view, the Navigator window has a set of tabs at the top. The tab labels describe element type groupings that correspond to different stages in the process of database or application modeling and design. When you select a particular tab, only the objects of element types in that group are displayed in the Navigator window.  About

You can add your own group tabs to the Navigator window, to display your own selection of element types (or user-defined views of element types). How

If you want to see all the element types, turn off group tabs view.

Note:	If a group tab does not appear in your Navigator window, you may need to select it for display using Options→Customize Navigator Groups.


The status bar

Related Topics

The status bar is made up of two parts:

•	•	hint line

•	•	message windows

The contents of the hint line depend on the context. If the cursor is over a menu option or toolbar button, the hint line indicates what that option or toolbar does.

If an object is selected in the Navigator window, the hint line shows the repository path for that object (that is, the location of the object in the repository hierarchy).

If a property is selected in the Property Palette, the hint line provides a brief description of that property.

If an operation (such as a Save) is in progress, the hint line indicates what the Repository Object Navigator is currently doing.

The message windows are as follows:

Message	Indicates
UPDATE	The status of the active Navigator window
CHANGES	You have made changes that you have not committed to the repository
ERRORS	One or more object definitions have uncorrected errors. The incorrect objects are shown in the Navigator window in the color defined for errors (default is red).


File - Open
   Open (File Menu)

Related Topics

Enables you to open a new Navigator window at a selected level in the repository hierarchy.

The corresponding dialog box shows a list of various items in the repository. From this list, you can choose the level at which to open the Navigator window.

Dialog box options

Look In

Shows the level at which the Navigator window will be opened.

 (Up One Level)

Selects the level above the current one in the repository hierarchy.

 (List View)

Displays only the names of the repository items in a multi-column list.

 (General Details View)

Displays various general details about the items in the list:  name, element type, attributes (e.g. read-only, checked out etc.), the date when the item was last modified and the user who last modified it.

 (Version Details View)

Displays version details, if any, about the items in the list:  name, element type, attributes (e.g. read-only, checked out etc.), version label, branch and version number.

 (Hierarchical 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.

 (Flat View)

Displays all the repository objects at or below the selected level. Objects are displayed with their path in the repository indicated. This view can be useful, for example, when specifying the Language property for a module or module component, as it avoids having to navigate to the System Folder to display the languages.

List box

If you select General Details View or Version Details View, displays details of the items at the repository hierarchy level immediately below that indicated by the Look In field.

Name

The name of the item.

Type

The type of item, e.g. workarea, application system, folder, configuration.

Attributes

For a repository object, indicates various attributes:

CI - checked in

CO - checked out

R - read only

Modified

(General Details View only) The date when this object was last modified.

Modified By

(General Details View only) The username of the repository user who last modified the object.

Version

(Version Details View only) The checkin branch and version number of a versioned object, for example, MAIN:1.

Version Label

(Version Details View only) The version label of a versioned object, for example, 1.3.

Find elements that match this criteria

Enables you to open a Navigator window at the level of a selected object. You can select the object in the list area (you may need to navigate down the hierarchy until you see the object in the list). Alternatively you can enter the object name in the Name field.

Name

The name of the object to which you want to navigate.

Type

The element type. You can use this field to filter the list of objects displayed.

Select All

Selects all the objects in the list. Use this if you want to open a window for each object.


File - Save Uncommitted Data
   Save Uncommitted Data (File Menu)

Related Topics

Saves any outstanding changes that you have made to the repository.

Changes you make to an object from the Navigator window (such as creating or deleting objects) are committed to the repository as soon as you choose this option or select another object.

When you edit properties in the Property Palette, the changes you make are committed as soon as you choose this option, or when you make another window active.


File - Revert Uncommitted Data
   Revert Uncommitted Data (File Menu)

Related Topics

Cancels unsaved changes you have made to the repository in the current Navigator window.

In the Navigator window toolbar, this button cancels the effect of all unsaved changes to the current repository object.

In the Property Palette, this button cancels the effect of all unsaved changes to the object properties.


File - Search Repository
   Search Repository (File Menu)

Related Topics

Enables you to search for objects across the entire repository, within a particular workarea, or within a particular container in a workarea.

You can perform simple searches, for example by object name, or more advanced searches using complex search conditions. You can also restrict the search to repository objects of a particular type, for example, column, index and so on. It is possible to search for a particular object by name, or to search for all objects with one or more properties that correspond to specified conditions.

The results of the search are displayed in a separate window, which shows brief details about the objects found. The Search Results window also allows you to locate the objects in the Navigator window by means of the right mouse menu.

Dialog box options

Context

Sets the context for the search: either the entire repository, or a particular workarea.

Entire Repository

Performs the search across the entire repository. Note that for a large repository, this could be very time-consuming.

Workarea

Restricts the search to a particular workarea.

Workarea Name

The name of the workarea in which you want to search. Enter the workarea name, or use the Browse button adjacent to this field to select a workarea.

Folder Path

The name of a container, in the selected workarea, in which you want to search. Enter the container name, or use the Browse button adjacent to this field to select a container.

For Types

Specifies the kind of object to search for.

Files

Searches for files that have been uploaded to the repository.

Specific

Searches for objects of a specific type.

Type Names

The element type of the objects for which you are searching. Enter the element type, or use the Browse button adjacent to this field to select one or more element types.

If you are searching on a single element type you need enter only enough letters of the element type name to distinguish it uniquely from the other available types. If you are searching on more than one element type, enter each type name enclosed in double quotation marks and separated by a space character.

Categories

Searches for objects according to one or more specified categories. About

Search Specification

Enables you to enter more specific details of what to search for.

Name

The object name. You can use the % wildcard to search on a partial name.

Short Name

The short name of the object. You can search on short names if the element type supports them.

IRID

(Displayed only if the Search on GUIDs check box is selected) The value of an IRID (a repository object identifier) you want to search for.

IVID

(Displayed only if the Search on GUIDs check box is selected) The value of an IVID (a repository object version identifier) you want to search for.

Search on GUIDs

Enables you to perform a search based on the internal globally unique identifiers (GUIDs) of an object. You can search on the object identifier or the version identifier.

Display GUIDs

Displays the value of the internal globally unique identifiers that match the search conditions in the Search Results window.

Match case

If selected, causes a case-sensitive search to be performed on the values in the Name and Short Name fields, and the data fields in the dialog boxes displayed by the Version, Audit and Advanced buttons. If clear, the search is not case-sensitive.

Search subfolders

If selected, extends the search to subcontainers (if any) of the container shown in the Folder Path field, if used. If clear, only the container shown in Folder Path is searched.

Version

Displays a further dialog box enabling you to specify version details. You can search on the version status (checked in, checked out or not versioned), on the version label or on the checkin branch.

Audit

Displays a further dialog box enabling you to search on the audit properties of an object (date created, date last modified, date format, user who created the object, user who last modified the object, and the number of times the object has been modified).

Advanced

Displays a further dialog box enabling you to specify advanced search conditions based on object property values.

Search

Starts the search operation.

Count Hits

Displays the number of matches, if any, for the search conditions. With a large repository, this can indicate whether you need to refine the search conditions before executing the query.

SQL

Displays the SQL query that will be executed by the current search conditions. You can edit this query before executing it.


File - Access Rights - View Access Rights
Access Rights - View Access Rights (File Menu)

Related Topics

Displays the access rights that you or another repository user have for a selected workarea, container or configuration. About

Note:	If you do not have the Manage User repository privilege and do not have Administrate access rights to the selected item, access rights for other users will not be shown.

Dialog box options

Object

Enables you to choose a workarea, container or configuration for which to display access rights.

Owner

Indicates the owner of a selected item in the Object list.

Users

A list of the users who have access rights to the selected item in the Object list.

Access Rights

The access rights that a selected user has for the selected item in the Object list. If multiple users are selected, this shows the combined set of access rights that they have.

A user may be shown as having access rights for a container. However, if that user does not have access rights to a workarea in which that container is visible, the user will not be able to perform operations corresponding to those access rights on objects in the container. The container itself will be visible to that user only via the All Containers node in the Navigator window.

Apply public and workarea rights

If the selected item is a container, checking this box applies the workarea access rights, together with those defined for the PUBLIC role, to the container.

If the selected item is a shared workarea or a configuration, checking this box applies the access rights defined for the PUBLIC role to the item.

If the selected item is a private workarea, this check box is disabled.

Grant Access

Displays a further dialog box showing the complete set of access rights for the selected item, allowing you to grant or revoke these rights.


Access Rights

Related Topics

You can grant or revoke a number of access rights to a selected workarea, container or configuration. The access rights are:

Access right	Allows user to...
Administrate	Grant, revoke or delete access rights on a repository object
Compile	Refresh a workarea
Delete	Delete an object (or perform force delete or purge if they have the necessary repository privileges)
Insert	Create an object
Select	Query an object
Update	Modify an object
Update Spec	Redefine a workarea
Version	Check out/check in an object
Repository privileges, such as those for force delete or purge, are set by the repository owner using the Repository Administration Utility.

If a user does not have the Version access right, that user can still modify an object under version control provided that the object is checked out.


File - Access Rights - Grant Access Rights
Access Rights - Grant Access Rights (File Menu)

Related Topics

Enables you to grant or revoke the access rights for yourself or other users to one or more selected containers, configurations or shared workareas. You must either own the items yourself or have the Administrate access right to them. About

You can also use this option to transfer ownership of a workarea, container or configuration that you own to another user.

You must select at least one workarea, container or configuration in the Navigator window before using this option.

Dialog box options

Objects

The list of workareas, containers or configurations that you selected.

Owner

Indicates the owner of a selected item in the Objects list.

Users

A list of the repository users who have been defined. You can select one or more users from this list and grant or revoke access rights for them.

Access Rights

A list of the access rights that you can grant or revoke. About

To Grant

When checked, indicates that the corresponding access right is to be granted to the selected users for the items selected in the Objects list.

To Revoke

When checked, indicates that the corresponding access right is to be revoked from the selected users for the items selected in the Objects list. You cannot revoke Administrate or Select access for an item if you are its owner. You can revoke an access right on an item from another user only if you originally granted the access right, or if you own the item.

Recurse Sub-Containers

When checked, indicates that the access rights to be granted or revoked for a selected container in the Objects list are also to be granted or revoked for any subcontainers it might have.

Grant

Grants the access rights specified.

Revoke

Revokes the access rights specified.

Ownership

Enables you to transfer ownership of one or more selections in the Objects list to another user.


File - Recent Windows
Recent windows (File Menu)

Opens any of the four most recently accessed windows in the Repository Object Navigator.


Edit - Undo
Undo (Edit Menu)

Related Topics

Undoes the last edit operation performed.

If the last operation cannot be undone, this option is disabled.


Edit - Paste Reference
Paste Reference (Edit Menu)

Related Topics

Inserts the contents of the Clipboard as a reference from an object selected in the Navigator window. For example, if you have placed a table definition on the Clipboard, pasting it as a reference from a module component enables you to create a module component table usage.

To place an item on the Clipboard for pasting as a reference, use Edit→Copy.

Note:	Edit→Paste Reference creates an object reference, whereas Edit→Paste creates an object copy.


Edit - Create
   Create (Edit Menu)

Related Topics

Creates a new item in the repository. The kind of item created depends on which node is currently selected in the Navigator window:

Current selection	Effect
Private Workareas heading Shared Workareas heading Workarea name	Invokes Workarea Wizard for creating new workarea
Configurations heading	Invokes Configuration Wizard for creating new configuration
Container type heading (e.g. Folders)	Creates container of that type
Container name	Creates new container of that type
Element type heading (e.g. Files)	Creates new object of that element type
SAC element type SAC element name	Creates new SAC element of that type
Compare this option with the Create Child option, which also creates repository objects but is available only in specific circumstances.


Edit - Create Child
   Create Child (Edit Menu)

Related Topics

Creates an item that is one level lower in the repository hierarchy than a selected item. The kind of item created depends on which node is currently selected in the Navigator window:

Current selection	Effect
Workarea name	Displays list of container types for creating a container
Container name (must be checked out if under version control)	Displays list of element types for creating a repository object
Configuration name (must be checked out)	Enables you to add members to the configuration
Compare this option with the Create option, which also creates repository objects but at the same hierarchical level as the selected item.


Edit - Create Reference
   Create Reference (Edit Menu)

Related Topics

Creates a reference from a selected repository object to another object. For example, you can record the usage of a particular entity by a particular business function.

Dialog box options

Look In

Enables you to select the level in the repository hierarchy at which the objects available for reference are displayed.

 (Up One Level)

Selects the level above the current one in the repository hierarchy.

 (List View)

Displays only the names of the available repository items in a multi-column list.

 (Details View)

Displays various general details about the items in the list:  name, element type, attributes, the date when the item was last modified and the user who last modified it.

 (Version Details)

Displays version details, if any, about the items in the list:  name, element type, attributes, version label, branch and version number.

List box

Lists the objects at the current hierarchy level that are available for referencing.

Find elements that match this criteria

These fields enable you to filter the list of objects displayed.

Name

The name of the object. You can use wildcards; for example, entering "c%" and clicking OK causes the list to include only those objects of the selected type whose names begin with the letter C.

Type

The element type. You can choose a type from the dropdown list.


Edit - Delete
 Delete (Edit Menu)

Related Topics

Deletes one or more selected repository objects, containers, non-versioned configurations or workareas. About

Caution: 	You cannot restore a deleted workarea.

Where a repository object (other than a configuration) is under version control, this option removes the container membership for that object version. The object version is retained in any previous versions of its container, but is no longer visible either in the current workarea or in any workareas that use subsequent versions of the container.

You cannot use this option to delete an object that has external references in other containers. You must either delete all external references first, or use Utilities→Force Delete.

This option does not delete a configuration that is under version control. To do so, or to delete one or more versions of any repository object, use Version→Purge Versions.

Dialog box options

List box

Lists the items that have been selected for deletion.

Recursively delete subfolders?

Select this box if you are deleting a container that has subcontainers defined. Deleting recursively causes deletion of the selected container and all its contents, including any subcontainers and all their contents.

Delete mapped file system files/folders

(Displayed only when deleting a repository container, or file owned by a container, that is mapped to a file system.) When selected, deletes the corresponding file or directory in the file system as well as the selected repository file or container. Use this option with care. If you inadvertently delete file system files or directories, restore them from the wastebasket and then synchronize the repository and file system.

Delete

Deletes all listed items.

Remove From List button

Deselects any items that do not require deletion.


Edit - Delete Reference
 Delete Reference (Edit Menu)

Related Topics

This option marks the selected reference for deletion from the repository. References are denoted in the Navigator window by a [image] icon.

Dialog box options

List box

Lists the references that have been selected for deletion.

Delete

Deletes all listed references.

Remove From List button

Deselects any references that do not require deletion.


Edit - Include in Workarea
Include in Workarea (Edit Menu)

Related Topics

Enables you to include checked-in versioned containers or repository objects in the selected workarea. You can include these items from anywhere in the repository, provided that you have access rights to them. Note that you cannot include items that are not under version control.

Dialog box options

Workarea

The name of the selected workarea.

Include container or object version in the workarea

The names of the containers or objects you want to include in this workarea. You can specify these items by name, enclosing the names in double quotes ("") and separating them with spaces, or you can use the Browse button to locate these items and select them.

Refresh workarea now?

Before you can see these items in your workarea you must refresh the workarea. If this box is selected, the workarea is refreshed as soon as you click OK. If the box is cleared, the items will become visible the next time you refresh the workarea.


Edit - Exclude from Workarea
Exclude from Workarea (Edit Menu)

Related Topics

Enables you to exclude checked-in versioned containers or repository objects from the selected workarea. Excluded objects still exist in the repository, but are no longer visible in the selected workarea.

Dialog box options

Workarea

The name of the selected workarea.

Exclude these object versions from the workarea

The names of the containers or objects you have chosen to exclude from this workarea.

Refresh workarea now?

Before you can remove these items from view in your workarea you must refresh the workarea. If this box is selected, the workarea is refreshed as soon as you click OK. If the box is cleared, the items will be removed from view the next time you refresh the workarea.


Edit - Empty Wastebasket
Empty Wastebasket (Edit Menu)

Related Topics

Removes from the repository all objects in the selected wastebasket.

Caution:	You cannot undo this operation. Repository objects removed in this way cannot be restored.

To empty a workarea wastebasket, you must have DELETE access to that workarea.


Edit - Restore from Wastebasket
Restore from Wastebasket (Edit Menu)

Related Topics

Restores the selected objects in the wastebasket to the repository. Objects are restored to the workarea from where they were deleted.


View - Show Group Tabs
Show Group Tabs (View Menu)

Related Topics

Switches the Navigator window to display a set of tabs at the top of the window. When group tabs are displayed, the Navigator window lists only the objects from the group selected by the tab. About

The tabs are labeled with the names of element type groups that correspond to various stages in the process of database or application modeling and design.


View - Hide Group Tabs
Hide Group Tabs (View Menu)

Related Topics

Turns off the display of element type group tabs at the top of the Navigator window.

When group tabs are hidden, the Navigator window is no longer restricted to displaying only those repository objects from the group defined by a selected tab. Instead, the window displays all objects at the selected level in the repository hierarchy.


View - Element Hierarchy View
Element Hierarchy View (View Menu)

Related Topics

For a selected element type, displays parent and child elements of that type as a hierarchy. A [image] icon is displayed next to each element to indicate that hierarchy view is selected for the adjacent node.


View - Element List View
Element List View (View Menu)

Related Topics

For a selected element type, displays all elements of that type at the same level, together with their associations.


Navigator - Show/Hide
Show/Hide (Navigator Menu)

Related Topics

Shows or hides element type headings in the Navigator window.

Dialog box options

Show Type Headings

For

The kinds of item for which you want to display the headings:

Objects	primary access controlled (PAC) elements
Folders	containers
Child elements	secondary access controlled (SAC) elements, usages etc.
Always

Headings are always displayed for the selected items.

Never

Headings are never displayed for the selected items.

Only for non empty nodes

For the selected items, headings are displayed only for those objects of which a node in the Navigator window includes at least one instance. For example, if a container has no instances of table definitions, the heading Table Definitions does not appear in the Navigator window for that container when the container is fully expanded.

Only for nodes containing more than one type

For the selected items, headings are displayed for a node in the Navigator window only if the node contains objects of more than one type. For example, if a container contains only table definitions, the heading Table Definitions does not appear; only the individual object names are listed.

Show Inclusions

When selected, displays the containers, configurations and workareas in which the selected types of item are included.

Show Usages

When selected, displays the references to other objects for the selected types of item.

File System files outside repository

When selected, displays files that reside in mapped containers but which have not been uploaded to the repository.


Navigator - Filter
Filter (Navigator Menu)

Related Topics

Enables you to customize the Navigator window in several ways.

For workareas, containers or configurations, or for repository objects of a selected type, you can include in the Navigator window only those items with properties that correspond to one or more specified conditions. This is useful, for example, where a repository has a large number of objects of a particular type but you do not want to display all of them in the Navigator window.

You can perform simple filters, for example by object name, or more advanced filters using complex filter conditions. You can also:

•	change the display order within an element type

•	display object properties in the Navigator window (besides those in the Property Palette)

Dialog box options

For Object Type

The type of object to which the customization is to apply.

Data

Applies the customization to the object data displayed in the Navigator, e.g., the object names.

Headings

Applies the customization to the element type headings in the Navigator.

Note:	If you want to apply customization to both data and headings, do so in separate operations.

The following tab is selected initially:

Filter Conditions

The dialog box also has these tabs:

Sort Sequence

Show Properties

Apply button

Applies the changes immediately in the Navigator window. If you display the Navigator window and the dialog box side by side, you can see the effect of your changes as you make them.

Save as Default button

Saves the changes as the default display for objects of this type.

Save as View button

Saves the changes as a user-defined view. You can then add this view to the Navigator window. How


Filter/Search Conditions tab
Filter Conditions tab
Search Conditions tab

From the Filter Conditions or Search Conditions tab, you can specify various conditions for a filter or search operation. You base these conditions on property values of objects of the selected type. Only objects of the selected type whose properties satisfy the conditions will appear as the output of the filter or search operation. About

	AND condition	Sets an AND condition for the selected properties (both this condition and one or more others must be satisfied)
	OR condition	Sets an OR condition for the selected properties (either this condition or one or more others must be satisfied)
	Group	Groups selected properties together for filtering purposes
	UnGroup	Cancels grouping for selected properties
	Duplicate Property	Copies a property to enable you to set alternative conditions involving this property
	Clear Condition	Clears a filter condition for a selected property
	Move Up	Moves a property up the list, for grouping purposes
	Move Down	Moves a property down the list, for grouping purposes
AndOr

AND indicates that you have set an AND condition involving this property.

OR indicates that you have set an OR condition involving this property.

Property

The name of the property to be used for the filter or search operation. You can filter or search using any number of object properties.

Condition

The condition that must be satisfied for objects to be displayed. For example, if the Name property has Condition set to A%, only objects of this type whose name begins with A will be displayed.


Sort Sequence tab

From the Sort Sequence tab, you can change the order in which objects of the selected type are output by the filter or search operation.

	Move Up	Moves a property up the list, for sorting purposes
	Move Down	Moves a property down the list, for sorting purposes
Order By

When selected, specifies that you are sorting the objects based on values for this property (for example, in ascending order of Name). You can sort objects by more than one property; in this case, objects are sorted by the highest specified property in the list, then by the next highest, and so on.

Property

The name of the property to be used for sorting. You can sort using any number of object properties.

Descending

When selected, specifies that descending order is to be used for the sort with this property (default is ascending order).


Show Properties tab

The Show Properties tab enables you to display selected properties in the output from the filter or search operation.

By default, the output lists object definitions by name. You can display other properties as well as (or instead of) the name, for example the short name.

	Move Up	Moves a property up the list
	Move Down	Moves a property down the list
Show

When selected, specifies that the corresponding property is to be displayed for objects of the selected type.

Property

The name of the property. You can display any number of object properties in the output.


Navigator - Sort
Sort (Navigator Menu)

Related Topics

Enables you to change the display order in the Navigator window for the contents of workareas, containers or repository objects of a selected type.

You can base the sort on any property, or any combination of properties, of the element type. For example, you can sort objects by creation date, name, and so on, in either ascending or descending order.

You can also:

•	show or hide objects of the selected type

•	display object properties in the Navigator window (besides those in the Property Palette)

Dialog box options

For Object Type

The type of object to which the customization is to apply.

Data

Applies the customization to the object data displayed in the Navigator, e.g., the object names.

Headings

Applies the customization to the element type headings in the Navigator.

Note:	If you want to apply customization to both data and headings, do so in separate operations.

The following tab is selected initially:

Sort Sequence

The dialog box also has these tabs:

Filter Conditions

Show Properties

Apply button

Applies the changes immediately in the Navigator window. If you can display the Navigator window and the dialog box side by side, you can see the effect of your changes as you make them.

Save as Default button

Saves the changes as the default display for objects of this type.

Save as View button

Saves the changes as a user-defined view. You can then add this view to the Navigator window. How


Navigator - Display Properties
Display Properties (Navigator Menu)

Related Topics

Enables you to choose which properties to display in the Navigator window for the contents of workareas, containers or repository objects of a selected type.

By default, the Navigator window displays objects by name. You can display other properties as well as (or instead of) the name, for example the short name.

You can also:

•	show or hide objects of the selected type

•	change the display order within an element type

Dialog box options

For Object Type

The type of object to which the customization is to apply.

Data

Applies the customization to the object data displayed in the Navigator, e.g., the object names.

Headings

Applies the customization to the element type headings in the Navigator.

Note:	If you want to apply customization to both data and headings, do so in separate operations.

The following tab is selected initially:

Show Properties

The dialog box also has these tabs:

Filter Conditions

Sort Sequence

Apply button

Applies the changes immediately in the Navigator window. If you can display the Navigator window and the dialog box side by side, you can see the effect of your changes as you make them.

Save as Default button

Saves the changes as the default display for objects of this type.

Save as View button

Saves the changes as a user-defined view. You can then add this view to the Navigator window. How


Navigator - Clear Selected Filters
Clear Selected Filters (Navigator Menu)

Related Topics

Clears any Navigator window display filters for the selected element types. The display reverts to the default display for these element types.


Navigator - Clear All Filters
Clear All Filters (Navigator Menu)

Related Topics

Clears all Navigator window display filters. The display reverts to the default display for the Navigator window.


Navigator - Find
Find (Navigator Menu)

Related Topics

Finds a text string in the active Navigator window or Property Palette. The search starts from the current selection in the Navigator window or Property Palette.

Dialog box options

Find

The text string for which to search.

Direction

Identifies whether the direction of the search is Up or Down from the current selection. If nothing is selected the search starts from the top of the active window.

Find Next button

Searches the active window for the next occurrence of the string entered in the text box. The direction of the search is determined by the Direction option.


Utilities - Designer - Database Design Transformer
Designer - Database Design Transformer (Utilities Menu)

Related Topics

Runs the Database Design Transformer, which transforms an entity model into a database design in the repository. The utility creates tables to record instances of each entity, columns to store the attributes, and constraints to implement the relationships between entities. It also creates constraints to enforce any unique identifiers that you have defined, and indexes to support your foreign keys.


Utilities - Designer - Application Design Transformer
Designer - Application Design Transformer (Utilities Menu)

Related Topics

Runs the Application Design Transformer, which transforms function and business unit definitions into an application system design in the repository. The utility converts functions into candidate modules, which can then be implemented as screens, reports, manual procedures, or utilities. The Transformer also converts function data usages to module data usages, which define how a module uses the tables and columns in the database. The utility then uses the module-to-business-unit association to create candidate menu modules and menu structures.


Utilities - Designer - Table to Entity Retrofit
Designer - Table to Entity Retrofit (Utilities Menu)

Related Topics

Runs the Table to Entity Retrofit utility, which enables you to derive entity definitions from tables in an existing database. You normally do this as part of a comprehensive database design capture process, which enables you to incorporate legacy data in a repository.


Utilities - Designer - Create Function Attribute Matrix
Designer - Create Function Attribute Matrix (Utilities Menu)

Related Topics

Creates default function attribute usages for all attributes of entities used by a business function.


Utilities - Designer - Create Default Module Data Usages
Designer - Create Default Module Data Usages (Utilities Menu)

Related Topics

Creates default data usages (such as module components with table usages and data bound items) for a selected module.

Note:	The Language property of the selected module must be defined, e.g. Oracle Forms.

This utility uses relationships between business functions, entities, tables and modules to create data usages for a module. The diagram below shows the information that must be recorded in the repository for the selected module, before running this utility.

Usage objects	Typically created by ...
A - Module function usages	Application Design Transformer
B - Function entity usages and function attribute usages	Application Design Transformer
C - Table entity usages and column attribute usages	Database Design Transformer
D - Module component data usages	Default Module Data Usages Utility
When A, B and C exist in the repository for a given module, the Default Module Data Usages utility will create D, the module component data usages (for example, module components with table usages and data bound items).

An example of when you may need to use this utility is if you used the Application Design Transformer to create default module definitions in the repository, before using the Database Design Transformer to create table definitions based on entities. When run in this order, the Application Design Transformer creates module definitions with no module components (or data usages). Before running the Default Module Data Usages utility to create the missing data usages, you must ensure that table entity usages and column attribute usages exist. You can do this by running the Database Design Transformer for the appropriate entities.

Re-running the Default Module Data Usages utility

You may want to change the entity model, the function hierarchy, or the relationship between them. The table below describes how this utility processes such changes:

If you...	When you re-run the utility...
Add a new entity and attribute usage to a function that is already mapped to a module.	A new module component, table usage, and bound item are created for the new table and column which map to the new entity and attribute.
Add a new attribute usage to a function that is already mapped to a module.	A new bound item is created. The bound item will be created in the table usage that corresponds to the attribute's owning entity.
Add a module function usage for an existing module to point to a new function.	New module components, table usages, and bound items are created for the entities and attributes that the function uses.
Add a mandatory column to a table which is mapped to an entity, which is used by a function on which a module is based.	A new bound item is not created. This must be added manually.
Update the properties of function entity usages, or function attribute usages.	Neither bound items or module networks are updated to reflect the new usages. These must be changed manually.
Delete function module usages, function entity usages, function attribute usages, or table entity usages.	Corresponding module components, table usages, and bound items are not deleted. The Default Module Data Usages utility does not delete module elements.
Dialog box options

Client/Server

Indicates whether processing is currently taking place at the client or the server.

Progress message

Records progress of the utility while gathering the information required to generate default module data usages.

List box

Lists the actions performed by the utility, for example the repository objects that have been created.

Cancel button

(Displayed during generation only). Cancels the process.

Close button

Closes the dialog box.

Copy button

Copies the contents of the List box to the Clipboard.


Utilities - Designer - Update Attributes in a Domain
Designer - Update Attributes in a Domain (Utilities Menu)

Related Topics

Updates all the appropriate attributes with the property details of the selected domain. You might use this, for example, when you edit a domain and want to update all the attributes that use that domain.

This utility overwrites any properties in a column or attribute that conflict with the same property in the domain to which the column or attribute belongs. 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 property of the column or attribute has a null value.


Update Columns/Attributes in a Domain dialog box
Designer - Update Columns/Attributes in a Domain dialog box

Related Topics

Updates all columns and attributes in the selected domain with any changes that have been made to that domain.

This utility overwrites any properties in a column or attribute that conflict with the same property in the domain to which the column or attribute belongs. 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 property of the column or attribute has a null value.

Container

The name of the owning container for the domain definition.

Domain

The name of the domain in which the columns or attributes have been placed.

Auto-checkout

This check box is enabled only if the owning entity (for an attribute in the domain) or table (for a column in the domain) is currently under version control and checked in. When selected, it causes the entities or tables to be checked out so that the update can take place. If the check box is cleared, entities or tables under version control and checked in are ignored by this utility.


Utilities - Force Delete
Force Delete (Utilities Menu)

Related Topics

Invokes the Force Delete Wizard. This removes selected non-versioned repository objects, or secondary access controlled (SAC) elements of any kind of object, regardless of any delete constraints that may have been defined for the corresponding element type. About

The wizard is a predefined set of screen forms that takes you step by step through the force delete process. 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.

You can use the Force Delete Wizard only if you have the FORCE repository privilege, and DELETE access rights to the workarea and the owning container.

Note:	To forcibly remove checked-in object versions, use Force Purge.


Utilities - Force Purge
Force Purge (Utilities Menu)

Related Topics

Invokes the Force Purge Wizard. This removes a selected checked-in object version, regardless of any delete constraints that may have been defined for the corresponding element type. About

The wizard is a predefined set of screen forms that takes you step by step through the force purge process. Object versions removed in this way cannot be recovered, nor is it possible to recover references or child elements.

You can use the Force Purge Wizard only if you have the FORCE or PURGE repository privileges, and DELETE access rights to the owning container.

Note:	To forcibly remove non-versioned repository objects, or secondary access controlled (SAC) elements of any kind of object, use Force Delete.


Utilities - Export
Export (Utilities Menu)

Related Topics

Enables you to export data from the repository to a file. You can export repository data to:

•	•	a file in Oracle database export format

•	•	an export file in text format

This option starts the Export Wizard, a predefined set of screen forms that takes you step by step through the export process.


Utilities - Import
Import (Utilities Menu)

Related Topics

Enables you to import data into the repository from a file. You can import repository data from:

•	•	a file in Oracle database export format

•	•	an export file in text format

This option starts the Import Wizard, a predefined set of screen forms that takes you step by step through the import process.


Utilities - Download Files and Folders
Download Files and Folders (Utilities Menu)

Related Topics

Copies selected files or containers from the repository to a file system directory.

Dialog box options

Source

Download from repository path

If you selected files or containers to download before the dialog box was displayed, this shows the repository path of these items.

File(s) / Folder(s)

The names of the files or containers you want to download. Enter any multiple names in double quotes ("") and separated by a space. The Browse button enables you to locate and select a file or container.

Recurse into sub-directories

When selected, indicates that any subcontainers of the selected container, and their contents, will also be downloaded. When clear, indicates that only the contents of the selected container will be downloaded.

Destination

To OS path

The full pathname of the file system directory to which you are downloading. If a mapping has been defined for the destination directory, this field shows the mapping, but you can change this value. If no such mapping is defined, the field shows the last destination specified, if any, otherwise it is blank. The Browse button enables you to locate and select a directory.

Options

Enables you to convert downloaded text (but not binary or Unicode) files from MS-DOS format to UNIX format or vice versa.


Options dialog box

Enables you to convert text (but not binary or Unicode) files from MS-DOS format to UNIX format or vice versa.

The difference has to do with the end-of-line (EOL) indicator. In MS-DOS (or Windows), end of line is indicated by a carriage return + line feed combination, whereas in UNIX only a line feed character is used.

Use mapping defaults

(Displayed only for synchronization) Causes a default translation specified during folder mapping to be used.

Do translation

Causes the selected type of text file translation to take place.

Translate files in MS-DOS format to UNIX format

Use this option if you are mapping, synchronizing or downloading to a UNIX file system.

Translate files in UNIX format to MS-DOS format

Use this option if you are mapping, synchronizing or downloading to a Windows file system.


Utilities - Upload Files and Folders
Upload Files and Folders (Utilities Menu)

Related Topics

Copies one or more files or directories from a file system into a repository container.

Once files have been uploaded, you can perform operations on them from within the repository. For example, you can open or edit an uploaded file using a program appropriate to the file type. The right mouse menu on a selected file indicates the operations you can perform. Uploaded files can also be brought under version control.

Dialog box options

Source

Upload from OS path

The full pathname of the file system directory from which you are uploading. If a mapping has been defined for the destination repository container, this field shows the mapping, but you can change this value. If no such mapping is defined, the field shows the last destination specified, if any, otherwise it is blank. The Browse button enables you to locate and select a directory.

File(s) / Folder(s)

The names of the files or directories you want to upload. The Browse button enables you to locate and select a file.

Recurse into sub-directories

When selected, indicates that the contents of any subdirectories of a selected directory will also be uploaded. When clear, indicates that only the contents of a selected directory will be uploaded.

Destination

To repository path

The container (and its workarea) to which you want to upload files.

Overwrite changed files

If you select this check box, changed file system files that already exist in the repository are overwritten on upload if they are checked out or are not under version control.

Check in after upload

If you select this check box:

•	All uploaded files and directories are checked in after the upload. Files that are skipped because they have not changed, or because you decided not to overwrite existing files, are not checked in. New or non-versioned files and directories are brought under version control.

•	If you select a directory and choose Recurse into sub-directories, the directory and all its subdirectories are checked in.

•	If you select a file and choose Recurse into sub-directories, the parent directory of the file is not checked in.


Utilities - Map Folder to File System
Map Folder to File System (Utilities Menu)

Related Topics

Associates a selected repository container with a directory in a file system to which you have access. You can also use this option to delete such an association.

Note:	You cannot map a subcontainer; you can map only a container that has no parent.

A mapping provides a default specification for upload and download operations. In addition, a mapping is required before you can synchronize that file system with the repository. You must requery the selected repository container before you see the effect of mapping, or mapping deletion, in the Navigator window.

A mapped container is denoted by  in the Navigator window of the Repository Object Navigator.

Dialog box options

Map folder name to OS Path

The full pathname of the file system directory you want to map. The Browse button enables you to locate and select a directory.

Delete Mapping

Deletes the association between the selected container and the file system indicated by Mapping path.

Options

For files in a mapped container or file system, enables you to convert text (but not binary) files from Windows (MS-DOS) format to UNIX format or vice versa.

Current folder mappings in workarea

Lists the current associations between containers and file systems in the current workarea.

Folder name

The name of a container in the current workarea.

Mapping path

The name of the file system directory with which this container is associated.

Text conversion

Indicates the type of conversion, if any, specified for text files in a particular mapping.

Apply

Creates the mapping, enabling you to select another container name to map.


Utilities - Synchronize Files and Folders
Synchronize Files and Folders (Utilities Menu)

Related Topics

Enables you to update files in a selected repository container to make them identical to the corresponding files in a mapped file system, or vice versa. For example, if a file is changed in the file system, synchronization ensures that the same changes are made to the corresponding file in the repository.

If you select a container that has not been mapped to a file system, this option requires you to perform the mapping first.

A mapped container is denoted by  in the Navigator window of the Repository Object Navigator.

Dialog box options (unmapped container)

Map Folder to OS Path dialog box

Dialog box options (mapped container)

Recurse into sub-folders

When selected, indicates that the contents of any subcontainers of the selected container will also be synchronized. When clear, only the contents of a selected directory will be synchronized.

Include (create) files new to the repository

When selected, uploads any files in the mapped file system that have not yet been uploaded to the repository (for example, files newly created in the file system).

Leaving this unselected (default) ensures that no new files are uploaded during synchronization. This prevents you from accidentally uploading unwanted files, e.g., intermediate build files and temporary files.

Synchronize

Updates files in the repository with the contents of the corresponding files in a mapped file system or vice versa, depending on which is the later version.

Options

Enables you to convert synchronized text (but not binary) files from Windows (MS-DOS) format to UNIX format or vice versa.


Utilities - Edit File Registry
Edit File Registry (Utilities Menu)

Related Topics

Displays details from the file registry, which determines how a particular file type is treated when it is stored in the repository. The display shows how a particular filename pattern is associated with a particular rule. The rules define whether a file is treated as a text or a binary file, or whether it is stored in compressed or uncompressed format.

The dialog box also enables you to create or update file registry details.

Dialog box options

Pattern and platform options

Pattern

Lists the patterns that have already been defined.

A file type is typically identified by its extension. For example, %.EXE indicates a Windows executable binary file, while %.TXT indicates a text file. The "%" character is the Oracle wildcard character (the equivalent of the "*" character in Windows or UNIX file specifications).

More precise patterns can be used for specific cases. The higher a pattern is in the list, the greater its precedence. Examples

Patterns are case sensitive, so for example you could have different rules for "%.txt" and "%.TXT". However, their effect is determined by the setting of the repository case-sensitive uniqueness checking policy. If this policy is active, the different rules both apply. If the policy is deactivated, only the rule that is higher in the list applies. About

Platform

The type of operating system under which files with the pattern set above are used:

Unix	UNIX systems
Win32	Windows 95/98/NT/2000 systems
All	both of the above
Important:  If you set the platform type to "Unix" for a particular rule then the Windows release of Oracle SCM will ignore this rule and continue scanning the rule set for a matching rule (one that matches both file pattern and platform).  If no matching rule is found then the file is assumed to be a binary file and you will not be able to run the Oracle SCM diff/merge utility.

Rule

Indicates how files with the corresponding pattern and platform are stored. About

The available options are Binary, Text, Compressed and Uncompressed.

Each entry in the file registry can define only one rule at a time. If you want to specify more than one rule for the same pattern (for example, to specify binary and compressed), you need to define two separate registry entries.

If mutually exclusive rules are inadvertently defined for the same pattern (for example, binary and text), the rule that is higher in the display takes precedence.

Description

A text description of the file type.

Top

Moves a selected pattern to the top of the list.

Up

Moves a selected pattern one place higher in the list.

Down

Moves a selected pattern one place lower in the list.

Bottom

Moves a selected pattern to the bottom of the list.

New rule

Enables you to define a new rule for a particular pattern. The new rule is added at the bottom of the list.

Delete rule

Deletes the rule for a selected pattern.

Edit rule

Enables you to edit any part of the rule for a selected pattern.


Examples of file registry use

Example 1

You have a particular file, named "myfile.doc", which you want to be treated as a binary file. However, your file registry is set up so that files with the pattern "%.doc" are treated as text files, and you want to preserve this setting.

To achieve this, you define a new rule (strictly speaking, a new entry in the file registry) that associates the pattern "myfile.doc" with the rule "Binary file". The new rule is added at the bottom of the displayed list. You then move it above the pattern "%.doc" in the list, as follows:

Pattern	Rule
myfile.doc	Binary file
%.doc	Text file
If you fail to move the new rule to this position, it will be overridden by the rule for "%.doc". This is because the file registry evaluates the rules in the order in which they appear in the list. Now, "myfile.doc" is treated as a binary file, but any other file with the extension ".doc" is treated as a text file.

Note that the file registry entries are case-sensitive. Thus, if you think your file is named "myfile.doc" when it is actually named "MyFile.doc", it will still be treated as a text file in this example.

Example 2

You want most files to be stored in compressed format, but you want to store files with the extension ".zip" as uncompressed files.

To do this, you define two rules, as follows:

Pattern	Rule
%.zip	Uncompressed
%	Compressed
Provided that you move the rule for "%.zip" above the rule for "%" in the list, this will achieve the result you want.

Note that mistakenly defining the rules like this:

Pattern	Rule
%	Compressed
%.zip	Uncompressed
would result in all files being compressed, as the "%.zip" rule is below the more general "%" rule.


File Registry Rule dialog box

Enables you to create or edit a rule in the file registry. This determines how a particular file type is treated when it is stored in the repository.

Pattern

The filename pattern that identifies the file or files to which the rule applies. You can use the wildcard character "%" to mean "any character".

Properties

Rule

Specifies the way you want files matching this pattern to be stored in the repository. The available rules are: Text file, Binary file, Compressed file and Uncompressed file.

If you inadvertently define mutually exclusive rules for the same pattern (for example, binary and text), the rule that is higher in the Edit File Registry display takes precedence.

Platform

Specifies the type of operating system under which files with this pattern are used:

Unix	UNIX systems
Win32	Windows 95/98/NT/2000 systems
All	both of the above
Description

A text description of the file or file type to which this pattern applies.


Tools - Navigator
Navigator (Tools Menu)

Related Topics

Changes the focus to the Navigator window if the Property Palette is currently in focus.


Tools - Workarea Wizard
Workarea Wizard (Tools Menu)

Related Topics

Starts the Workarea Wizard. This is a predefined set of screen forms that take you step by step through the process of creating a workarea.


Tools - Configuration Wizard
Configuration Wizard (Tools Menu)

Related Topics

Starts the Configuration Wizard. This is a predefined set of screen forms that take you step by step through the process of creating a new configuration, or creating a new version of an existing configuration.


Tools - Merge Wizard
Merge Wizard (Tools Menu)

Related Topics

Starts the Merge Wizard, enabling you to merge versions of multiple objects. The Merge Wizard is a predefined set of screen forms that take you step by step through the process of specifying the merge information and instigating the merge operation.

When you have completed the necessary information, the Merge Wizard processes each selected item in turn; if appropriate, in each case the Merge window is displayed for you to preview the selections made by the merge algorithm, and to make selections to override them if necessary.


Tools - Command Line Tool
Command Line Tool (Tools Menu)

Provides access to the command-line interface.

This option opens a window containing a command-line prompt, REPCMD>, enabling you to issue any of a wide variety of commands to perform operations on the repository.

At the REPCMD> prompt, you can enter the HELP command to see a list of available commands. For help on a particular command, enter HELP command_name at the prompt.


Tools - Explorer
Explorer (Tools Menu)

Opens Windows Explorer from within the Repository Object Navigator.

This option can be useful for locating files when uploading and downloading between the repository and a file system.


Tools - Color/Font
Color/Font (Options Menu)

Related Topics

Specifies the text color and font options for the Repository Object Navigator.

You can specify the:

•	color in which various types of text are displayed.

•	fonts used in the Navigator window, Property Palette and Textpad.

Dialog box options

Text Color

The type of item for which you want to change the text color. About

Note:	The current color setting for the selected text type is displayed in the Preview box to the right of this field.

Fonts

Identifies whether the font is to be set for the Navigator, Property Palette or Textpad.

Note:	The current font setting for the selected window is displayed in the Preview box to the right of this field.

Color Palette

Displays a further dialog box from which you can choose the required color.

Font Dialog

Displays a further dialog box from which you can choose the required font.


Options - General Settings
General Settings (Options Menu)

Related Topics

Sets general options within the Repository Object Navigator other than those for colors and fonts.  The settings shown in this dialog box are used as defaults each time this user invokes the tool.  For example, you can specify whether the Welcome Screen should be displayed each time you run the tool, or which date format you want to use.

Note:	To set text colors and fonts, choose Options→Color/Font.

Dialog box options

Show

Welcome Screen

When selected, specifies that the Welcome Screen is to be displayed when the tool is invoked.

Confirm dialog on Copy

When selected, specifies that a confirmation dialog box is displayed when you attempt to copy repository objects.

Confirm dialog on Move

When selected, specifies that a confirmation dialog box is displayed when you attempt to move repository objects.

Version

Determines the format of the object versions.

Version Label

Displays object versions with their version label. A version label is a string that uniquely identifies each version of an object, e.g. 1.3.1.0.

Branch ; Version Number

Displays object versions with their branch names followed by their version numbers, e.g. MAIN;7.

General

Options File

The name of the file that stores the details of user-defined filters, Navigator groups and Navigator views. Use the Browse button to choose a different file.

Date Format

Sets the format in which dates are displayed in the Property Palette for items such as the audit properties (date created, date changed and so on).


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

Related Topics

Customizes which properties are displayed on the Property Palette.

Dialog box options

Show

Show Owning Container

Displays or hides the name of the container that owns a repository object.

Show Version Label

Displays or hides the version label property. In a non-versioned repository, this property has no significance.

Show Audit Properties

Displays or hides the audit properties (date created, date changed etc.).

Show BPR Properties

Displays or hides the business modeling properties (under the heading BPR) for those element types that support them, e.g. business functions.

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

When selected, causes the Property Palette to switch automatically to spreadtable view when you create more than one object of the same type.

In spreadtable view, you can list the properties of more than one object at the same time. By contrast, the default view displays the Property Palette as a two-column grid, with the property names listed vertically and their values listed alongside.


Options - Customize Navigator Groups
Customize Navigator Groups (Options Menu)

Related Topics

Customizes which repository objects are displayed in the Navigator window.  For example, if you want to see only the objects associated with database design, you can hide all the other groups. In addition, you can create and delete your own object groups.

Dialog box options

Show/Hide

Enables you to display or hide various groups of repository objects. Note that any changes you make here do not become effective until the next time you use the View→Show Group Tabs option.

Show

When selected, indicates that the corresponding object group is to be displayed in the Navigator window. When clear, the corresponding object group is not to be displayed.

Tab Heading

The name of the object group tab that you want to show or hide in the Navigator window.  About

Description

A description of the object group.

Customize

Allows you to create and delete object groups, and specify which element types the groups are to contain.

List boxes

The left hand panel shows the object groups that you have created, and the element types they contain.  The right hand panel lists all the element types available for inclusion under the selected object group.

Add

Adds an element type to the selected group.

Remove

Removes an element type from the selected group.

MoveUp

Moves a selected element type up the display list in a selected group.

MoveDown

Moves a selected element type down the display list in a selected group.

Add Group

Opens a further dialog box that allows you to enter the name of a new object group, or to copy or modify an existing one.

Delete Group

Deletes a selected user-defined object group.


Create New Navigator Group dialog box

Creates a user-defined object group, and optionally allows you to copy or modify the element types of an existing group.

Dialog box options

Name

The name you want to give the new object group.

Copy Group

Lists the existing object groups that you can copy or modify.


Options - Customize Navigator Views
Customize Navigator Views (Options Menu)

Related Topics

Enables you to define customized views of repository element types. You can then add these views to the display list in the Navigator window.

For example, you might want to create a view that contains only candidate modules, so that you can easily locate them for generation.

Dialog box options

This dialog box has a number of tabs. These do not become active until you define a view name using the Add View button. The tabs are:

Filter Conditions

Sort Sequence

Show Properties

Add View

Displays a further dialog box where you define the view name and the element type upon which it is based.

Delete View

Deletes the selected view from the repository.


Text search buttons

Related Topics

The text search facility allows you to find a text string in the active Navigator window or Property Palette. You enter the string in the text box in the main toolbar at the top of the screen.

•	Text box

This box allows you to enter a text string and begin searching.

•	Find Next button

Searches the active window for the next occurrence of the string entered in the text box. The search for the next occurrence of a text string starts from the selected item and continues to the last item.

•	Find Previous button

Searches the active window for a previous occurrence of the string entered in the text box.


   Find Next button

Related Topics

Finds the next definition that matches the text string in the toolbar text box. The text box is situated to the left of the Find Next button.

0	In the Navigator window, the search starts from the selected node and continues down to the bottom of the window. When the search reaches the bottom of the window, the search continues again from the top. If no matching definitions are found, a message is displayed.

1	In the Property Palette, the search starts at the top of the window and continues to the bottom.


   Find Previous button

Related Topics

Returns to the last item found in a search operation that was initiated by the Find Next button.

0	The Find Previous button is unavailable if the Find Next button has not been previously selected.


   Context-sensitive help button

Provides access to help information about items in the Repository Object Navigator.

0	Clicking this button, or pressing SHIFT+F1, and then choosing a menu option, toolbar button, item in the Navigator window or property in the Property Palette, displays the help topic for the chosen item.

Note:	This facility is very useful for providing immediate information on an object or a property definition.


Collapse/Expand icon

Indicates whether a node has been expanded or collapsed.

0	A Collapse/Expand icon appears to the left of every Navigator window node for which definitions exist in the repository. If a node has no icon next to it, no definitions of that type exist in the repository.

1	The icon can be in one of two different states:

Icon	Meaning
	Collapsed node - definitions at the next level are not displayed
	Expanded node - definitions at the next level are displayed
Clicking the [image] icon expands the node to the next level.

12	Clicking the [image] icon collapses the node.


Shortcut icon

Related Topics

Indicates that the object is referenced from a container other than the current one in the current workarea.

 Shortcut icon

Double-clicking the Shortcut icon navigates to the referenced object. Subsequently clicking the [image] button returns to the original object.


Referenced Object icon

Indicates that the node is a reference to an object that exists elsewhere in the repository.

 Referenced Object icon

Typically a reference indicates a usage by one object of another type of object. For example, an entity attribute that is used by a particular business function will have a reference to that business function under the Usages node for the attribute:

0

1	If you click the Referenced Object icon, the Navigator window shows the referenced object, with its name highlighted and its properties displayed in the Property Palette.

2	Click the [image] button to return to the original display.


Conditions toolbar

	Button	Effect
	Group	Groups two or more selected properties together. You might need to do this to generate the correct SQL statement. 3 To select properties for grouping, click the name of the first property, then hold down the SHIFT or CTRL key and click the name of the second property. Click this button. The () characters are displayed to denote the extent of the grouping.
	UnGroup	Removes grouping from selected properties. 6 To remove grouping, click the name of the first property, then hold down the SHIFT or CTRL key and click the name of the second property. Click this button. The () characters disappear to indicate that grouping has been removed.
	Duplicate Property	Duplicates a selected property. Doing so enables you to specify AND or OR conditions for a property.
	Clear Condition	Blanks out a selected condition value. Click the appropriate Property or Condition field, then click this button.
13	Move Up 14 Move Down	Moves a selected property up or down the list, for grouping purposes. Click the property name, then click the appropriate button as often as desired to move it up or down the list.


Welcome to the Repository Object Navigator

This screen gives you a choice of tasks that you can perform with the Repository Object Navigator.

Where would you like to start?

Invoke Workarea wizard

Creates a new workarea, a space in which you can work on repository objects. You'll need to have at least one workarea accessible before you can start creating repository objects.

Invoke Configuration wizard

Takes you step by step through the process of creating a configuration, a grouping of specific repository objects that make up an application (or part of an application).

Open Navigator

Chooses the level in the repository hierarchy at which you want to open the Navigator window:  the entire repository, or a specific workarea, container, configuration or object.

Search Repository

Locates definitions of objects in the repository. You can search for individual objects of a particular type (e.g. tables, modules) either across the entire repository or within a specific part of it, such as a workarea, container or configuration.

Select Navigator Groups

Chooses which categories of object details you want the Repository Object Navigator to display (e.g. enterprise modeling, module design).

Display this screen on startup

Clear this check box if you prefer not to see this Welcome screen each time you start the Repository Object Navigator.


Using shortcut keys to work with the Repository Object Navigator

Shortcuts for menu options

To		Press		As a shortcut for
Open a new Navigator window		CTRL+O		File→Open
Close the active Navigator window		CTRL+W		File→Close
Save (commit) the property values of the selected object to the repository		CTRL+S		File→Save
Print the contents of the active Navigator window		CTRL+P		File→Print
Exit from the Repository Object Navigator		CTRL+Q		File→Exit
Create a new repository object		INSERT		Edit→Create
Undo the last operation performed		CTRL+Z		Edit→Undo
Remove the selected item or items and place the selection on the Clipboard		CTRL+X		Edit→Cut
Copy the selected item or items to the Clipboard		CTRL+C		Edit→Copy
Place the contents of the Clipboard into the active window		CTRL+V		Edit→Paste
Delete the selected elements from the repository		DELETE		Edit→Delete
Locate object definition		F12		Navigator→Goto Object Definition 26 Properties→Locate Object Definition
Return to the object from which you navigated to a referenced object		SHIFT+F12		Navigator→Return to Object Reference
Make the Navigator window the active window if the Property Palette is active		F3		Tools→Navigator
Open a new Property Palette if none is open, or make the Property Palette the active window if the Navigator window is active		F4 OR ALT+ENTER		Tools→Property Palette
Show this shortcut key help topic		CTRL+K		Help→Show Keys
Shortcuts when using the Repository Object Navigator windows

To		Press
Display the next view in the Navigator window		CTRL+PAGE UP
Display the previous view in the Navigator window		CTRL+PAGE DOWN
Make the next window active		CTRL+F6
Edit properties		ALT+ENTER
Shortcuts when using the Repository Object Navigator dialog boxes

To		Press
Go to the next control		TAB
Go to the previous control		SHIFT+TAB
Abandon changes (Cancel)		ESC


Create New Navigator View dialog box

Related Topics

Enables you to specify details of the new view you are creating.

Name

The name of the new view. This name will appear in the Navigator window when the view has been created and activated.

Based On

The element type to which the view is to apply.


Save As View dialog box

Related Topics

Saves a filtered Navigator window as a user-defined view, which you can subsequently implement. How

View Name

The name you want to give this view. This name will appear in the Navigator window.


Select Associations/Select Type dialog box
Select Associations dialog box
Select Type dialog box

Displays a list of element types from which you can choose when you are creating:

•	a repository object

•	an association or reference (a link between two repository objects)


Generic Select Object dialog box

Related Topics

Displays a list of objects from which you can choose. The actual title of this dialog box depends on the context in which it is displayed.

Filter field

Enables you to enter a filter condition for the list.

 button

Entering a name, or part of a name, and clicking this button restricts the list to those objects whose names match the filter condition.

List box

Lists the objects that are available for selection.

Select All button

Selects all the objects listed.

Clear All button

Deselects all the objects listed.


Create Foreign Key Constraint Components dialog box

Enables you to create components for a foreign key definition.

To enforce the foreign key constraint, you can either specify a single column (the join column) in a table (known as the joining table), or an upper and a lower limit column in a table (known as the range table). In this way, you can ensure that values in the column on which the constraint is defined match those in the join column, or fall in the range defined in the upper and lower limit columns.

For Foreign Key Constraint

The name of the foreign key definition for which you are creating components.

Constraint on Table

The name of the table that is to have a foreign key defined.

The list below this table name shows all the columns defined for this table. Select one to use as the foreign key column.

Joining Table/Range Table

The name of the table that is joined to the first table by this foreign key constraint.

The list below this table name shows all the columns defined for this table. Select one to use as the primary key of this referenced table.

 button

Moves the selected details to the text panel at the bottom of the screen.

Join Column

Specifies that the selected column in the Joining Table/Range Table list is a join column (that is, you are using a single column in the referenced table to validate values in the foreign key column).

Lower Limit Column
Upper Limit Column

Specifies that the selected column in the Joining Table/Range Table list is a lower limit or upper limit column respectively (that is, you are using a range table to validate values in the foreign key column). The Upper Limit Column option button is not activated until you have specified a lower limit column.

Details field

Contains the details of the foreign key constraint you are defining.

Reset

Changes the dialog box settings back to the state they were in when the dialog box was invoked.


Export Wizard

The Export Wizard enables you to export repository data to a file in one of the following formats:

•	Oracle database export format

•	text format

In database format, you can choose to export an entire workarea or configuration, or one or more selected containers from a particular workarea.

In text format, you can export anything from an individual PAC or SAC element to the entire contents of a workarea.

A successful export operation generates various output displays but no error messages. To confirm that an export was successful, look at the end of the export log file for the message "Export terminated successfully without warnings".

Export data to Oracle database export file

This option uses the Oracle database server Export utility. You can use this format when transferring data from one Oracle (or compatible) database to another. The data is exported to a file known as a dump file, which has the default extension .DMP.

The wizard checks for external references during the export operation. These occur when an object that is owned by one container has references to objects owned by a different container. If external references are found, the wizard allows you to choose how you want to process them.

Export data to a text file

This option uses the Repository Loader utility. You can use this format only when transferring data from one Oracle Repository installation to another. The data is exported to an ASCII text file in the Repository Loader format, which has the default extension .DAT.

Use this format if you suspect incompatibilities between the source and target repositories, for example because of different database versions.

You can edit the exported data in the file if you are familiar with the Repository Loader format. About


Export Wizard: Options Required

From this screen you choose which objects you want to export. Your choices are:

Option	Sub-Option	Effect
Export an entire workarea	Export only versions visible in a resolved view	Exports all objects or object versions defined by the workarea specification, but not the workarea specification itself.
	Export all versions included in all rules or configurations that make up the workarea	Exports all objects or object versions defined by the workarea specification, together with the specification itself.
	Export only checked-out and non-versioned objects	Exports only objects that are checked out or not under version control, but not the workarea specification. Containers are exported irrespective of state, because they are required to give context to the other checked-out objects.
	Export all versions of all objects in a workarea	Exports the entire version history of every object defined by the workarea specification, together with the specification itself.
Export all objects in a configuration	-	Exports a configuration and all its contents.
Export selected container from a specified workarea	Recurse not selected	Exports all members of a container, including subcontainers but not their contents.
	Recurse selected	Exports all members of a container, including subcontainers and all their contents.


Export an entire workarea

Exports a selected workarea. You can choose how much of the workarea to export: for example, only certain object versions, or all versions of all objects in the workarea. The workarea specification may or may not be exported, depending on the option you choose.

Dialog box options

Specify workarea to export

The name of the workarea to be exported. If you selected a workarea before starting the Export Wizard, the name appears here. Alternatively, you can enter a workarea name, or choose one using the Browse button.

Export only versions visible in a resolved view

Exports only those objects or object versions that are visible in this workarea in the Navigator window. These are defined by the rules and configurations that make up the workarea specification, though the specification itself is not exported. Thus for example, if the workarea specification consists of two rules, LATEST(MAIN) and LATEST(TEST), then objects that appear on both the MAIN and TEST branches have the latest versions from both branches exported.

Export all versions included in all rules or configurations that make up the workarea

Exports only those objects or object versions that are visible in this workarea in the Navigator window. These are defined by the rules and configurations that make up the workarea specification, which is also exported.

Export only checked out and new objects

Exports only checked-out versions of objects in this workarea, together with any objects in the workarea that are not under version control. The workarea specification is not exported.

Export all versions of all objects in a workarea

Exports every version of every object defined by the workarea specification, together with the specification itself. Doing so allows you to export the complete version history of an object. Use this option with caution, however, as it could result in an extremely large export file.


Export all objects in a configuration

Exports a configuration and all its member objects or object versions. You can use the Browse button to locate and select a configuration.


Export selected container from a specified workarea

Exports the contents of a selected container from a specified workarea.

Dialog box options

Specify workarea from which to export container

The name of the workarea from which the container is to be exported. If you selected a workarea before starting the Export Wizard, the name appears here. Alternatively, you can enter a workarea name, or choose one using the Browse button.

Select container to export

The name of the container whose contents you want to export. If you selected a container before starting the Export Wizard, the name appears here. Alternatively, you can enter a container name, or choose one using the Browse button.

Recurse through sub directories

When selected, exports all members of a container, including subcontainers and all their contents. When clear, exports all members of a container, including immediate subcontainers but not their contents.


Export Wizard: Export File and Log File

Specifies where you want to store the export file itself and the log file produced by the export operation.

Dialog box options

Specify export file

The name and location of the file that is to contain the exported data. You can enter a file name and location, or choose one using the Browse button. Make sure the location is a directory to which you have write access.

Specify log file

The name and location of the file that is to contain the log data from the export operation. You can enter a file name and location, or choose one using the Browse button. Make sure the location is a directory to which you have write access.

Dependencies

Export dependency tables

(Database export format only) If you want to export any dependency information for the exported objects that has been created by the Dependency Manager tool, select this check box, otherwise leave it clear. Note that including dependency information could result in exporting a very large amount of repository data.

Display files when finished?

If you want to see the contents of the export file and log file when the operation has finished, leave the default option Yes, otherwise choose No.

Advanced Options

(Database export format only) Displays a further dialog box in which you can specify a rollback segment to use for the export operation. The dialog box also enables you to choose a tablespace for the temporary tables that contain the exported data.

Finish

Begins the export operation.

When you click Finish, you may see a message that the temporary tables are already populated. This means that data from an earlier export or import operation is still in these tables. Click Yes to continue, overwriting the existing data in the temporary tables. Note that there is only one set of temporary tables per repository username. Thus if more than one user runs the Export utility using the same repository username, export data may be unintentionally overwritten.


Advanced Options dialog box

Enables you to specify further import or export options.

Dialog box options

Storage information

Specify rollback segment

Enables you to choose a rollback segment for the operation. An export or import operation may require a large rollback segment if operating on large volumes of data. The dropdown list shows the rollback segments that are available; make sure you choose one that is large enough for the amount of data you are importing or exporting. How

If none of these is large enough contact your database administrator, who can define one that you can select here.

Specify tablespace for table and index storage

Enables you to choose a tablespace to store the temporary tables (also known as the XT tables) used by the operation, together with their indexes.

Export

These check boxes are activated only when you are using the Export Wizard.

Extract registered meta data

When selected, includes data from Oracle schemas that have been registered in the repository. This check box is active only if such data exists in the workarea, container or configuration selected for export.

Import

These check boxes are activated only when you are using the Import Wizard.

Remove dangling references

When selected, removes from the imported data any references to objects that do not exist in the target repository.

Frequent updates

When selected, commits the data to the target repository at frequent intervals during the import operation. We do not recommend performing frequent updates unless you are importing a large amount of data. However, if the operation fails in this case, you may need to roll back manually as the operation would be only partially completed. Because of this, we recommend that the repository owner backs up the repository before anyone uses the frequent updates option.

When cleared, commits only at the end of the operation.


Export Wizard: Objects Selected

This enables you to select one or more individual objects for export. You do this by selecting objects in the left-hand pane and moving them to the right-hand pane by means of the arrow buttons.

Left-hand pane

Shows the objects available for export. This is a list of all objects visible in the current workarea.

Right-hand pane

Shows the objects that are selected for export.

Moves a selected object from the left-hand (available objects) pane to the right-hand (objects selected) pane.

Selects all available objects for export.

Moves a selected object from the right-hand (objects selected) pane to the left-hand (available objects) pane.

Deselects all objects selected for export.


Import Wizard

The Import Wizard enables you to import repository data from a file in one of the following formats:

•	Oracle database export format

•	text format

Import from an Oracle database export file

This option uses the Oracle database server Import utility. You can use this format when transferring data from one Oracle (or compatible) database to another. The data is imported from a file known as a dump file, which has the default extension .DMP.

Import from a text based export file

This option uses the Repository Loader utility. You can use this format only when transferring data from one Oracle Repository installation to another. The data is imported from an ASCII text file in the proprietary Repository Loader format. This file has the default extension .DAT. About


Import Wizard: Import File and Error Log File

Enables you to specify the import file you want to use, and the details of the log files produced by the import operation.

Note:	When you click Next on this screen, you may see a message to the effect that the temporary tables are already populated. This means that data from an earlier export or import operation is still in these intermediate tables, sometimes known as XT tables. Click Yes to continue (doing so will overwrite the existing data in the temporary tables).

Dialog box options

Specify import file

The name and location of the file that contains the data to be imported. You can enter a file name and location, or choose one using the Browse button.

Specify error log file

The name and location of the file that is to contain the error log data from the import operation. You can enter a file name and location, or choose one using the Browse button.

Display logs when finished?

If you want to see the contents of the log files when the operation has finished, leave the default option Yes, otherwise choose No.

Advanced Options

Displays a further dialog box in which you can specify a rollback segment to use for the import operation, and choose a tablespace for the temporary tables.


Import Wizard: Import File

Enables you to specify the import file you want to use.

Dialog box options

Specify import file

The name and location of the file that contains the data to be imported.

Browse

Enables you to locate and choose an import file.

View

Displays the contents of the specified import file.


Import Wizard: Select Container

You see this screen if you are importing data that has no record of an owning container. Because the Import utility needs to know which container to use at the target repository, you must specify a container here.

Dialog box options

Select container

The name and location of the container into which the data to be imported.

Browse

Enables you to locate and choose a container.


Import Wizard: Error Log and Redo Log

Enables you to specify the details of the log files produced by the import operation.

Dialog box options

Specify error log file

The name and location of the file that is to contain the error log data from the import operation. You can enter a file name and location, or choose one using the Browse button.

Specify redo log file

The name and location of the file that is to contain the redo log data from the import operation. You can enter a file name and location, or choose one using the Browse button.

Display logs when finished?

If you want to see the contents of the log files when the operation has finished, leave the default option Yes, otherwise choose No.


Import Wizard: File Contents

This screen lists:

•	the release level of the data you are about to import

•	whether the data was exported from a versioned repository

•	the container level (root or subcontainer) from which the data was exported

•	the temporary repository tables from which you are about to import

The temporary repository tables hold the object and container data that was exported to the dump file.


Import Wizard: Workarea and Container

Enables you to specify the workarea, and the container in that workarea, that is to receive the imported data.

Specify workarea

The name of the workarea to which you want to import the data. You can enter a workarea name, or choose one using the Browse button.

Specify container

The name of the container in the specified workarea to which you want to import the data. The default name is that of the container that was originally exported in the source repository. You can enter a container name, or choose one using the Browse button.


Import Wizard: Create or Update Objects

Enables you to specify whether you want the data to be imported as new objects or object versions, or as updates to existing objects.

The options are:

Create brand new objects

Create new versions where objects exist

Update existing object versions

Some of these options may not be available, depending on how the data was exported. For example, if you exported an entire unresolved workarea with multiple object versions, only the option to create brand new objects is available.

Create brand new objects

Creates new objects in the repository for all the data in the import file, regardless of whether the imported objects already exist in the target repository.

Importing a ...	Effect
Workarea (unresolved)	If you are importing a workarea that has unresolved version conflicts, this option creates a new workarea based on the workarea specification, including all the object versions referred to in the specification. All configurations, rules and container memberships are preserved. Non-versioned objects, and checked-out objects (imported with no version history), are imported as new objects. Checked-in objects are imported unchanged and are placed on the MAIN branch with a single version.
Workarea (resolved)	If you are importing a workarea with no version conflicts, this option loads the objects into the target workarea, creating a single version of each object.  Objects that were checked out or not under version control in the source repository are imported as new objects. Objects that were checked in in the source repository are created as checked-in objects on the MAIN branch. You can use an existing workarea as the target, or you can create a new one with a name you specify in the wizard.  Note that, if you create a new workarea in this way, its specification is empty. Because of this, the new workarea does not include the system folder. Thus all objects that originally referred to objects (such as Languages) in the system folder show null references. You can avoid this situation by creating a new workarea using the Workarea Wizard ) before importing.
Container	Loads the container and its contents into an existing workarea. The container can be imported as a subcontainer, even if it was exported from the source repository as a root container. The container name must be unique within its target context (i.e., workarea root container or subcontainer). Checked-out objects are imported as new objects. Checked-in objects are imported unchanged on the MAIN branch. If you choose the Recurse option, the import includes the container and its contents, together with all its subcontainers and all of their contents.
Configuration	Creates a new configuration containing all objects specified for import. Objects are imported checked in, and are placed on the MAIN branch with a single version. The original version label is maintained.
Create new versions where objects exist

With this option, if an object you are importing already exists in the repository, a new version is created for the imported data. If an object you are importing does not already exist in the repository, a new object is created.

Importing a ...	Effect
Workarea	Loads the objects into the target workarea.  Objects that were checked out or not under version control in the source repository are imported as new objects.  Objects in the source repository that were checked in are created as checked-in objects on the MAIN branch.  You can use an existing workarea as the target, or you can create a new one with a name you specify in the wizard.
Container	Loads the container and its contents into an existing workarea. The container can be imported as a subcontainer, even if it was exported from the source repository as a root container. The container name must be unique within its target context (i.e., workarea root container or subcontainer). If you chose the Recurse option for export, the import includes the container and its contents, together with all its subcontainers and all of their contents. Objects that were checked out or not under version control in the source repository are imported as new objects.  Objects in the source repository that were checked in are created as checked-in objects on the MAIN branch.
Configuration	Creates a new configuration containing all objects specified for import. Objects are imported checked in, and are placed on the MAIN branch with a single version. The original version label is maintained.
Update existing object versions

Caution:	This option is for advanced users wishing to synchronize source and target repositories (i.e., it provides a way of replicating repository data on another database). Because it can overwrite data on the target repository, this option should be used with care.

If an object version you are importing already exists in the repository, this option overwrites the existing version even if that version is checked in. However, if a different version of the object already exists (i.e., it has the same IRID object identifier but a different IVID version identifier), a new version is created. If the object you are importing does not already exist in the repository, a new object is created.

Versioned objects are loaded with the same IRID and IVID values that they had in the source repository. If an object with the same IRID and IVID values already exists in the target repository, it is updated with the properties from the imported data.

Importing a ...	Effect
Workarea (unresolved)	Creates a new workarea based on the workarea specification, including all the object versions referred to in the specification. All configurations, rules and container memberships are preserved.
Workarea (resolved)	Loads the objects into the target workarea, creating a single version of each object. You can use an existing workarea as the target, or you can create a new one with a name you specify in the wizard.
Container	The container retains all the properties that it had in the source repository.  All object versions are imported with the same IRID (object identifier) and IVID (version identifier) values that they had in the source repository. If an object with the same IVID value exists in the target repository, all properties of the object are overwritten by those of the imported object. If there is no object with a matching IVID value, the imported object is inserted into the target repository. If you chose the Recurse option for export, the import includes the container and its contents, together with all its subcontainers and all of their contents, retaining all the properties from the source repository.
Configuration	The configuration retains all the properties that it had in the source repository. All object versions are imported with the same IRID (object identifier) and IVID (version identifier) values that they had in the source repository. If an object with the same IVID value exists in the target repository, all properties of the object are overwritten by those of the imported object. If there is no object with a matching IVID value, the imported object is inserted into the target repository.


Import Wizard: Container Data

This screen indicates that you are importing data that was originally exported from a container.

Specify workarea

The name of a target workarea in which to place this data. If you selected a container when starting the wizard, the workarea in which you selected this container is shown by default. You can choose a workarea by means of the Browse button.


Import Wizard: Container Details

This screen indicates that you are importing data that was originally exported from a container, and you have chosen to create brand new objects.

On this screen you need to specify a few details about the target container. You can either create a new container to hold the objects, or you can add them to an existing container.

Create as a root container at target

This option creates a new root container, with the specified name, in the target workarea.

Add to an existing context folder

This option adds the objects to an existing container, which you specify as follows:

Specify Container Context

Enter the name and location of the target container, or choose one by means of the Browse button.

Specify Name at Target

Specify a new name for the target container if desired, otherwise leave the existing name here.


Import Wizard: Container Exists

This display is for information only. It indicates that you are importing a container that already exists in the target repository and that you have chosen to update existing objects or object versions. This means that you will not be able to move or rename the container in the repository during the import process.


Import Wizard: Resolved Workarea

This display indicates that you are importing data originally exported from a workarea that has no version conflicts.

Specify workarea

Enables you to choose the target workarea. You can:

•	specify the same name as the source workarea (default)

•	specify a target workarea with a different name from the source

You can use the Browse button to locate and select an existing target workarea to use.

If the specified workarea exists in the target repository, the imported data will be merged with its contents. If the specified workarea does not exist, a new workarea is created with that name in the target repository and the data is imported.


Import Wizard: Unresolved Workarea

This display indicates that you are importing data originally exported from a workarea that has objects with multiple versions, and which has not been refreshed to resolve version conflicts. You must create a new workarea to use for the imported data.

Specify workarea

Enables you to specify a new workarea as the target workarea.

Click Finish to complete the operation or Cancel to abandon it, or click Back to change the options you have chosen.


Audit Search Specification dialog box

Enables you to specify object audit properties on which to search.

Date Created

The date when the object was created. You can use query-by-example format, e.g. a value of >1-JAN-99 would search for objects created after this date.

Date Last Modified

The date when the object was last modified. You can use query-by-example format, e.g. a value of >1-JAN-99 would search for objects last modified after this date.

Using Date Format

The date format used by objects that you are searching for. You can choose either DD-MON-YY or DD-MON-YY HH:MI:SS.

Created By

The name of the user who created the object.

Modified By

The name of the user who last modified the object.

No. of Times Modified

The number of times that the object has been modified.

Display Audit Properties

If selected, displays the audit properties in the Search Results dialog box for any objects that match the search conditions.


Version Search Specification dialog box

Enables you to specify object version properties on which to search. You can use these properties to search for objects under version control. You can also search for objects that are not under version control.

Status

The version status to search for. You can search on any combination of these.

Checked In

Searches for checked-in objects under version control.

Checked Out

Searches for checked-out objects under version control.

Not Versioned

Searches for objects that are not under version control.

Version Label

The version label for which to search. You can use the % wildcard.

On Branch

The checkin branch on which to search. You can use the % wildcard.

Display Version Properties

If selected, displays the object version properties in the Search Results dialog box for any objects that match the search conditions.


Repository Search (Advanced) dialog box

This dialog box enables you to perform advanced searches by setting complex search conditions.

Dialog box options

For Type

The type of object for which you are searching.

The dialog box has the following tabs:

Filter Conditions

Sort Sequence

Show Properties


SQL dialog box

Displays the SQL statement that is generated by the parameters that you have set in the Repository Search dialog box.

You can edit the SQL statement in the display window before clicking Execute.


Select Display Group Filter dialog box

Enables you to choose the categories of repository objects that you would like the Navigator window to display. About


Object Hierarchies

Related Topics

For some element types, you can create object instances and display them in a hierarchical fashion. For example, you might want to define a business unit, UNIT1, which has two sub-divisions, UNIT1A and UNIT1B.

The element types for which you can create and display object instances hierarchically are:

Business Functions

Business Units

Critical Success Factors

Domains

Entities

Item Groups

Key Performance Indicators

Locations

Objectives

Modules

Problems


View - List
   List (View Menu)

Displays the names of the repository items in a single-column list.


View - Icons
   Icons (View Menu)

Displays the names and icons of the repository items in a multi-column list.


View - General Details
   General Details (View Menu)

Displays various general details about the objects in the list.

You can choose which details to show. The default set is: name, element type, the date when the object was created, who created it, when it was modified, the user who last modified it and the number of times the item was modified.


View - Version Details
   Version Details (View Menu)

Displays version details, if any, about the objects in the list.

You can choose which details to show. The default set is:  name, element type, branch identifier, version number, version label, status, rule or configuration that caused the object to be included in the workarea, and (if it is currently checked out) the date it was checked out and by whom.


View - Pin Details
   Pin Details (View Menu)

Causes the details displayed in the Details dialog box to remain unchanged (pinned) even if you select another repository object from the Navigator. The Details dialog is in the 'pinned' state when the button is displayed as [image].


View - Show/Hide
Show/Hide (View Menu)

Enables you to choose which object properties to show in the Details window.

Dialog box options

Show in Details View:  General

These check boxes control which properties you see when you select General Details using the [image] toolbar button.

Show in Details View:  Version

These check boxes control which properties you see when you select Version Details using the [image] toolbar button.

The group of properties in the left panel are more general properties, while those in the right panel are specifically related to version control, but you can display any selection of properties in either mode.

IRID

The 38-digit unique identifier of the object.

Type

The element type.

Size

The size of the object in bytes.

Timestamp

The time when the object was last changed.

Date Created

The date when the object was created.

Created By

The user who created the object.

Date Modified

The date when the object was last modified.

Modified By

The user who last modified the object.

No. Modifications

The number of times that the object has been modified since its creation.

IVID

The 38-digit version identifier of the object.

Version

The version number (an integer number) for the object version included in this workarea.

Version Label

The version label for the object version included in this workarea.

Status

The object status:  Checked In, Checked Out or Not Versioned.

Rule

The rule in the workarea specification that causes this object to be included in the workarea, for example LATEST (MAIN).

Date Checked Out

If the object is currently checked out, the date when it was checked out.

Checked Out By

If the object is currently checked out, the user who checked it out.


Copy dialog box

Displays details of objects that you are copying.

Copy

The name and path in the repository of the objects that you have selected to copy.

To

The destination container (the one to which you are copying the objects).

Deep copy

Copies the PAC element and all of its children (for example, for a table definition, copies the columns, unique keys, check constraints etc. as well). When cleared, copies only the PAC element. Note that when copying diagrams, clearing this check box has no effect.

Recurse subcontainers

If you are copying a container, copies the contents of any of its subcontainers as well.

Auto checkout

Causes the destination container to be checked out automatically.

Copy dependencies

Copies any dependency information for the object that has been created by the Dependency Manager tool. When cleared, no dependency information is copied.

Don’t show this dialog again

Select this check box if you do not want to see the Copy dialog box every time you copy an object.


Move dialog box

Displays details of objects that you are moving.

Move

The name and path in the repository of the objects that you have selected to move.

To

The container to which you are moving the objects.

Auto checkout

Causes the destination container to be checked out automatically.

Don’t show this dialog again

Select this check box if you do not want to see the Move dialog box every time you move an object.


File service alert

This indicates that you are attempting to do one of the following:

•	Upload a file that already exists in the repository

•	Download a file that already exists in the file system

You must choose how you want to proceed in order to synchronize the repository and file system copies.

If you are ...	Message displayed
Uploading a file	Upload and overwrite any changes ?  About
Downloading a file	Download and overwrite any changes ?  About


File service alert - uploading a file

If you are uploading a file that already exists in the repository, your choices are as follows. Note that checked-in files cannot be overwritten and are skipped.

Yes

Uploads the file, overwriting the one already in the target container. If other files in this upload operation exist in the target container, you will be prompted again for each file.

Yes to All

Uploads this and any other files you have specified, including any others that already exist in the target container. These files will be overwritten, with no further prompting.

No

Skips this file and continues uploading any other files you have specified. If other files in this upload operation exist in the target container, you will be prompted again for each file.

No to All

Skips this and any other files you have specified that already exist in the target container. Uploading continues with other files that do not already exist in the container.


File service alert - downloading a file

If you are downloading a file that already exists in the file system, your choices are:

Yes

Downloads the file, overwriting the one already in the file system. If other files in this download operation exist in the target file system, you will be prompted again for each file.

Yes to All

Downloads this and any other files you have specified, including any others that already exist in the target file system. These files will be overwritten, with no further prompting.

No

Skips this file and continues downloading any other files you have specified. If other files in this download operation exist in the target file system, you will be prompted again for each file.

No to All

Skips this and any other files you have specified that already exist in the target file system. Downloading continues with other files that do not already exist in the file system.


File synchronization alert

This indicates that you are synchronizing a file or its container where the file has been deleted from the repository but not from the file system.

The message "File name has been removed from the workarea" is displayed. You must choose how you want to proceed. Even if you choose not to delete the file from the file system, it is not automatically uploaded to the repository (to achieve this, repeat the synchronization specifying the option to include files new to the repository).

Your choices are:

Yes

Deletes the file from the file system. If the same situation occurs for other files in this operation, you will be prompted again for each file.

Yes to All

Deletes this and any other files for which the same situation occurs in the current operation. These files are deleted with no further prompting, and synchronization continues for any other files you have specified.

No

Does not delete this file, and continues synchronizing any other files you have specified. If the same situation occurs for other files in this operation, you will be prompted again for each file.

No to All

Does not delete this or any other files in the same situation in this operation. Synchronization continues for any other files you have specified.


Transfer Ownership dialog box

Enables you to transfer ownership of the selected item to another user.

Transfer ownership on

Indicates the workarea, container or configuration for which you are transferring ownership.

To user

The repository user who is to be the new owner.


Synchronization Error dialog box

Lists files that have been changed in the file system while the repository copy is still checked in. These are known as "hijacked files".

File list

Shows a list of the hijacked files.

Upload the file(s) and overwrite repository changes

Uploads the hijacked files from the file system, overwriting the repository copies.

Download the file(s) and overwrite file system changes

Downloads the copies from the repository, overwriting the hijacked files in the file system.

Deal with files individually

Displays a further dialog box enabling you to deal with these files on an individual basis.


Resolve Synchronization Errors dialog box

Enables you to synchronize repository and file system copies of files where synchronization was not possible.

In each case, you can choose whether you want to use the file system copy (upload), the repository copy (download), or merge the two copies. Before doing so, you can check the file in or out, view its version history and compare the two copies.

Repository element

The name of a file that could not be synchronized.

Synchronization state

Indicates why synchronization was not possible. This might be because:

•	the repository and file system copies are different and the system cannot automatically resolve the situation (this is the meaning of the "no valid .RVI entry" message)

•	both the repository and the file system copies have changed

•	the file system copy has been changed while the repository copy was still checked in (this is known as a "hijacked file")

Version state

Indicates whether the repository copy is checked in, checked out or is a new (i.e., non-versioned) file.

File system path

Indicates where the file system copy is located.

Overwrite

Upload

Uploads the selected files from the file system, overwriting the repository copy.

Download

Downloads the selected files to the repository, overwriting the file system copy.

Merge

Enables you to merge the two copies of a selected file. If any conflicts are detected, the Merge window is opened, enabling you to resolve the conflicts.

Version

Check in

Checks in selected files if they are currently checked out.

Check out

Checks out selected files if they are currently checked in.

Utilities

Version history

Runs the Version History Viewer for a selected file, enabling you to view the version history of the file as a graphical tree.

Compare

Highlights the differences between the repository and the file system copies of a selected file.

Select all

Selects all the files in the list for a particular operation.


Source Control Options dialog box

Enables you to view or change various repository connection and container options. This dialog box is available from Oracle Developer Form Builder and Oracle Developer Report Builder.

Repository Connection

Displays the username and database alias for the user currently connected to the repository. The Change button allows you to change the connection.

Workarea

Displays the current workarea. The Change button allows you to change the workarea.

Container

Use this field to select the container that you want to:

•	check the Oracle Developer file out from

•	check the Oracle Developer file in to

We recommend that you store Oracle Developer files in repository folders (i.e. not application systems or other container types).

Container file system mapping

Displays the directory on the file system that is mapped to the container specified in the Container field. If the specified container is not mapped to a file system directory, this field is empty.

Container access rights

Displays the access rights on the container specified in the Container field.


Select Type dialog box

Allows you to select the types of repository objects to be copied or deleted.

Dialog box options

The list box displays all the available element types in the repository. Select the types for which you want to copy or delete objects and click OK. The Select Object dialog box is displayed.


Select Object dialog box

Allows you to select the repository objects to be added to the copy/delete list on the Copy Objects/Force Delete dialog box.

Filter control

Allows you to filter the repository object definitions that are displayed in the list box.

List box

Lists the existing repository objects from which you can choose.

Select one or more entries from this list to identify the repository objects that are to be added to the copy/delete list.

Select All

Selects all entries in the list box. This button is available only if there is more than one entry in the list box.

Clear All

Deselects all entries in the list box.


Compare Workarea dialog box

Allows you to choose whether to compare workareas based on the workarea contents or the workarea specification.

Compare workarea contents

Displays the differences in the set of objects and object versions that are visible in the workarea.

Compare workarea specification

Displays the differences in the set of rules and configurations that determine what is visible in the workarea.


Rules for workarea and configuration specifications

Workareas and configurations are defined by specifications. A specification is a set of rules that define which object versions should be included and which excluded.

When you are creating a workarea or a configuration, one option is to create the workarea or configuration from a set of rules stored in a specification file. Each rule must be on a separate line in a specification file.

A repository rule takes one of the following forms, depending on the rule:

rule_name(object=element_type[, parameters])

rule_name(branch_label[, parameters])

where:

rule_name identifies the rule, for example, INCLUDE_FOLDER or EXCLUDE_OBJECT.

object is a version resolved name (that is, a name that includes a specific version label) which identifies a particular version of a repository object.

element_type is the element type of the object.

parameters are the various rule parameters, explained later in this topic.

branch_label identifies a particular checkin branch, where a rule requires this.

List of available rules

Examples

The following some examples of rules as they appear in a workarea specification:

INCLUDE_FOLDER(NF_HOLLYWOOD{1.2.1.1}=Folder)

EXCLUDE_OBJECT(NF_HOLLYWOOD{1.2.1.1}/REGION{1.1}=Domain)

FOLDER_LATEST_CONTENTS(NF_HOLLYWOOD{1.2.1.1}=Folder,fix06)

LATEST_BETWEEN(fix06,24-FEB-2000,19-APR-2000)

The INCLUDE_FOLDER rule includes in the workarea all the objects from version 1.2.1.1 of the folder named NF_HOLLYWOOD.

The EXCLUDE_OBJECT rule specifically excludes from the workarea version 1.1 of the domain named REGION.

FOLDER_LATEST_CONTENTS specifies that the workarea is to include the latest versions of all objects in version 1.2.1.1 of the NF_HOLLYWOOD folder on the checkin branch named fix06.

The LATEST_BETWEEN rule restricts the workarea to includes the latest versions of all objects on the checkin branch named fix06 that were checked in between 24 February 2000 and 19 April 2000.

Identifying objects in repository rules

Objects are identified in rules using version resolved names, which include a version label that identifies a particular version of a repository object. Generally, the type of object can be specified in addition to the version resolved name by including an equal sign (=) and the element type of the object after the name.

If any special characters are used in an object name, they must be preceded by a caret mark (^).

Dates in repository rules

Some repository rules require dates to be included. Dates can be given in any of the following formats:

DD-MON-YYYY

DD-MON-YYYY HH:MI:SS

Examples:

19-APR-2000

19-APR-2000 12:00:00


Repository rules

The available rules for specifying a workarea or configuration are:

Rule	Effect
EXCLUDE_FOLDER	Excludes all specified containers
EXCLUDE_OBJECT	Excludes all specified objects
FOLDER_LATEST_BEFORE	Includes the latest versions of all objects in the specified container that were checked in before the specified date
FOLDER_LATEST_BETWEEN	Includes the latest versions of all objects in the specified container that were checked in between the specified dates
FOLDER_LATEST_CONTENTS	Includes the latest versions of all objects in the specified container on the specified branch
INCLUDE_CONFIG	Includes all the object versions defined by a configuration
INCLUDE_FOLDER	Includes the latest versions of all objects in the specified container
INCLUDE_OBJECT	Includes the latest version of the specified object
LATEST	Includes the latest versions of all objects on the specified branch
LATEST_BEFORE	Includes the latest versions of all objects on the specified branch that were checked in before the specified date
LATEST_BETWEEN	Includes the latest versions of all objects on the specified branch that were checked in between the specified dates
LATEST_CONFIG_CONTENTS	Includes the latest versions of all the objects in the specified configuration
LATEST_DIAGRAM_CONTENTS	Includes the latest versions of all the objects on the specified branch that make up the specified diagram
EXCLUDE_FOLDER repository rule

Excludes all specified container versions.

EXCLUDE_FOLDER(<folder-path>=<container-element-type>)

Examples

The following excludes version 1.2.1.1 of folder reports:

EXCLUDE_FOLDER(reports{1.2.1.1}=Folder)

The following excludes the version of folder fix(reports) that is on branch fix06 and has sequence number 4 on that branch:

EXCLUDE_FOLDER(fix^(reports^){fix06;4}=Folder)

EXCLUDE_OBJECT repository rule

Excludes all the specified object versions.

EXCLUDE_OBJECT(<object-path>=<element-type>)

Examples

The following excludes version 1.1 of the domain LIST OF THINGS in version 1.2.1.1 of folder reports:

EXCLUDE_OBJECT(reports{1.2.1.1}/LIST OF THINGS{1.1}=Domain)

The following excludes the object MASTER TABLE that has the version sequence 6 on the MAIN branch that is in the latest version of the MAIN branch of folder reports:

EXCLUDE_OBJECT(reports{MAIN;LATEST}/MASTER TABLE{MAIN;6}=Table Definition)

FOLDER_LATEST_BEFORE repository rule

The FOLDER_LATEST_BEFORE repository rule includes the latest versions of all objects in the specified container that were checked in before the specified date.

FOLDER_LATEST_BEFORE(<folder-path>=<container-element-type>,<before-date>)

Examples

FOLDER_LATEST_BEFORE(wa-specs{1.0.1.0}=Folder,19-APR-2000)

FOLDER_LATEST_BEFORE(reports{1.2.1.1}=Folder,19-APR-00 08:00:00)

FOLDER_LATEST_BETWEEN repository rule

The FOLDER_LATEST_BETWEEN repository rule includes the latest versions of all objects in the specified container that were checked in between the specified dates.

FOLDER_LATEST_BETWEEN(<folder-path>=<container-element-type>,<start-date>,<end-date>)

Example

The following includes the only or the latest versions of all objects in folder wa-specs{1.0.1.0} between the given dates:

FOLDER_LATEST_BETWEEN(wa-specs{1.0.1.0}=Folder,19-APR-2000,30-APR-2000)

FOLDER_LATEST_CONTENTS repository rule

The FOLDER_LATEST_CONTENTS repository rule includes the latest versions of all objects in the specified container on the specified branch.

FOLDER_LATEST_CONTENTS(<folder-path>=<container-element-type>,<branch-label>)

Example

The following includes the latest versions of objects in folder reports{1.2.1.1} on branch fix06:

FOLDER_LATEST_CONTENTS(reports{1.2.1.1}=Folder,fix06)

INCLUDE_CONFIG

INCLUDE_CONFIG, while not strictly a repository rule, has a similar format to repository rules. It is used to include a configuration, that is, to include all the object versions defined by a configuration.

INCLUDE_CONFIG(<configuration-path>)

Example

The following includes all the object versions defined by the configuration version services_internal{1.0}.

INCLUDE_CONFIG(services_internal{1.0})

INCLUDE_FOLDER repository rule

The INCLUDE_FOLDER  repository rule includes the latest versions of all objects in the specified container.

INCLUDE_FOLDER(<folder-path>=<container-element-type>)

Example

The following includes the latest versions of all objects in the version of folder reports that has sequence number 5 on the MAIN branch:

INCLUDE_FOLDER(reports{MAIN;5}=Folder)

INCLUDE_OBJECT repository rule

The INCLUDE_OBJECT repository rule includes the latest or the specified version of the specified object.

INCLUDE_OBJECT(<object-path>=<element-type>)

Example

The following includes version 1.0 of the Domain element LIST OF THINGS in the folder reports version 1.2.1.1:

INCLUDE_OBJECT(reports{1.2.1.1}/LIST OF THINGS{1.0}=Domain)

LATEST repository rule

The LATEST repository rule includes the latest versions of all objects on the specified branch.

LATEST(<branch-label>)

Example

The following includes the latest versions of objects on branch fix06:

LATEST(fix06)

LATEST_BEFORE repository rule

The LATEST_BEFORE repository rule includes the latest versions of all objects on the specified branch that were checked in before the specified date.

LATEST_BEFORE(<branch-label>,<before-date>)

Example

LATEST_BEFORE(fix06,19-APR-2000)

LATEST_BETWEEN repository rule

The LATEST_BETWEEN repository rule includes the latest versions of all objects on the specified branch that were checked in between the specified dates.

LATEST_BETWEEN(<branch-label>,<start-date>,<end-date>)

Example

LATEST_BETWEEN(FIX06,19-APR-2000,30-APR-2000)

LATEST_CONFIG_CONTENTS repository rule

The LATEST_CONFIG_CONTENTS repository rule includes the latest versions of all the objects defined by the specified configuration.

LATEST_CONFIG_CONTENTS(<configuration-path>=Configuration,<branch-label>)

Example

The following includes the latest version on branch fix06 of all the objects defined by configuration version fix_config{MAIN;LATEST}:

LATEST_CONFIG_CONTENTS(fix_config{MAIN;LATEST}=Configuration,fix06)

LATEST_DIAGRAM_CONTENTS repository rule

The LATEST_DIAGRAM_CONTENTS repository rule includes the latest versions of all the objects on the specified branch that make up the specified diagram.

LATEST_DIAGRAM_CONTENTS(<diagram-path>=Diagram,<branch-label>)

Example

LATEST_DIAGRAM_CONTENTS(ANALYSIS{1.1}/PURCH{mod1;4}=Diagram,mod1)


Using shortcut keys to work with the Merge Window

Shortcuts for menu options

To		Press		As a shortcut for
Merge the selected data into the target and save the result		ALT + F, S CTRL + S		File→Save
Exit from the Merge Window		ALT + F, X ALT + F4		File→Exit
Show or hide the toolbar		ALT + V,T		View→Toolbar
Navigate to the previous difference in the window		ALT + N, P		Navigate→Previous Difference
Navigate to the next difference in the window		ALT + N, N		Navigate→Next Difference
Navigate to the previous conflict in the window		ALT + N, C		Navigate→Previous Conflict
Navigate to the next conflict in the window		ALT + N, T		Navigate→Next Conflict
Select the source from the difference block currently in focus.		ALT + M, L		Merge→Select Source
Select the target from the difference block currently in focus.		ALT + M, G		Merge→Select Target
Select the common ancestor from the difference block currently in focus.		Alt + M, O		Merge→Select Common Ancestor
Displays the online help documentation		ALT + H, H CTRL + H		Help→Help Topics
Display copyright and version number information about the utility		ALT + H, A		Help→About