ATG Repository Guide

name

The item descriptor name. Must be unique within the repository. If you want to refer to the same item descriptor with more than one name, set the itemDescriptorAliases property of the Repository component.

Required

display-name

The name of the item descriptor in the ATG Control Center interface. If no display-name is specified, the name attribute is used.

String

display-name-resource

If you specify a resource bundle for this item descriptor 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.

String

description

An optional attribute to describe purpose of the item descriptor.

Defaults to the value of name.

description-resource

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

String

default

Is this the default item descriptor for this repository? The default item descriptor is used for newly created repository items if a different item descriptor is not specified. If no item descriptor is designated as the default, then the first item descriptor in the repository definition file is the default.

Boolean. Default is false.

super-type

The item descriptor from which this item descriptor inherits. See Item Descriptor Inheritance.

Optional. An item descriptor may have zero or one super-types.

sub-type-property

The name of a property of a parent item descriptor that specifies the names of its child item descriptors. See Item Descriptor Inheritance.

String

sub-type-value

The value of its parent’s sub-type-property that triggers use of this particular type. See Item Descriptor Inheritance.

String

copy-from

The item descriptor from which this item descriptor inherits by copying. See Item Descriptor Inheritance.

String

display-property

You can set this property to the name of a repository item property. A user interface can then represent the repository item using this property. For example, a profile item descriptor might use display-property="login". Then, each repository item would be represented using the value of the item’s login property.

String

version-property

A property whose value is used as a version control mechanism for this item. This property must be an int data type. The property is incremented each time the item is updated.

String

id-separator

A character used to separate elements of a multi-column repository ID when the ID is string encoded.

Character. Default is : (colon).

id-space-names

Set this to the name of the ID space to use for this item type. An item descriptor with a single-column repository ID uses the name of the item descriptor as the name of the ID space by default. An item descriptor with a multi-column repository ID uses the name of the primary table and the names of the ID column in that table by default. See IdSpaces and the id Property in the SQL Repository Data Models chapter and the ID Generators section of the Core Dynamo Services chapter of the ATG Programming Guide for more information about ID space names and how they affect the IDs of newly generated items.

String

hidden

Hidden item types are not displayed in the ATG Control Center.

Boolean. Default is false.

expert

Set this to true if this item descriptor should only be displayed to expert users.

Boolean. Default is false.

text-search-properties

If a text search query does not explicitly specify a property to search, then the query searches this list of property names. See Text Search Queries in the SQL Repository Queries chapter.

A comma-separated list of property names.

cache-mode

The cache mode for this item descriptor. Caching can be disabled for a single property using the cache-mode attribute of the <property> tag. See the SQL Repository Caching chapter.

One of disabled, simple, locked, distributed, distributedJMS. Default is simple.

item-cache-size

The maximum number of items belonging to this item descriptor to store in the item cache. When the number of items requested exceeds this number, the least recently accessed item is removed from the cache. See the SQL Repository Caching chapter.

Integer. Default is 1000.

item-expire-timeout

The maximum time in milliseconds that an entry can remain in the item cache before it is refreshed. See Cache Timeout for more information.

Integer. Default is -1, which means items remain in the cache indefinitely, until otherwise invalidated.

query-expire-timeout

The maximum time in milliseconds that an entry can remain in the query cache before it is refreshed. See Cache Timeout for more information.

Integer. Default is -1, which means items remain in the cache indefinitely, until otherwise invalidated.

item-cache-timeout

The time in milliseconds that an item cache entry can remain unused before it is removed from the cache. See the SQL Repository Caching chapter.

Integer. Default is 0, which means items remain in the cache indefinitely, until otherwise invalidated.

query-cache-size

The maximum number of queries of this item descriptor to store in the query cache. When the number of queries issued against this item descriptor exceeds this number, the least recently used query is removed from the cache. See the SQL Repository Caching chapter.

Integer. Default is 0, effectively disabling the query cache.

content

Are the items defined by this item descriptor ContentRepositoryItems? If you set this to true, you must also define the folder-id-property attribute, the content-property attribute and one or more of content-name-property, content-path-property, and use-id-for-path.

Boolean. Default is false.

folder

Are the items defined by this item descriptor FolderItems? There can be at most one folder item descriptor in each repository. If you set this to true, you must also define the folder-id-property attribute, the content-property attribute and one or more of content-name-property, content-path-property, and use-id-for-path.

Boolean. Default is false.

content-name-property

Specifies the name of a property that defines the name of this content item or folder item in the folder hierarchy. Unlike content-path-property, the value of this attribute should not include any path separator characters or the names of any parent folders.

String

content-path-property

Specifies a property of this item that defines the absolute path name of this item in the folder hierarchy. This name should include a leading path separator character.

String

use-id-for-path

Set this to true if the Repository ID for this item is the relative path name of the item in the folder hierarchy. Use this attribute if the column used to store the content-path-property happens to be the primary key for the table containing the item.

Boolean. Default is false.

folder-id-property

The name of the property that specifies the ID of the folder containing this folder or content item. Both content item descriptors and folder item descriptors must specify a folder-id-property.

String.

content-property

The name of the property that defines the content of a ContentRepositoryItem. If the item descriptor uses the content="true" attribute, then you must set this attribute.

String. The type of the property itself may be File, byte[] or String.

If the property is byte[] or String, then the content is stored in the database. If the property is File, then the content is retrieved from the file system, using the FilePropertyDescriptor.

content-length-property

An optional attribute that specifies a property that contains the number of bytes in the content. This property is used by the getContentLength() method of the ContentRepositoryItem interface.

String

last-modified-property

An optional attribute that specifies a property that contains the last modified time for that piece of content. The property’s data-type should be date or timestamp. This property is used by the getContentLastModified() method of the ContentRepositoryItem interface.

String

property

zero or more

table

zero or more

attribute

zero or more

rql-filter

zero or one

named-query

zero or more