Element help

The following links provide details of the various element types that are available for
creating repository objects in Oracle Designer.

Click a name below or select the initial letter of the element type:

A

Action Items

Allowable Values

Application Systems

Argument Passed Values

Arguments

Argument Item Usages

Assumptions

Assumptions to Tables

Attributes

B

Base Table Locations

Bound Items

Business Functions

Business Terminology

Business Unit Uses of Nodes

Business Units

Business Units to Objectives

Business Units to Problems

C

Check Constraints

Cluster Columns

Cluster Definitions

Cluster Implementations

Cluster Indexes

Columns

Communities

Community Databases

Community Members

Configurations

Constraint Usages

Critical Success Factors

Custom Action Items

D

Data Items

Database Files

Database Object Grants

Database Profiles

Database Synonyms

Database Triggers

Database Users

Database User Roles

Databases (Oracle)

Databases (other than Oracle)

Datafiles (Database Files)

Dataflow Attribute Usages

Dataflow Data Item Usages

Dataflows

Datastore Attribute Usages

Datastore Data Item Usages

Datastores

Datastructure Items

Datastructures

Diagram Element Usages

Diagrams

Directories

Distributed Processing

Document Attachments

Documents

Domain Key Constraints

Domains

E

Entities

Entity Business Unit Usages

Event Triggers

Extended Elements

Extended Structure Elements

Externals

F

Files

Folders

Foreign Keys

Function Attribute Usages

Function Business Unit Usages

Function Entity Usages

Functions (Business Functions)

G

Generator Action Items

Global Index Partitions

H

Hash Clusters

I

Implicit Index Storages

Index Clusters

Index Entries

Index Partitions

Index Storages

Indexes

Installations

Items

Item Groups

J

Java Class Definitions

Java Class Implementations

K

Key Based Links

Key Components

Key Performance Controls

Key Performance Indicators

L

Languages

Lists of Values

List of Values Inclusions

Local Index Partitions

Locations

Logfiles (Database Files)

M

Mapping Elements

Materialized View Definitions

Materialized View Implementations

Materialized View Refresh Groups

Module Assumptions

Module Business Unit Usages

Module Change History

Module Component Inclusions

Module Component Links

Module Component Table Usages

Module Components

Module Function Usages

Module Networks

Module Sub-components

Module Weighting Factors

Modules

N

Named Passed Values

Named Preference Set Usages

Navigation Action Items

Network Connections

Nodes

Non-Default User Preferences

Non-Persistent Queues

Non-Persistent Queue Implementations

O

Objectives

Objectives of Business Functions

Objectives to CSFs

Objectives to KPIs

Operating System Files

Oracle Collection Types

Oracle Databases

Oracle Object Types

Oracle User Module Accesses

Other Databases (than Oracle)

P

Partition Key Entries

Passed Values

Persistent Queues

Persistent Queue Implementations

Planning Items

PL/SQL Definitions

PL/SQL Implementations

Preference Sets

Primary Keys

Problems

Problems to Modules

Process Events

Program Data

Public Database Links

Q

Queue Implementations

Queue Subscribers

Queue Table Definitions

Queue Table Implementations

R

Record Files (Operating System Files)

Records

Relation Indexes

Relation View Usages

Relationships

Replication Group Propagations

Replication Groups

Reusable Lists of Values

Reusable Module Components

Roles

Role Module Accesses

Role-to-Role Grants

Rollback Segments

S

Sequence Definitions

Sequence Implementations

Set Member Items

Source Files (Operating System Files)

SQL Query Sets

Storage Definitions

Sub-components

Synonyms

System Objectives of Modules

System Privileges

T

Table Entity Usages

Table Definitions

Table Implementations

Table Partitions

Table Usages

Tablespace Quotas

Tablespaces

Terms (Business Terminology)

Transformation Mapping Elements

Transformation Mapping Sets

Trigger Column Usages

U

Unbound Items

Unique Identifier Entries

Unique Identifiers

Unique Keys

User Defined Sets

User Object Index Storages

V

View Definitions

View Implementations

W

Windows

Workareas


Contents

* # $ KAttributes of entities

* #$KBusiness Functions

* #$KBusiness Terminology

* #$KBusiness Unit Uses of Nodes

* #$KBusiness Units

* #$KBusiness Units to Objectives

* #$KBusiness Units to Problems

* #$KCritical Success Factors

* #$KData Items

* #$KDataflow Contents - Attributes

* #$KDataflow Contents - Data Items

* #$KDataflows

* #$KDatastore Contents - Attributes

* #$KDatastore Contents - Data Items

* #$KDatastores

* #$KEntities

* #$KEntity Business Unit Usages

* #$K Process events

* #$KExternals

* #$KFunction Attribute Usages

* #$KFunction Business Unit Usages

* #$KFunction Entity Usages

* #$KFunctions/Process Events - Triggering/Triggered By

* #$KKey Performance Controls

* #$KKey Performance Indicators

* #$KModule Business Unit Usages

* #$KModule Function Usages

* #$KObjectives of Business Functions

* #$KObjectives to CSFs

* #$KObjectives to KPIs

* #$KSynonyms

* #$KPlanning Items

* #$KRelationships

* #$KTable Entity Usages

* #$KUnique Identifier Entries

* #$KUnique Identifiers


Attributes
Attributes of entities

Defines basic information about the attributes of entities, and records further detailed information about the attributes that is established during the information-gathering exercise in detailed analysis.

Attribute properties

Owning Container

Entity

Name

Version

Sequence in Entity

Domain

Definition

Format

Average Length

Maximum Length

Decimal Places

Optional ?

On Condition

Units

Default

Null Value

Derivation

Volumes

Percent Used - Initial

Percent Used - Average

Authority

Authority

Responsible

Validation

Validation Rules

Documentation

Comment

Description

Notes

Sorting

Sequence in Sort Key

Sort Sequence Order

Related Topics

Entities


Display only
The name of the entity whose attribute details you are recording, displaying or updating.


Mandatory, 40 characters
The name of an attribute for the entity.


The state of the attribute. True means that a null value for the attribute is permissible. False means that a value must be specified for the attribute.


The domain with which you want to associate the named attribute. A domain is a set of properties that apply to a group of attributes. A dropdown list of existing domains is available. A <Null> value indicates that the attribute is not in a domain.

If you edit any of the Format, Maximum Length or Decimal Places properties so that they no longer conform to the values specified in the domain, then the Domain property is reset to null.


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


Optional, 5 digits
The maximum length for this attribute.


Optional, 5 digits
The average length for this attribute, when it contains a value.


Optional, 4 digits
The number of decimal places required.


Optional, 10 characters
The unit of measure for this attribute (e.g., meters, kilograms, pounds, dollars, hours).


Optional, 2000 characters per line
Any comments about the attribute.


Optional, 60 characters
The most common value for this attribute when an instance of this element is created. It is usually used for mandatory attributes only (e.g., TODAY for date order raised).


Optional, 6 digits
The sequence in which this attribute should normally be displayed within the entity.


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


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


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


Optional, 10 characters
The level of authority needed for updating this attribute (e.g., only personnel of sufficient seniority can amend salary details).


Optional, 10 characters
An identifier for the user who effectively "owns" this attribute and who has the responsibility of saying which other users can have access to read or amend this attribute.


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


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


Optional, 2000 characters per line
Rules for validating the values of this attribute.


Optional, 6 digits
The normal sequence of this attribute when sorting the entity.


Indicates whether normal sort sequence of the attribute is ascending or descending


Business Functions

Adds detail to defined functions, and can also be used to add new functions and, in the case of common functions, to identify the master function from which the detail of a copy function is derived.

Details of entity and attribute usage by the function (an essential cross-check for completeness) are recorded. The Function/Attribute Matrix utility can be used to create the function/attribute records. Subsequently, this can be used to amend the necessary attributes. A further use is to record details of function dependencies (i.e., the functions that are triggered by completion of the current function).

Updating, deleting or creating a function can result in changes to the relationships between functions. Therefore, there are limitations on the combinations of operations that can be performed within a single transaction.

Business function properties

Owning Container

Label

Version

Short Definition

Master

Master Function

Parent

Parent Function

Sequence in Parent

Elementary ?

Frequency

Frequency

Frequency Unit

Response Needed

Documentation

Description

