<!ELEMENT item-descriptor ((<property> | <table> | <attribute> | <named-query>)*, <rql-filter>?, (<property> | <table> | <attribute> | <named-query>)*)>
Parent: <gsa-template>
The SQL repository template contains one <item-descriptor>
tag for each set of repository items that share the same attributes.
The following sections describe <item-descriptor>
attributes:
General Attributes
Attribute | Description |
---|---|
| The name of this item descriptor, unique within the repository (required). This property is case-insensitive—for example, you cannot set the name property for two item descriptors in the same repository to To reference an item descriptor by multiple names, set the |
| Controls whether the Generic SQL Adapter (GSA) will cache this item’s data in its own cache, an external distributed cache application or both. See External SQL Repository Caching. |
| The caching mode for this item descriptor, one of the following:
Caching can also be disabled for individual properties by setting their |
| The name of the item descriptor whose properties are inherited by this item descriptor. See Item Descriptor Inheritance. |
| Boolean, specifies whether this is the repository’s default item descriptor. The default item descriptor is used for new repository items if no item descriptor is explicitly specified. If no item descriptor is designated as the default, the first item descriptor in the repository definition file is the default. Default: |
| Optionally describes this item descriptor. Default: value of |
| If a resource bundle is specified for this property with the tag |
| The name of the item descriptor as displayed in the ATG Control Center interface. If no |
| If a resource bundle is specified for this property with the tag |
| Specifies a property of this item descriptor that is used to represent items of this type in a user interface. For example, a profile item descriptor might set |
| Boolean, where Default: false |
| Boolean, where Default: false |
| A character used to separate elements of a multi-column repository ID when the ID is string encoded. Default: colon ( |
| The name of the ID space to use for this item descriptor. The default settings are as follows: - Item descriptor with a single-column repository ID: Item descriptor name. - Item descriptor with a multi-column repository ID: The name of the primary table and the names of the ID column in that table. For more information about ID space names and how they affect the IDs of newly generated items, see IdSpaces and the id Property earlier in this manual; and the ATG Platform Programming Guide, the Core Dynamo Services chapter. |
| The maximum number of items of this item descriptor that the item cache can store. 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. Default: |
| The time in milliseconds that an item cache entry can remain unused before its content becomes stale. After turning stale, the item cache entry is reloaded from the database the next time it is accessed. See Cache Timeout for more information. Default: 0 (items remain in the cache indefinitely until otherwise invalidated) Note: cache time out settings do not affect external distributed caching applications. If you use external caching, configure your external caching application to time out cached data. See External SQL Repository Caching. |
| The maximum time in milliseconds that an entry can remain in the item cache before it is refreshed. See Cache Timeout for more information. Default: Note: cache time out settings do not affect external distributed caching applications. If you use external caching, configure your external caching application to time out cached data. See External SQL Repository Caching. |
| 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. Default: |
| The maximum time in milliseconds that an entry can remain in the query cache before it is refreshed. See Cache Timeout for more information. Default: |
| The name of a property in this item descriptor that specifies the names of its child item descriptors. See Item Descriptor Inheritance. |
| Set to a value that is defined in the parent item descriptor’s |
| The name of this item descriptor’s parent. See Item Descriptor Inheritance. |
| A comma-separated list of properties to search if a text search query does not explicitly specify any properties. See Text Search Queries in the SQL Repository Queries chapter. |
| Used only in versioned repositories, specifies whether items of this type should be versioned. Use this attribute to override the setting in the repository property For more information about this attribute, and versioned repositories in general, see the ATG Content Administration Programming Guide. |
| A integer property whose value is used as a version control mechanism for items of this type. The value in |
| Typically used for XML file combination, where elements with the same ID are regarded as the same element. |
Content Item Attributes
The following <item-descriptor>
attributes are used in content repositories. A content repository includes one item descriptor that manages the folder hierarchy, and one or more item descriptors that define content items. A content item has a property that specifies the item’s folder parent, and a property that is used to store or reference the content data itself. The content data property is usually a java.io.File
, String
or a byte[]
data type. Items in the content item descriptor implement the ContentRepositoryItem
interface. Items in the folder item descriptor implement the FolderItem
interface, as well as the MutableRepositoryItem
interface. For more detail, see the SQL Content Repositories chapter.
Attribute | Description |
---|---|
| Boolean, specifies whether items of this type are content items. If set to - Default: |
| Specifies a numeric property in this item descriptor that holds the checksum for a content item descriptor. For example, the PublishingFileRepository automatically updates this property when an item’s |
| A property in this item descriptor that contains the number of bytes in the content. This property is used by the method |
| A property in this item descriptor that defines the name of this content item or folder item in the folder hierarchy. Unlike |
| A property in this item descriptor that defines the absolute path name of this item in the folder hierarchy. The setting in |
| Required if - Content items of type |
| Boolean, specifies whether items of this type are folder items. Only one item descriptor in a repository can set this property to If set to - Default: |
| A property in this item descriptor that specifies the ID of the folder containing this folder or content item. This property must be set for all item descriptors of content and folder items. |
| A property in this item descriptor that contains the time when item content was last modified. The property’s data type must be |
| Boolean, specifies whether the repository ID for items of this type is the item’s relative path name in the folder hierarchy. Use this attribute if the column used to store the Default: |