A <property> tag that is a child of a <table> tag defines one of the persistent characteristics of a repository item. A <property> tag that is a direct child of an <item-descriptor> tag defines a transient characteristic of a repository item. Because such a transient property is not associated with any database table, it is not stored when the repository item is updated in the database.
property child tags
Child tag | How many? |
|---|---|
option | zero or more |
attribute | zero or more |
derivation | zero or one |
<property> attributes
A <property> tag in an SQL repository definition may have XML attributes listed in the following table:
Property attributes | Valid Values | Purpose |
|---|---|---|
name | String | Required |
column-names | String | The column name or names in the SQL database Default: value of |
display-name | String | An optional name to use to identify the property in the user interface Default: value of |
display-name-resource | String | If you specify a resource bundle for this property with the tag |
description | String | An optional attribute to describe purpose of the property Default: value of |
description-resource | String | If you specify a resource bundle for this property with the |
category | String | You can group repository item properties into categories, so a user interface displays related properties together, rather than in alphabetical order according to their |
category-resource | String | If you specify a resource bundle for this property with the |
data types |
| Required, unless |
item-type | The | If the value of this property is another repository item, specifies the item descriptor type of that repository item. Required if |
sql-type | SQL data type | The SQL type of the corresponding column if it is different from the default type for the |
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 | If the |
component-data type | Data type name | If the |
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 | |
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 |
| The caching mode for this property. A property’s caching mode takes precedence over the item descriptor’s caching mode. This can be set on a specific property to disable caching. The only caching mode you can set on a per-property basis is |
editor-class | Java class name | The class name of a |
queryable | Boolean | Default: Transient properties cannot use |
readable | Boolean | Default: |
writable | Boolean | Default: |
required | Boolean | Default: |
hidden | Boolean | Hidden properties are not displayed in the ATG Control Center Default: |
expert | Boolean | Default: |
Note that the values of name attributes are case-insensitive. Therefore, you cannot have, for instance, two different properties named gender and GENDER.