Notes

BPR

Function Type

Intention to Automate ? Type

BPR Generate ?

Critical Path ?

CPA Start Date

CPA Finish Date

CPA Relative Start Time

CPA Relative Finish Time

Person Cost Rate

Person Cost Rate Unit

Overhead Cost Rate

Overhead Cost Rate Unit

Total Cost Rate

Total Cost Rate Unit

Additional Cost Rate

Additional Cost Rate Unit

Prior Delay Time

Prior Delay Time Unit

Work Time

Work Time Unit

Quality Check Time

Quality Check Time Unit

Post Delay Time

Post Delay Time Unit

Total Time

Total Time Unit

Measured Time 1

Measured Time 2

Measured Time 3

Measured Time Unit

Quality Percentage

Value Added

Value Chain Analysis

Competitive Index Value

Competitive Index Notes

Resource Required 1

Resource Required 2

Resource Required 3

Resource Required 4

Problem Areas

Simple Rules

Entity Notes

BPR Multimedia

Icon File

Image File

Sound File

Video File

Execution String

BPR Annotation

Note Type

Note Text

Note Picture File

Related Topics

Event Triggers

Function Business Unit Usages

Function Entity Usages

Dataflows


Mandatory, 30 characters
A unique label for the function.


Mandatory, 240 characters
A brief description of this function.


The label of the function to which the current function is common. If a master function is entered, the current or copy function assumes all the detail of the master function and no further detail can be entered.


The function label of the function that is the immediate superior of this function.


Mandatory, 6 digits
The position of the function within the children of the parent function.


Indicates whether or not the function is an elementary function, or the lowest implementable function.

Note:	Elementary functions can be decomposed.


Optional, 6 digits
The frequency with which the function is carried out. The unit of time is entered in the next field.


The unit of time for the frequency field, usually selected from the following list: second, minute, hour, day, week, quarter, year (for these only the initial letter need be entered); month, half-year (enter the full word). The default is DAY.


Indicates whether the implementation of the function should be batch or online (Overnight or Immediate).


The type of function (e.g., Data Entry, Report).


Indicates whether the function is likely to be used when designing a database application based on this data.


Display only
Indicates whether the function is currently on the critical path.


Display only
The start date of the critical path through the process.


Display only
The finish date of the critical path through the process.


Display only
The start time of the critical path through the process.


Display only
The finish time of the critical path through the process.


Optional, 23 digits
The cost rate for the person or persons involved in performing this function.


The unit of measurement for the Person Cost Rate.


Optional, 23 digits
The cost rate of any overheads involved in performing this function.


The unit of measurement for the Overhead Cost Rate.


Optional, 23 digits
The total of Person Cost Rate plus Overhead Cost Rate.


The unit of measurement for the Total Cost Rate.


Optional, 23 digits
The cost rate of additional costs involved in performing this function, besides those for Person and Overhead.


The unit of measurement for the Additional Cost Rate.


Optional, 23 digits
The delay time that occurs before work begins on this function.


The unit of measurement for the Prior Delay Time.


Optional, 23 digits
The time required to do the work for this function.


The unit of measurement for the Work Time.


Optional, 23 digits
The time required for checking the quality of the work for this function.


The unit of measurement for the Quality Check Time.


Optional, 23 digits
The delay time that occurs after the work and quality checking are finished for this function.


The unit of measurement for the Post Delay Time.


Optional, 23 digits
The total duration of this function, calculated from the sum of Prior Delay Time, Work Time, Quality Check Time and Post Delay Time.


The unit of measurement for the Total Time.


Optional, 23 digits
A comparison time for this function, for example, a shortest or longest expected completion time.


Optional, 23 digits
A second comparison time for this function.


Optional, 23 digits
A third comparison time for this function.


The unit of measurement for the Measured Time.


Optional, 3 digits
The quality yield for this function, expressed as a percentage. For example, a value of 90 indicates that this function produces results of acceptable quality in 9 out of 10 cases.


The level of value added by this function: High, Medium, Low or None.


Optional, 2000 characters per line
Double-click on this property to invoke the TextPad.


Optional, 5 digits
An index of how well, in relation to your competitors, you think your business performs the type of task or function that this element represents.


Optional, 2000 characters per line
Double-click on this property to invoke the TextPad.


Optional, 100 characters
A resource required for this function.


Optional, 100 characters
A second resource required for this function.


Optional, 100 characters
A third resource required for this function.


Optional, 100 characters
A fourth resource required for this function.


Optional, 2000 characters per line
Double-click on this property to invoke the TextPad.


Optional, 2000 characters per line
Double-click on this property to invoke the TextPad.


Optional, 2000 characters per line
Double-click on this property to invoke the TextPad.


Optional, 60 characters
The filename of the icon that you want to associate with this function. Icons are visible only if you change the diagram display to icons or if you start animation.


Optional, 60 characters
The filename of an image that you want to associate with this function.


Optional, 60 characters
The filename of the sound that you want to associate with this function.


Optional, 60 characters
The filename of a video that you want to associate with this function.


Optional, 70 characters
A string that associates a program with this function. You can specify any program to which you have access.


The type of note. The options are:

<Null>
Text
Graphic
Text and Graphic


240 characters
The text of the note, if applicable.


240 characters
The name of the picture file in the note, if applicable.


Indicates whether a process step is intended to be an automated (rather than manual) process. This property is for information only, to record the intention in the early stages, before MODULES and MODULE_FUNCTIONS exist. The default is Yes.


Business Terminology

Records definitions of the business terminology or terms that are used in an application system. A comprehensive system glossary can be produced containing these commonly used terms, together with any synonyms and any entities within that application system. The glossary can then be circulated to and agreed by everyone involved in the development project.

The MS Help Generator uses the Business Terminology descriptions to generate a Glossary for the Windows Help file.

Business Terminology properties

Owning Container

Name

Version

Comment

Documentation

Description

Notes

Multi-Byte Generation

Glossary Grouping Character

Related Topics

Synonyms


Display only
The name of the application system that owns the business term.


Mandatory, 40 characters
The name by which the term is most commonly known.


Optional, 240 characters
Any additional comments about the term. These comments are not included in the system glossary.

If you are using MS Help Generator to create Windows Help, use this property to define popup glossary terms. When the reader clicks on the glossary term in the generated Help file, the information you specify here is displayed in a popup window.


Optional, 2 characters
Use this property if you are using MS Help Generator to create Windows Help and the first character of the term you have defined does not form part of the current language 'character-set'.

Enter the character under which this term should be placed on the glossary topic.


Business Unit Uses of Nodes

Records how a node (i.e., the processing capacity and/or the data storage capacity) is used by a business unit.

Business unit uses of nodes properties

Owning Container

Node

Business Unit

Version

Documentation

Comment

Description of Use

Contact

Main Contact Name

Main Contact Phone

Related Topics

Business Units


Display only
The name of the business unit.


Mandatory, 38 characters
The name of the node that is used by the business unit.


Optional, 70 characters
A comment on how the node is used by the business unit.


Optional, 70 characters
A short description of how the node is used at the business unit (e.g., electronic mail, payroll every Monday).


Optional, 30 characters
The person or group to contact for details on how the node is used at the business unit.


Optional, 20 digits
The telephone number of the person described in the Main Contact Name field.


Business Units

Defines the business units of an organization, and also records volumes of entities used at business units and the frequencies of business functions carried out at the business unit.

The Repository treats departments, divisions or other organizational units into which organizations are normally divided as business units.

Business unit properties

Owning Container

Short Name

Version

Name

Parent

Sequence in Parent

Documentation

Comment

Description

Notes

BPR

Primary Location

Primary Contact

Headcount

Role Cost Rate

Role Cost Rate Unit

Role Responsibilities

Role Skill 1

Role Skill 2

Role Skill 3

Role Skill 4

Role ?

BPR Multimedia

Icon File

Image File

Sound File

Video File

Execution String

BPR Annotation

Note Type

Note Text

Note Picture File

Related Topics

Business Functions

Business Units to Objectives

Business Units to Problems


Display only
The name of the application system that owns the business unit.


Mandatory, 10 characters
An abbreviation for the business unit name.


Mandatory, 40 characters
The full name of the business unit. You can use any characters, including spaces, to construct a meaningful name.


Optional, 240 characters
Any notes or comments about the business unit.


