The SQL repository template contains one <item-descriptor>
tag for each set of repository items that have common attributes.
item-descriptor Tag Attributes
Attribute | Description | Value |
---|---|---|
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 | Required |
display-name | The name of the item descriptor in the ATG Control Center interface. If no | String |
display-name-resource | If you specify a resource bundle for this item descriptor using the | String |
description | An optional attribute to describe purpose of the item descriptor. | Defaults to the value of |
description-resource | If you specify a resource bundle for this item descriptor using the | 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 |
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 | 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 | String |
version-property | A property whose value is used as a version control mechanism for this item. This property must be an | String |
id-separator | A character used to separate elements of a multi-column repository ID when the ID is string encoded. | Character. Default is |
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 |
expert | Set this to true if this item descriptor should only be displayed to expert users. | Boolean. Default is |
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 | One of |
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 item-descriptor Attributes
The following set of <item-descriptor>
tag 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.
content | Are the items defined by this item descriptor | Boolean. Default is |
folder | Are the items defined by this item descriptor | Boolean. Default is |
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 | 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 | Boolean. Default is |
folder-id-property | The name of the property that specifies the ID of the folder containing this folder or content item. Both | String. |
content-property | The name of the property that defines the content of a | String. The type of the property itself may be If the property is |
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 | 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 | String |
Versioned Repository item-descriptor Attribute
The versionable
item-descriptor tag attribute in the SQL repository definition file DTD is used only in versioned repositories. Versioned repositories are a feature of ATG Content Administration and are described in the ATG Content Administration Programming Guide.
item-descriptor Child Tags
Child Tag | How many? |
---|---|
property | zero or more |
table | zero or more |
attribute | zero or more |
rql-filter | zero or one |
named-query | zero or more |
If a <property>
tag appears as a direct child of an <item-descriptor>
tag (rather than a child of a <table>
tag), then the property is a transient property of the repository item and is not stored persistently in the database. Transient properties are readable and writable, but cannot be made queryable. See the Transient Properties section of this chapter.