ATG Repository Guide

option

zero or more

attribute

zero or more

derivation

zero or one

name

String

Required.

column-names

String

The column name or names in the SQL database; defaults to the value of name.

display-name

String

An optional name to use to identify the property in the user interface; defaults to the value of name.

display-name-resource

String

If you specify a resource bundle for this property using the <attribute name=resourceBundle> tag, then the display-name-resource attribute specifies the resource bundle key that holds the display name. See Localizing SQL Repository Definitions.

description

String

An optional attribute to describe purpose of the property; defaults to the value of name.

description-resource

String

If you specify a resource bundle for this property using the <attribute name=resourceBundle> tag, then the description-resource attribute specifies the resource bundle key that holds the description of the property. See Localizing SQL Repository Definitions.

category

String

You can group repository item properties into categories, so that a user interface will display related properties together, rather than in alphabetical order according to their display-name attributes. See Sorting Properties in the SQL Repository Item Properties chapter.

category-resource

String

If you specify a resource bundle for this property using the <attribute name=resourceBundle> tag, then the category-resource attribute specifies the resource bundle key that holds the category of the property. See Localizing SQL Repository Definitions.

data-types

string
big string
enumerated
boolean
int
short
long
float
double
byte
binary
date
timestamp
array
set
list
map

Required, unless item-type or property-type is specified. See Data Type Correspondences in this section for information about how these values map to Java and SQL data-types.

item-type

The name of another item-descriptor.

If the value of this property is another repository item, specifies the item descriptor type of that repository item. Required if data-type or property-type is not specified.

sql-type

SQL data type.

The SQL type of the corresponding column if it is different from the default type for the data-type, as specified in the Data Type Correspondences topic in this section.

property-type

Java type

Specifies the Java class of a user-defined property. See the User-Defined Property Types: Using the property-type Attribute section in this chapter.

component-item-type

The name of another item-descriptor.

If the data-type is an array, list, set, or map of items, this attribute is the name of the item descriptor of the items these collections contain. All of the items must be of the same base type.

component-data-type

Data-type name

If the data-type is an array, list, set or map of primitive values, this is the type of the primitive value. The data-type can be any valid value other than array, list, set or map. Every element in the collection must be of the same type.

default

A string

A default value for the property, if one is not specified when the repository item is created. Note that you cannot set a default value for multi-valued attributes (array, set, list, or collection type properties).

group

A string

Use this attribute to group properties together for the purpose of loading them in the same “select” statement. By default, each property is in a group with the same name as its table. You can set the group for a property to add or remove properties from these default groups. This gives you a simple way to optimize the SQL generated by the repository.

cascade

Zero or more of insert, update or delete, separated by commas

See Cascading Data Relationships.

repository

The Nucleus address of another Repository.

Specifies that the value of this property refers to one or more repository items that are part of another Repository. If you specify a relative path, it is relative to this Repository. See Linking between Repositories.

cache-mode

disabled
inherit

The cache mode for this property. If you set the cache-mode, it overrides the item descriptor cache mode, if they are different. This can be set on a specific property to disable caching. The only cache mode you can set on a per-property basis is disabled. You can restore the default cache mode by setting this to inherit. See SQL Repository Caching.

editor-class

Java class name

The class name of a PropertyEditor to use for this property. See the JavaBeans specification for a description of PropertyEditors.

queryable

Boolean

Defaults to true. Transient properties cannot use queryable="true" unless the entire item descriptor is transient. See Transient Properties in this chapter.

readable

Boolean

Defaults to true

writable

Boolean

Defaults to true

required

Boolean

Defaults to false. This should be set to true for all properties whose corresponding database columns are defined as NOT NULL.

hidden

Boolean

Hidden properties are not displayed in the ATG Control Center; defaults to false

expert

Boolean

Defaults to false