The business unit that is the parent of this business unit.


Optional, 6 digits
The position of the business unit in the sequence below the parent.


Optional, 100 characters
The primary geographical location of the business unit.


Optional, 240 characters
The name of the person who is the primary contact for this business unit.


Optional, 10 digits
The number of people in this business unit or, if the business unit represents an individual, the number of people who report to that individual.


Optional, 23 digits
The cost rate for running the business unit, or for the individual performing a role within the business unit.


The unit of measurement for the Role Cost Rate.


Optional, 240 characters
The main duties of the business unit.


Optional, 240 characters
A skill possessed by the business unit as a whole, or by an individual within it.


Optional, 240 characters
A second skill possessed by the business unit as a whole, or by an individual within it.


Optional, 240 characters
A third skill possessed by the business unit as a whole, or by an individual within it.


Optional, 240 characters
A fourth skill possessed by the business unit as a whole, or by an individual within it.


Defines whether role details have been defined for this business unit.


Optional, 60 characters
The filename of the icon that you want to associate with this business unit. Icons are visible only if you change the diagram display to icons or if you start animation.


Optional, 60 characters
The filename of an image that you want to associate with this business unit.


Optional, 60 characters
The filename of the sound that you want to associate with this business unit.


Optional, 60 characters
The filename of a video that you want to associate with this business unit.


Optional, 70 characters
A string that associates a program with this business unit. You can specify any program to which you have access.


The type of BPR annotation (i.e., text, graphic or both).


Optional, 240 characters
Some notes for the BPR annotation.


Optional, 240 characters
Path and name of the graphical annotation.


Business Units to Objectives

Records the association between a business unit and the objective specifically set for that business unit. Typically, this is useful to those performing business planning exercises.

Business unit to objectives properties

Owning Container

Objective

Business Unit

Version

Business unit objective

Comment

Set By

Date Placed

Value

Unit Of Measure

Date Required

Achievement Comment

Related Topics

Business Units


Display only
The name of the business unit.


Display only
The objective of the business unit.


Optional, 70 characters
A comment or brief description of the business unit to objective usage.


Optional, 30 characters
The person or committee responsible for the Business Unit to Objective specification.


Optional, 20 characters
The date on which the objective was placed on the business unit. Enter a specific date, such as 20-NOV-93, or a more general comment about the time, such as End of FY1993.


Optional, 16 characters
The value of the achievement of the objective by the business unit.


Optional, 20 characters
The unit of measure for the amount defined in the Value field.


Optional, 20 characters
The date by which the objective of the business unit should be achieved. Enter a specific date, such as 20-DEC-94, or a more general comment about the time, such as End of FY1994.


Optional, 30 characters
A statement of the progress that has been made or the date on which the objective of the business unit was achieved.


Business Units to Problems

Identifies which of the problems encountered by the enterprise are actually experienced by a specific business unit.

Business units to problems properties

Owning Container

Business Unit

Problem

Version

Date Incurred

Contact

Severity Level

Documentation

Comment

Related Topics

Business Units


Display only
The name of the business unit.


Display only
The problem that the business unit encountered.


Optional, 70 characters
A comment or brief description of this business unit to problem usage.


Optional, 20 characters
The date on which the problem occurred in the context business unit. Enter a specific date, such as 20-NOV-93, or a more general comment, such as End of FY1993.


Optional, 30 characters
The person or committee to be contacted about the problem.


Optional, 4 characters
A relative rating for the severity level of the impact on the business unit by the problem. Text or a numeric scale can be used (e.g., High, Low or 1, 2, 3).


Critical Success Factors

Records the definition of a business event, or state, that furthers the aims and objectives of the organization. These business events are known as success factors.

A special group of success factors are known as "critical success factors". These are business events, or states, whose failure could seriously hinder the achievement of an objective. For example, in the retail trade, pricing strategies and effective stock control are recognized critical success factors.

Critical success factor properties

Owning Container

Name

Version

Critical

Parent

Relative Priority

Set By

Target Value

Unit of Measure

External Dependency

Date Required

Achievement Comment

Documentation

Comment

Description

Notes


Mandatory, 40 characters
A name by which the success factor is usually known.


The critical success factor of which this critical success factor forms a part, if the critical success factor belongs to a hierarchy.


Optional, 70 characters
A comment or description about the success factor.


Mandatory, 2 characters
Indicates whether or not the success factor is critical to the success of the business.


Optional, 30 characters
The person, committee or event responsible for setting the success factor.


Optional, 16 characters
Any appropriate value that has been set as a target for the success factor.


Optional, 20 characters
The unit of measure for the target value.


Optional, 30 characters
Any consideration in achieving the success factor that is not governed by the business (e.g., statutory requirements).


Optional, 20 characters
The date by which the success factor should be achieved. Enter a specific date such as 20-NOV-93 or a more general comment such as End of FY1993.


Optional, 4 characters
A relative ranking or rating for the success factor. Text or a numeric scale can be used (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 success factor was achieved or a statement of the progress that has been made.


Data Items

Records and displays the details of a data item. Data items can be defined for datastores and dataflows.

Data item properties

Owning Container

Name

Version

Definition

Format

Maximum Length

Average Length

Decimal Places

Unit s

Derivation

Authority

Authority

Responsible

Documentation

Comment

Description

Notes

Related Topics

Attributes

Business Functions

Dataflows

Datastores


Display only
The name of the application system that owns this data item.


Mandatory, 40 characters
The name of the data item.


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


Optional, 3 digits
The maximum length for the data item.


Optional, 3 digits
The average length for this data item, when it contains a value.


Optional, 3 digits
The number of decimal places for the length of the data item.


Optional, 10 characters
The unit of measure for this data item (e.g., meters, kilograms, pounds, dollars, hours).


Optional, 10 characters
The level of authority needed to update this data item.


Optional, 10 characters
An identifier for the user who effectively "owns" this data item and has the responsibility for saying which users can have access to read or amend it.


Optional, 240 characters
Any algorithm or expression that describes how the data item is derived.


Optional, 80 characters
Brief notes relating to this data item.


Dataflow Attribute Usages

Displays information about the attributes of the current entity used by the current dataflow.

Dataflow attribute usages properties

Owning Container

Function

Dataflow

Function

Entity

Attribute

Version

Related Topics

Attributes

Dataflows


Display only
Shows the current contents of the dataflow.


Display only
The entity that owns the attribute.


Display only
Shows a list of the attributes for the current entity.


Dataflow Data Item Usages

Displays the items of information that make up the contents of the dataflow. These items can be either the attributes of entities or data items.

Dataflow data item usages properties

Owning Container

Function

Dataflow

Function

Data Item

Version

Related Topics

Dataflows

Data Items


Display only
Shows the current contents of the dataflow.


Display only
Shows a list of the existing data items.


Dataflows

Records and displays information about the flow of data between two separate elements in a business application system.

Dataflow properties

Owning Container

Source

Function

Datastore

External

Dataflow

Name

Classification

Definition

Destination

Function

Version

Datastore

External

Documentation

Description

Notes

BPR

Animate Branch

And/Or Flag

BPR Use in Generation ?

Critical Path ?

CPA Start Date

CPA Finish Date

CPA Relative Start Time

CPA Relative Finish Time

Branch Percentage

Branch Rule

Flow Type

Invisible ?

Significant at Source

Significant at Destination

Person Cost Rate

Person Cost Rate Unit

Overhead Cost Rate

Overhead Cost Rate Unit

Total Cost Rate

Total Cost Rate Unit

Additional Cost Rate

Additional Cost Rate Unit

Prior Delay Time

Prior Delay Time Unit

Work Time

Work Time Unit

Quality Check Time

Quality Check Time Unit

Post Delay Time

Post Delay Time Unit

Total Time

Total Time Unit

Measured Time 1

Measured Time 2

Measured Time 3

Measured Time Unit

Frequency

Frequency Unit

Quality Percentage

Value Added

Value Chain Analysis

Resource Required 1

Resource Required 2

Resource Required 3

Resource Required 4

Problem Areas

Simple Rules

BPR Multimedia

Icon File

Image File

Sound File

Video File

Execution String

BPR Annotation

Note Type

Note Text

Note Picture File

Related Topics

Business Functions

Datastores

Externals


Mandatory, 40 characters
The name of the dataflow. You can change the name here.


The name of the function that is the source of the dataflow.


The name of the datastore that is the source of the dataflow.


The name of the external that is the source of the dataflow.


The name of the function that is the destination of the dataflow.


The name of the datastore that is the destination of the dataflow.


The name of the external that is the destination of the dataflow.


Optional, 20 characters
The classification for the dataflow. Dataflows are sometimes classified as REPORT, SCREEN, LETTER, etc. But you can enter your own, if required.


Indicates whether the dataflow is activated during animation by the Process Modeler.


Indicates the type of logic (AND or OR) used where the destination function is also the destination of other dataflows.

A value of OR specifies that the destination function is activated as soon as either this dataflow or another dataflow is completed.

A value of AND specifies that the destination is activated only when all the dataflows with a value of AND are completed.


Indicates whether the function is likely to be used when designing a database application based on this data.


Display only
Indicates whether the function is currently on the critical path.


Display only
The start date of the critical path for the dataflow.


Display only
The finish date of the critical path for the dataflow.


Display only
The start time of the critical path for the dataflow.


Display only
The finish time of the critical path for the dataflow.


Optional, 3 digits
The number of times, as a percentage of the total, that the business process allows the branch represented by this dataflow as opposed to an alternative branch.


Optional, 240 characters
The rule according to which the business process follows the branch represented by this dataflow as opposed to an alternative branch. For example, a value of COST<5000 might indicate a branch that is followed if the cost of performing the source function is less than $5000.


The dataflow type, in Process Modeler terms:

Data
Material
Temporal
Unclassified


Indicates that an invisible flag has been set for the dataflow.


Indicates that the dataflow is more significant at its source than one that is not so marked.


Indicates that the dataflow is more significant at its destination than one that is not so marked.


Optional, 23 digits
The cost rate for the person or persons involved in using this dataflow.


The unit of measurement for the Person Cost Rate.


Optional, 23 digits
The cost rate of any overheads involved in using this dataflow.


The unit of measurement for the Overhead Cost Rate.


Optional, 23 digits
The total of Person Cost Rate plus the Overhead Cost Rate.


The unit of measurement for the Total Cost Rate.


Optional, 23 digits
The cost rate of additional costs involved in using this dataflow, besides those for Person and Overhead.


The unit of measurement for the Additional Cost Rate.


Optional, 23 digits
The delay time that occurs before work begins on this dataflow.


The unit of measurement for the Prior Delay Time.


Optional, 23 digits
The time taken to do the work for this dataflow.


The unit of measurement for the Work Time.


Optional, 23 digits
The time taken in checking the quality of the work for this dataflow.


The unit of measurement for the Quality Check Time.


Optional, 23 digits
The delay time that occurs after the work and quality checking are finished for this dataflow.


The unit of measurement for the Post Delay Time.


Optional, 23 digits
The total duration of this dataflow, calculated from the sum of Prior Delay Time, Work Time, Quality Check Time and Post Delay Time.


The unit of measurement for the Total Time.


Optional, 23 digits
A comparison time for this dataflow, for example, a shortest or longest expected completion time.


Optional, 23 digits
A second comparison time for this dataflow.


Optional, 23 digits
A third comparison time for this dataflow.


The unit of measurement for the Measured Time.


Optional, 10 digits
The frequency of this dataflow.


The unit for the frequency property.


Optional, 3 digits
The quality yield for this dataflow, expressed as a percentage. For example, a value of 90 indicates that this function produces results of acceptable quality in 9 out or 10 cases.


The level of value added by this dataflow: High, Medium, Low or None.


Optional, 2000 characters per line
Double-click on this property to invoke the TextPad.


Optional, 100 characters
A resource required for the dataflow.


Optional, 100 characters
A second resource required for the dataflow.


Optional, 100 characters
A third resource required for the dataflow.


Optional, 100 characters
A fourth resource required for the dataflow.


Optional, 2000 characters per line
Double-click on this property to invoke the TextPad.


Optional, 2000 characters per line
Double-click on this property to invoke the TextPad.


Optional, 60 characters
The filename of the icon that you want to associate with this dataflow. Icons are visible only if you change the diagram display to icons or if you start animation.


Optional, 60 characters
The filename of an image that you want to associate with this dataflow.


Optional, 60 characters
The filename of the sound that you want to associate with this dataflow.


Optional, 60 characters
The filename of a video that you want to associate with this dataflow.


Optional, 70 characters
A string that associates a program with this dataflow. You can specify any program to which you have access.


The type of note. The options are:

<Null>
Text
Graphic
Text and Graphic


240 characters
The text of the note, if applicable.


240 characters
The name of the picture file in the note, if applicable.


Optional, 70 characters
The description of this dataflow.


Datastore Attribute Usages

Records the attribute contents of the datastore.

Datastore attribute usages properties

Owning Container

Datastore

Entity

Attribute

Version

Related Topics

Attributes

Datastores


Display only
Shows the current contents of the datastore.


Display only
The entity that owns the attribute.


Display only
The attribute that is in the datastore..


Datastore Data Item Usages

Displays the data items that make up the contents of the datastore.

Datastore data item usages properties

Owning Container

Datastore

Data Item

Version

Related Topics

Data Items

Datastores


Display only
Shows the current contents of the datastore.


Display only
Shows a list of the existing data items.


Datastores

Records in the Repository details of temporary or permanent storage concepts for logical data items /attributes, as used by specified business functions/processes.

Datastore properties

Owning Container

Id

Version

Name

Type

Documentation

Comment

Description

Notes

BPR

Business Unit

Function

Store Type

BPR Use in Generation Flag

Critical Path Flag

CPA Start Date

CPA Finish Date

CPA Relative Finish Time

Person Cost Rate

Person Cost Rate Unit

Overhead Cost Rate

Overhead Cost Rate Unit

Total Cost Rate

Total Cost Rate Unit

Additional Cost Rate

Additional Cost Rate Unit

Prior Delay Time

Prior Delay Time Unit

Work Time

Work Time Unit

Quality Check Time

Quality Check Time Unit

Post Delay Time

Post Delay Time Unit

Total Time

Total Time Unit

Measured Time 1

Measured Time 2

Measured Time 3

Measured Time Unit

Frequency

Frequency Unit

Minimum Volume

Average Volume

Maximum Volume

Quality Percentage

Value Added

Value Chain Analysis

Resource Required 1

Resource Required 2

Resource Required 3

Resource Required 4

Problem Areas

Simple Rules

BPR Multimedia

Icon File

Image File

Sound File

Video File

Execution String

BPR Annotation

Note Type

Note Text

Note Picture File

Related Topics

Dataflows

Datastore Contents - Attributes

Datastore Contents - Data Items


Display only
The name of the application system that owns this datastore.


Mandatory, 10 characters
A short reference name to identify the datastore. This name must be unique within the application system version.


Mandatory, 40 characters
A name for the datastore. This name must be unique within the application system version.


The datastore type: <Null>, Computer, Manual or Transient.


Optional, 70 characters
A brief comment about the datastore.


The name of the business unit that is responsible for the datastore in the current application system.


The name and short name of the root function that is responsible for the datastore in the current application system.


The store type, in Process Modeler terms:

Data
Material
Unclassified


Indicates whether the datastore is likely to be used when designing a database application based on this data.


Display only
Indicates whether the datastore is currently on the critical path.


Display only
The start date of the critical path for this datastore.


Display only
The finish data of the critical path for this datastore.


Display only
The start time of the critical path for this datastore.


Display only
The finish time of the critical path for this datastore.


Optional, 23 digits
The cost rate for the person or persons involved in using this datastore.


The unit of measurement for the Person Cost Rate.


Optional, 23 digits
The cost rate of any overheads involved in using this datastore.


The unit of measurement for the Overhead Cost Rate.


Optional, 23 digits
The total of Person Cost Rate plus Overhead Cost Rate.


The unit of measurement for the Total Cost Rate.


Optional, 23 digits
The cost rate of additional costs involved in using this datastore, besides those for Person and Overhead.


The unit of measurement for the Additional Cost Rate.


Optional, 23 digits
The delay time that occurs before work begins on this datastore.


The unit of measurement for the Prior Delay Time.


Optional, 23 digits
The time taken to do the work for this datastore.


The unit of measurement for the Work Time.


Optional, 23 digits
The time taken in checking the quality of the work for this datastore.


The unit of measurement for the Quality Check Time.


Optional, 23 digits
The delay time that occurs after the work and quality checking are finished for this datastore.


The unit of measurement for the Post Delay Time.


Optional, 23 digits
The total duration of this datastore, calculated from the sum of Prior Delay Time, Work Time, Quality Check Time and Post Delay Time.


The unit of measurement for the Total Time.


Optional, 23 digits
A comparison time for this datastore, for example, a shortest or longest expected completion time.


Optional, 23 digits
A second comparison time for this datastore.


Optional, 23 digits
A third comparison time for this datastore.


The unit of measurement for the Measured Time.


Optional, 10 digits
The frequency with which the function is carried out. The unit of time is entered in the next field.


The unit of time for the Frequency. The unit is usually selected from the following list: second, minute, hour, day, week, quarter, year (for these only the initial letter need be entered); month, half-year (enter the full word). The default is DAY.


Optional, 9 digits
The minimum quantity for the contents of the datastore.


Optional, 9 digits
The average quantity for the contents of the datastore.


Optional, 9 digits
The maximum quantity for the contents of the datastore.


Optional, 3 digits
The quality yield for this datastore, expressed as a percentage. For example, a value of 90 indicates that this datastore produces results of acceptable quality in 9 out or 10 cases.


The level of value added by this datastore: High, Medium, Low or None.


Optional, 2000 characters per line
Double-click on this property to use the TextPad


Optional, 100 characters
A resource required for this datastore.


Optional, 100 characters
A second resource required for this datastore.


Optional, 100 characters
A third resource required for this datastore.


Optional, 100 characters
A fourth resource required for this datastore.


Optional, 70 characters per line
Double-click on this property to use the TextPad


Optional, 70 characters per line
Double-click on this property to use the TextPad


Optional, 60 characters
The filename of the icon that you want to associate with this datastore. Icons are visible only if you change the diagram display to icons or if you start animation.


Optional, 60 characters
The filename of an image that you want to associate with this datastore.


Optional, 60 characters
The filename of the sound that you want to associate with this datastore.


Optional, 60 characters
The filename of a video that you want to associate with this datastore.


Optional, 70 characters
A string that associates a program with this datastore. You can specify any program to which you have access.


The type of note. The options are:

<Null>
Text
Graphic
Text and Graphic


240 characters
The text of the note, if applicable.


240 characters
The name of the picture file in the note, if applicable.


Entities

Defines the entity information that is established while constructing the entity model for the business.

Entity properties

Owning Container

Name

Version

Short Name

Plural

Type Of

Volumes

Initial

Average

Maximum

Annual Growth Rate (%)

Data warehouse

Data warehouse Type

Documentation

Description

Notes

Related Topics

Attributes

Business Units

Business Functions

Entities Business Unit Usages

Process events

Externals

Function Entity Usages

Relationships

Synonyms

Table Entity Usages

Unique Identifier Entries


Display only
The name of the application system that owns this entity.


Mandatory, 40 characters
The full name of the entity; that is, the name that appears in the box on the entity relationship diagram.

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


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

Note:	You can enter up to 10 characters in this field but it is strongly recommended that you enter no more than 7.


Mandatory, 40 characters
This field is generated by the system when the entity is created. If the wording is not acceptable, type over the entry to insert your own plural. If the entity name is edited this name is not automatically updated to reflect the new name.


The immediate super-type entity. If the entity defined is a sub-type (i.e., it is enclosed within another entity box on your entity relationship diagram), the super-type entity is the enclosing entity box. This super-type must already exist within the repository.


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


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


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


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


Classifies the entity as a fact or a dimension. Applicable in data warehouse applications only.


Entities Business Unit Usages
Entity Business Unit Usages

Displays details of entities that are at a business unit.

Entity business unit usage properties

Owning Container

Business Unit

Entity

Version

Volumes

Initial

Average

Maximum

Annual Growth

Related Topics

Business Units

Entities


Display only
The name of the business unit.


Display only
The name of the entity that is at the business unit.


Optional, 7 digits
The initial number of occurrences of the entity at the business unit.


Optional, 7 digits
The average number of occurrences of the entity at the business unit.


Optional, 7 digits
The maximum number of occurrences of the entity at the business unit.


Optional, 3 digits
The expected annual growth rate (percentage) for the entity at the business unit.


Process events

Defines the events that occur in the business area being studied. There are three main types of process events: Time, Change and System. Such events can act as a trigger to a number of business functions. The functions that an event triggers and the functions that trigger the event can be stated here.

Process event properties

Owning Container

Name

Version

Type

On Condition

Time

Date

Time

Frequency

Frequency Unit

Change

Entity

Attribute

Documentation

System Description

Description

Notes

BPR Multimedia

Icon File

Image File

Sound File

Video File

Execution String

Related Topics

Event Triggers


Display only
The name of the application system that owns this process event.


Mandatory, 40 characters
The name of the process event. The name should be kept short.


Specifies the type of process event.

Time	When, under specified conditions, real time reaches a pre-determined date or time.

System	The completion of one or more business functions that triggers the start of one or more other business functions.

Change	When, under specified conditions, data is created or changed in such a manner as to act as a trigger for one or more business functions. It may be the creation or deletion of an entity occurrence or a change in the value of an attribute.

Other	If the above categories of process event are not applicable in your development environment, you may classify the process event as Other.


Optional, 40 characters
Any additional conditions that apply to the occurrence of the process event; for example, "last Thursday in the month" for Time events that have a frequency of "1 per month". You should complete the next four fields only if the event is of type Time.


Optional, DATE
The date at which the process event occurs, if known.


Optional, 10 characters
The time at which the process event occurs, if known.

The time format is HH.MM (where HH represents the hours and MM represents the minutes). For example, 14.34


Optional, 6 digits
For a recurring process event, the frequency with which it occurs.


The units of measurement for the Frequency.


The name of the entity whose change causes the process event.


The name of the attribute whose change causes the process event.


Optional, 60 characters
The filename of the icon that you want to associate with this process event. Icons are visible only if you change the diagram display to icons or if you start animation.


Optional, 60 characters
The filename of an image that you want to associate with this process event.


Optional, 60 characters
The filename of the sound that you want to associate with this process event.


Optional, 60 characters
The filename of a video that you want to associate with this process event.


Optional, 70 characters
A string that associates a program with this process event. You can specify any program to which you have access.


Optional, 40 characters.
A short description of a SYSTEM event.


Externals

Records and displays information about externals. Externals act as a source or recipient of dataflows into or out of a hierarchy on a dataflow diagram.

External properties

Owning Container

Name

Version

Short Name

Business Unit

Entity

Documentation

Comment

Description

Notes

Related Topics

Business Units

Dataflows

Entities


Display only
The name of the application system that owns this external.


Mandatory, 40 characters
The full name of the external. This name is defined when the external is created.


Optional, 20 characters
An abbreviation for the name of the external. If a short name is not defined when the external is created, the system generates one.

Note:	You can enter up to 20 characters in this field but it is advisable to keep the name as short as possible. A maximum of 7 characters is recommended.


The business unit, if applicable, on which the external is based.


The entity, if applicable, on which the external is based.


Optional, 70 characters
A description of the external and any notes or comments about it.


Function Attribute Usages

Displays information about the attributes of the current entity that are used by the current function. The Application Design Transformer makes use of this element type when it defines detailed module column usages for a module.

Function attribute usage properties

Owning Container

Function

Entity

Attribute

Version

Operations

Insert ?

Retrieve ?

Update ?

Nullify ?

Archive ?

Other ?

Documentation

Comment

Related Topics

Attributes

Business Functions

Entities


Display only
The unique label for the function triggered by the function that is displayed at the top of this window. The function must already exist within the application system.


Display only
The name of the entity that is used by the function.


Display only
The name of an existing attribute of the entity that is used by the function.


Indicates whether the values of this attribute are inserted by the function.


Indicates whether the values of this attribute are retrieved by the function.


Indicates whether the values of this attribute are updated by the function.


Indicates whether the values of this attribute are set to NULL by the function.


Indicates whether the values of this attribute are archived by the function.


Indicates whether this attribute is subject to a user-defined usage by the function.


Optional, 240 characters
A comment about the way in which the attribute is used by the function, if required.


Function Business Unit Usages

Displays details of business functions that are carried out at the business unit. The Application Design Transformer makes use of this element type when it defines a menu structure from a function hierarchy.

Function business unit usage properties

Owning Container

Function

Business Unit

Version

Frequency

Frequency

Frequency Unit

Response Required

BPR

Single BPR Business Unit

Related Topics

Business Functions

Business Units


Display only
The name of the business function.


Display only
The name of the business unit at which the business function is carried out.


Optional, 10 digits
The number of times that the function is carried out at the business unit.


The unit of measure for frequency at business units, e.g. DAY.


The business function response required; that is, whether the implementation of the function should be batch or online (Overnight or Immediate).


Display only
Identifies the single business unit that is responsible for a function.


Function Entity Usages

Displays information about the entities that are used by a business function, and the method in which they are used. The Application Design Transformer can make use of the element type to define a detailed module table usage for a module.

Function entity usage properties

Owning Container

Function

Entity

Version

Operations

Create ?

Retrieve ?

Update ?

Delete ?

Archive ?

Other ?

Documentation

Comment

Related Topics

Business Functions

Entities


Display only
The unique label for the function that is triggered by the context function. The function must already exist within the application system.


Display only
The name of an existing entity or its synonym within the application system.


True if this entity is created by the function; blank if not.


True if this entity is retrieved by the function; blank if not.


True if this entity is updated by the function; blank if not.


True if this entity is deleted by the function; blank if not.


True if this entity is archived by the function; blank if not.


True if a user-defined action is performed by the function, blank if not.


Optional, 240 characters
A comment about the way in which the entity is used by the function, if required.


Event Triggers

Specifies a business function or event that triggers the current business function or event.

Event triggers properties

Owning Container

Triggering

Function / Event

Triggered By

Function / Event

Version

BPR

Primary Event ?

Related Topics

Business Functions

Process events


Display only
The label for a function that is triggered by the event.


Display only
The name of the event that is triggered by the function.


Display only
The label for the function that triggers the event.


Display only
The name of the event that triggers the function.


Optional
If more than one event exists in a function, this is the event that has the Primary Event Flag set to True.


Key Performance Controls

Defines those business functions that are associated with key performance indicators. Those business functions that set the values for a key performance indicator, report on their status and/or monitor their trends are also recorded.

A key performance indicator can be monitored by several functions, in combinations, reflecting different processing periods or sources of information.

Key performance control properties

Owning Container

Key Performance Indicator

Function

Version

Frequency

Frequency

Per

Control

Monitor Of

Report On

Set By

Derivation Expression

Documentation

Comment


Display only
The name of the key performance indicator.


Display only
The label of the function that is associated with the key performance indicator.


Optional, 70 characters
A comment or brief description of this instance of the association.


Optional, 10 characters
The number of times that the function accesses the key performance indicator within a given period of time.


Optional, 20 characters
The unit of measure for the Frequency (e.g., week, month, year).


Optional, 2 characters
Indicates whether or not (Y or N) the function monitors the values and trends of the key performance indicator.


Optional, 2 characters
Indicates whether or not (Y or N) the function reports on the value or values of the key performance indicator.


Optional, 2 characters
Indicates whether or not (Y or N) the function sets the target value of the key performance indicator.


Optional, 70 characters
An expression describing how the function derives the key performance indicator.


Key Performance Indicators

Defines indicators that can be used to quantify or monitor the progress that is made toward achieving a set of business objectives.

Other object types that are related to the element type Key Performance Indicator are shown on the Business Planning Model found in the meta-model.

Key performance indicator properties

Owning Container

Name

Version

Parent KPI

Responsibility

Measured By

Set By

Target Value

Unit of Measure

Documentation

Comment

Description

Notes

Related Topics

Business Functions

Key Performance Indicators


Mandatory, 40 characters
The name by which the key performance indicator is usually known.


Parent, if this key performance indicator belongs to a hierarchy.


Optional, 70 characters
A comment or brief description of the key performance indicator.


Optional, 30 characters
The person, committee or event that is responsible for the maintenance of the key performance indicator.


Optional, 70 characters
The information or facts that are measured to show the progress made toward achieving the business objectives.


Optional, 30 characters
The group or event that is responsible for setting the key performance indicator.


Optional, 16 characters
A value that has been set as the target for the key performance indicator.


Optional, 20 characters
The unit of measure for the target value.


Module Business Unit Usages

Records an association between a business units and the module. The Application Design Transformer makes use of this information when generating a menu network from the business function hierarchy.

Module business unit usage properties

Owning Container

Module / PLSQL / Java Def

Business Unit

Version

Documentation

Comment

Related Topics

Business Units


Display only
The short name of the module implementing the business unit.


Display only
The abbreviation, or short name, of the business unit being implemented by this module.


Optional, 70 characters
A design comment about the module implementation of the business unit.


Module Function Usages

References the business function or business functions that are implemented by the module. These associations are generated by the Application Design Transformer.

Module function usage properties

Owning Container

Module / PLSQL / Java Def

Function

Version

Documentation

Comment

Related Topics

Business Functions


Display only
The short name of the module.


Display only
The function label of the business function being implemented by this module.


Optional, 70 characters
A design comment about the implementation of this function module.


Objectives of Business Functions

Records the association between an objective and the business functions that contribute to the achievement of the objective.

Objectives of business function properties

Owning Container

Objective

Function

Version

Function Contribution

Type

Placed By

Date Placed

Value

Unit Of Measure

Date Required

Achievement Comment

Documentation

Comment

Related Topics

Business Functions


Display only
The name of the objective.


Display only
The label of the business function.


Optional, 70 characters
A comment or brief description of this association type.


Mandatory, 20 characters
The type of contribution made to the objective by the business function (e.g., critical, major, long term).


Optional, 30 characters
The person or committee that is responsible for defining the objective of the business function; an agreed contributor toward the objective specification.


Optional, 16 characters
The value of the contribution made by the business function to the objective.


Optional, 20 characters
The unit of measure for Value.


Optional, 20 characters
The date by which the contribution of the business function should be achieved. Enter a specific date such as '20-NOV-91', or a more general comment about the time, such as 'End of FY1992'.


Optional, 70 characters
The date on which the contribution of the business function was achieved, or a statement of the progress that has been made.


Optional, 20 characters
The date on which the business function was agreed to contribute towards the objective.


Objectives to CSFs

Records an association between an objective of a business and one of the critical success factors that measure the success of the business.

Objectives to CSF properties

Owning Container

Objective

Critical Success Factor

Version

CSF Contribution

Reason

Contribution

Value

Unit Of Measure

Documentation

Comment

Related Topics

Critical Success Factors


 Display only
The name of the objective.


Display only
The name of the critical success factor.


Optional, 70 characters
A comment or brief description of the success factor contributor.


Optional, 70 characters
The reason why the specified success factor contributes to the achievement of the specified objective.


Optional, 70 characters
A comment about the contribution made by the success factor.


 Optional, 16 characters
The value of the contribution made by the success factor.


 Optional, 20 characters
The unit of measure for Value.


Objectives to KPIs

Records the association between an objective and the key performance indicators that are used to measure the performance of a business toward the achievement of that objective.

Objectives to KPI properties

Owning Container

Objective

Key Performance Indicator

Version

Documentation

Reason

Comment

Related Topics

Key Performance Indicators


Display only
The name of the objective.


Display only
The name of the key performance indicator.


Optional, 70 characters
The reason why this key performance indicator is used to measure the specified objective.


Optional, 70 characters
A comment or brief description of this instance of the objective measure.


Synonyms for entities

The synonyms of an entity are simply aliases for that entity and are not used by the Server Generator.

Synonym properties

Owning Container

Entity

Version

Term

Name

Documentation

Description

Notes

Related Topics

Business Terminology

Entities


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


Display only
The name of the entity that uses this synonym.


Display only
The name of the business terminology element that uses this synonym.


Planning Items

Records the planning data specific to a business unit at a given location.

For example, if a business unit operates at more than one site, the budgets may be apportioned between the sites. Similarly, if more than one business unit resides at the same location, each business unit may be responsible for a proportion of the costs.

Planning item properties

Owning Container

Location

Business Unit

Version

Date Effective

Set By

Headcount

Headcount

Headcount Unit

Budget

Budget

Budget Unit

Documentation

Comment

Related Topics

Business Units


Display only
The location of the business unit.


Display only
The name of the business unit.


Optional, 70 characters
A comment or description of the planning item.


Optional, 30 characters
The person or committee that is responsible for defining the planning item.


Optional, 20 characters
The headcount for this business unit at this location.


Optional, 20 characters
The unit of measure for the headcount (e.g., the number of people or cost per person in this business unit).


Optional, 16 characters
The budget for this business unit at this location.


Optional, 20 characters
The unit of measure for the budget.


Optional, 20 characters
The date on which the planning data is to come into effect.


Relationships

Defines the relationships between entities.

When you have recorded the entity and relationship definitions for the business area, you can also define the arc in which a relationship end is included.

Relationship properties

Owning Container

From/To

Entity

Relationship Name

Version

Definition

Minimum Cardinality

Maximum Cardinality

In Arc

Transferable ?

Volumes

Average

Minimum

Maximum

Documentation

Description

Notes

Related Topics

Entities


Display only
The name of the application system that owns this relationship.


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


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


Mandatory, 10 digits
The minimum number of entities possible at the other end of the relationship for each entity at this end. This tells you both the degree at that end of the relationship and the optionality at this end. A zero indicates that a relationship is optional.

Min Cardinality: 0: for example, "Each PRICE LIST ITEM may be on a PRICE LIST"

Min Cardinality: 1: for example, "Each PRICE LIST ITEM must be on at least one PRICE LIST"


Optional, 10 digits
The maximum number of entities possible at the other end of the relationship for each entity at this end. Null indicates an infinite number.

Max Cardinality: 1: for example, "Each PRICE LIST must be comprised of just one PRICE LIST ITEM"

Max Cardinality : null: for example, "Each PRICE LIST must be comprised of an infinite number of PRICE LIST ITEMS"


Optional, 6 digits
Indicates whether or not this end of the relationship is included in an arc. Arcs on entity relationship diagrams are drawn across two or more relationships from the same entity. These relationships are mutually exclusive and are identified by numbers. If this end of the relationship is included in an arc, the numeric identifier is entered here.


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


Optional, 9 digits
The average number of occurrences of this entity that are involved in the relationship.


Optional, 9 digits
The minimum number of occurrences of this entity that are involved in the relationship.


Optional, 9 digits
The maximum number of occurrences of this entity that are involved in the relationship.


Table Entity Usages

The table that is used to store instances of an entity.

Table entity usage properties

Owning Container

Table

Entity

Version

Mapping Type

Discriminator

Discriminator Column

Discriminator Value

Documentation

Comment

Related Topics

Entities


Display only
The name of the entity.


Display only
The name of the table to which the entity is mapped.


The name of the column that discriminates between instances of different entities implemented by the same table.


Determines how the Database Design Transformer handles entity supertypes and their subtypes when creating a database design.

Option	Description
<Null>	The entity subtype is mapped to the same table as its supertype in a single table mapping.
Augment	The entity subtype is mapped to a different table from its supertype as an arc mapping.
Override	The entity subtype is mapped to a different table from its supertype as a separate table mapping.


Optional, 10 characters
A value for the discriminator column.


Optional, 240 characters
Any comments on the design decision made of the mappings between an entity and a table.


Unique Identifiers
Unique Identifier Entries

Defines the attributes and relationships that uniquely identify the entity. The name of the unique identifier is generated from the entity short name. The attributes and relationships that are used in this element must already exist for the entity.

Note:	Each entry or record must contain an attribute or a relationship, but they cannot contain both.

Unique identifier entry properties

Owning Container

Entity

Unique Identifier

Attribute / Relationship

Version

Sequence in UID

Related Topics

Attributes

Entities

Relationships


Display only
Identifies the unique identifier for which unique identifier entries are defined.


Display only
The name of the attribute on which the unique identifier entry is based.


The name of the relationship on which the unique identifier entry is based.


Mandatory, 6 digits
The sequence of the attribute or relationship within the unique identifier


Unique Identifiers

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

Unique identifier entry properties

Owning Container

Entity

Name

Version

Primary UID

Documentation

Description

Notes

Related Topics

Attributes

Entities

Relationships


Display only
The name of the entity for which a unique identifier is being defined.


Mandatory, 30 characters
The name of the unique identifier.


Identifies whether the unique identifier is the primary identifier for the entity.


* # $ 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).


Assumptions

About assumptions

Records and monitors any assumptions that are made about a system; specifically those that may impact the design and implementation of tables.

Use the Repository Object Navigator to create assumptions.

Assumption definition properties

Owning Folder

Name

Version Label

Type

Made By

Ranking

Stability

Risk

Documentation

Comment

Description

Notes

Related Topics

Assumptions to Tables

Tables


Mandatory, 40 characters
A unique name for the assumption.


Optional, 70 characters
A comment or brief description about the assumption.


Mandatory, 20 characters
The type of assumption that is being defined (e.g., Business, System).


Optional, 30 characters
The person, committee or event responsible for the specification of the assumption.


Optional, 4 characters
A relative priority or rating for the assumption. Text or a numeric scale can be used (e.g., LOW, AVE, HIGH or 1 - 100 where 1 is low and 100 is high).


Optional, 4 characters
The level of confidence in the assumption (e.g., percentage).


Optional, 4 characters
The criticality of the assumption (e.g., the impact on a business or system made by a false assumption).


Assumptions to Tables

About assumptions to tables

Records the associations between an assumption and the table definitions it influences.

Note:	You must use the Repository Object Navigator to create assumptions to tables.

Assumptions to Tables definition properties

Application Owner

Table

Name

Type

Made By

Ranking

Stability

Risk

Documentation

Comment

Description

Notes

Related Topics

Assumptions

Tables


Display only
The name of the assumption affecting the table.


Display only
The name of the table influenced by the assumption.


Optional, 70 characters
A comment on the association between the table and the assumption.


Module Assumptions

About module assumptions

Records an assumption that impacts the required development or design of modules. For example, a transaction rate will be achieved by a module, assuming that the appropriate hardware is acquired. This Repository definition is recorded for documentation purposes only, i.e., none of its properties are used by the Oracle Designer generator products.

Use the Repository Object Navigator to record module assumptions in the Repository.

Module assumption definition properties

Assumption

Module / PLSQL / Java

Name

Type

Made By

Ranking

Stability

Risk

Documentation

Comment

Description

Notes

Related Topics

Assumptions

Modules


Display only
The name of the assumption. This property is for documentation purposes only, and is not used by the generator products.


Display only
The name of the module or PL/SQL definition affected by the assumption. This property is for documentation purposes only, and is not used by the generator products.


Optional, 70 characters
A comment or brief description about this assumption. This property is for documentation purposes only, and is not used by the generator products.


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 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.


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.

0	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

0	Constraint

1	Constraint Type

2	Version

3	Column

4	Sequence in key

5	Conversion Format Mask

Join Columns/Attributes (For foreign keys only)

Join Column

0	Second Join Column

Documentation

Comment

0	Description

1	Notes

Related Topics

Columns

0	Foreign Key Constraints

1	Primary Key Constraints

2	Tables

3	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

0	Oracle Database

1	Storage Definition (Index)

2	Tablespace (Index)

3	Name

Storage

Storage Definition

0	Tablespace

1	Chunk

2	Chunk Unit

3	Init Trans (Index)

4	Max Trans (Index)

5	Cache ?

6	Logging ?

7	Percent Version

Documentation

Description

0	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.

0	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

0	Index/Primary Key

1	Name

2	Table_Partition

3	Version

Storage

Tablespace

0	Storage Definition

1	Init Trans

2	Max Trans

3	Percent Free

Related Topics

Storage Definitions

0	Table Partitions

1	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

0	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.

0	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.

1	Materialized views can be created in the context of a Server Model Diagram, and are represented by a blue rectangle as shown below.

2

3	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.

4	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.

5	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.

0	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

0	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.

0	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.

1	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.

2	In the following illustration, a materialized view has been taken of a base table that resides on a remote database.

3

4	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

0	Database

1	Database User

2	Materialized view

3	Version

4	Complete ?

Scope

Global Synonym Name

0	Scope

Storage

Tablespace

0	Storage Definition

1	Init Trans

2	Max Trans

3	Percent Free

4	Percent Used

5	Cached

Refresh

Refresh Start Time

0	Refresh Type

1	Next Refresh Clause

2	Materialized view Group

3	Build Type

Optimization

Query Rewrite ?

Documentation

Implementation Description

0	Implementation Notes

1	Non-Oracle Storage

Related Topics

Databases

0	Database Users

1	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

0	Name

1	Version

2	Multiple Consumers ?

Documentation

Comment

0	Description

1	Notes

2	User Help Text

Related Topics

Non-Persistent Queue Implementations

0	Queue Subscribers

1	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

0	Database

1	Non Persistent Queue

2	Complete?

Documentation

Implementation Description

0	Implementation Notes

Related Topics

Non-Persistent Queues

0	Queue Subscribers

1	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

0	Name

1	Version

2	Local Name

3	Non-Oracle Database Type

4	Complete ?

5	Node

Connection

TNS Alias

0	Connect String

Documentation

Comment

0	Description

1	Notes

Related Topics

Database User Roles

0	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.

0	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.

1	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

0	Name

1	Version

2	Collection Type

3	VARRAY Limit

4	Collection of

Scalar Collection

Scalar Datatype

0	Scalar Maximum Length

1	Scalar Decimal Places

Object Collection

Object Datatype

0	REF ?

Documentation

Comment

0	Description

1	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

0	Name

1	Version

2	Local Name

3	Oracle Version

4	Character Set

5	Complete ?

6	Node

Connection

TNS Alias

0	Connect String

Instances

Shared ?

0	Max Instances

Datafiles

Reuse Control File

0	Max Data Files

Logfiles

Archive Redo Files

0	Max Log files

1	Max Log History

2	Max Log Members

Documentation

Comment

0	Description

1	Notes

Related Topics

Database User Roles

0	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

0	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

0	Name

1	Version

Documentation

Comment

0	Description

1	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.

0	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

0	Owning Container

1	*Index

2	Table

3	Column

4	Version

5	Sequence_in Key

6	*For indexes only

Related Topics

Index Storages

0	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

0	Name

1	Version

2	Queue Table

3	Queue Type

4	Auto Commit ?

5	Max Retries

6	Retry Delay

7	Retention Time

8	Unlimited Retention Time ?

Documentation

Comment

0	Description

1	Notes

2	User Help Text

Related Topics

Persistent Queues

0	Queue Tables

1	Queue Subscribers

2	Non-Persistent Queues

3	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

0	Database

1	Persistent Queue

2	Complete?

3	Queue Table Database User

4	Max Retries

5	Retry Delay

6	Retention Time

7	Unlimited Retention Time ?

Documentation

Implementation Description

0	Implementation Notes

Related Topics

Non-Persistent Queue Implementations

0	Queue Tables

1	Queue Table Implementations

2	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

0	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. 3 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. 6 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.

17	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.

18	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

0	Short Name

1	Version

2	Name

3	Purpose

4	Type

5	Implementation Name

6	Scope

Member

Type Member Ordering

Planning

Status

0	Candidate ?

1	Size

2	Complexity

3	Project

4	Activity

5	Task

6	Time Estimate

7	Estimate Units

Invocation

Top Level ?

0	Deterministic ?

Return Type

Return Type (Scalar)

0	Return Type (Object)

Restrict References

WNDS ?

0	WNPS ?

1	RNDS ?

2	RNPS ?

Declaration

Free Format Declaration ?

0	Source Path

PL/SQL

PL/SQL Block

0	Package Specification

1	Private Declaration

Java

Java Class Definition

0	Java Method

1	Java Parameter List

2	Java Return Type

Documentation:

Release Notes

0	Description

1	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

0	Table

1	Name

2	Version

3	Complete ?

4	Enable?

5	Update ?

Validation

Validate In

0	Defer Status

1	Error Message

2	Exceptions Table

Source

Unique Identifier

Documentation

Description

0	Notes

Related Topics

Columns

0	Foreign Key Constraints

1	Key Components

2	Tables

3	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.

6	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

0	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.

0	PL/SQL definitions can store values in variables (scalar and composite) and constants, and raise error/warning messages where error conditions are encountered.

1	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.

2	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)

10	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

0	Module / PL/SQL

1	Name

2	Version

3	Construct Type

4	Scope

5	Usage Sequence

Read/Write

Read ?

0	Write ?

Defined By

Domain

0	Datastructure

1	Column

2	Table Definition

3	Oracle Type

Definition

Datatype

0	Length

1	Decimal Places

2	Default Value

3	Default Value Type

4	Optional ?

5	Delimiter

Exception

Oracle Error Code Number

Documentation

Comment

0	Data Construct Definition

1	Description

2	Notes

3	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.

A value of zero will generate NOCACHE.

A null value will generate without a [NO]CACHE clause.


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

0	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.

0	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

0	Database

1	Database User

2	Table

3	Version

4	Complete ?

Scope

Global Synonym Name

0	Scope

Storage

Tablespace

0	Storage Definition

1	Init Trans

2	Max Trans

3	Percent Free

4	Percent Used

5	Cached

Locking

Locking Sequence

Parallel

Parallel ?

0	Degree

1	Instances

Materialized View Log

Materialized View Log ?

0	Tablespace (Log)

1	Storage Definition  (Log)

2	Init Trans (Log)

3	Max Trans (Log)

4	Pct Free (Log)

5	Pct Used (Log)

Index-organized Tables

Pct Threshold

0	Overflow Tablespace

Replication

Replication Group

Documentation

Implementation Description

0	Implementation Notes

1	Non-Oracle Storage

Related Topics

Databases

0	Database Users

1	Tables

2	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

0	Database

1	Database User

2	Table

3	Name

4	Version

5	Usage Sequence

6	Value_Less_Than

Storage

Tablespace

0	Storage Definition

1	Init Trans

2	Max Trans

3	Percent Free

4	Percent Used

Related Topics

Databases

0	Database Users

1	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

0	Database

1	Database User

2	Tablespace

3	Version

4	Quota

5	Quota Units

Documentation

Comment

Related Topics

Database Users

0	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

0	Database

1	Name

2	Version

3	Complete ?

4	Online ?

5	Read Only ?

6	Temporary Tablespace ?

7	Storage Definition

Documentation

Comment

0	Description

1	Notes

Related Topics

Clusters

0	Indexes

1	Rollback Segments

2	Tables

3	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

0	Database Trigger

1	Column

2	Version

Related Topics

Columns

0	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

0	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.

0	Unique key constraints cannot be recorded in the repository for:

-	object tables and object views

0	-	index-organized tables.

An attempt to enter another row containing the department name SALES would violate the unique key constraint on the DNAME column.

0	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.

1	A unique key constraint that comprises more than one column is known as a composite key.

2	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.

3	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.

4

5	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.

6	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.

7	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

0	Table

1	Name

2	Version

3	Complete ?

4	Enable ?

5	Mandatory ?

6	Update ?

7	NULL is Discrete Value ?

Validation

Validate In

0	Defer Status

1	Error Message

2	Exceptions Table

Source

Unique Identifier

Documentation

Description

0	Notes

Related Topics

Columns

0	Foreign Key Constraints

1	Key Components

2	Primary Key Constraints

3	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.

6	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

0	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.

0	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.

1	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.

0

1	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.

0	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

0	Name

1	Version

2	Alias

3	Col. Prefix

4	Display Title

Object View

Object Type

0	OID Attribute List

SQL

Free Format Select Text ?

0	Select Text

1	Optimizer Hint Clause

2	Where/Validation Condition

Documentation

Comment

0	Description

1	Notes

2	User Help Text

Visual Basic/C++

Insert Code

0	Update Code

1	Delete Code

2	Lock Code

Related Topics

Check Constraints

0	Columns

1	Foreign Key Constraints

2	Primary Key Constraints

3	Synonyms

4	Unique Key Constraints

5	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

0	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.

0	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

0	Database

1	Database User

2	View

3	Version

4	Complete ?

Scope

Global Synonym Name

0	Scope

Replication

Replication Group

Documentation

Implementation Description

0	Implementation Notes

Related Topics

Databases

0	Database Users

1	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.

Default: Yes


 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.


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.