Summary of custom property elements and attributes

Table: XML elements and attributes in the Custom Properties.xml file summarizes all elements and attributes in Custom Properties.xml.

The value in the Mandatory column assumes that the IGNORENODEFAULT registry setting is not used.

Table: XML elements and attributes in the Custom Properties.xml file

Element

Attribute

Mandatory

Description

CONTENTCATEGORIES

Yes

Defines the content category section of the file.

DEFAULT=

No

Value is the name of the content category to be used as default. Required if custom properties in all items are to be indexed.

CONTENTCATEGORY

Yes

Defines a group of settings that are to be assigned to an archived item.

NAME=

Yes

Value is a unique name to identify category to ruleset and presentation interface.

RETENTIONCATEGORY=

No

Value is a retention category to be assigned to the archived item. retention category must exist in Enterprise Vault.

ARCHIVEID=

No

Value is the ID of the archive to store the item in. Value can be found in the properties of the archive in the Enterprise Vault Administration Console.

INDEXEDPROPERTIES

Yes

Defines a set of additional properties in the content category.

RETRIEVE=

No

Value is "Y" or "N". Indicates whether or not properties in this set should appear in the search results. Default is "N".

PROPERTY

Yes

Defines an additional property to index for items that are assigned this content category.

TAG=

Yes

Value is the Enterprise Vault TAG of the property.

CUSTOMPROPERTIES

Yes

Defines the custom property section of the file.

NAMESPACE

Yes

Defines a NAMESPACE that contains a group of custom properties.

TYPE=

Yes

Value is the type of property: "LOTUS".

PROPERTY

Yes

Defines a custom property.

NAME=

Yes

Value is the identity of the property as displayed in message properties in the Lotus Notes client.

Value must be unique in NAMESPACE.

LOTUSTYPE=

Yes

Value is the Domino property data type: "TEXT", "NUMBER" or "TIME".

TAG=

Yes

TAG identifies the property within Enterprise Vault. It can contain only alphanumeric characters (A-Z a-z 0-9); spaces and underscore characters are not permitted. The value must be unique within the XML file.

TAG value is the property name that will be stored in the index.

PRESENTATION

Yes

Defines the presentation property section of the file.

APPLICATION

Yes

Defines a group of fields for use by a named application.

NAME=

Yes

Value is the name of the application that will use the fields in this definition.

LOCALE=

Yes

The value depends on what the calling application requires to define the language. The Enterprise Vault browser search uses standard Microsoft Locale ID number that the application will run under. (Currently only "1033", US English, is supported for displaying custom properties in the browser search.)

FIELDGROUPS

Yes

Define the field groups available to the application.

FIELDGROUP

Yes

A logical grouping of fields for the presentation interface.

LABEL=

No

Value will be presented to the application for this field group. The label must be unique within the application.

FIELD

Yes

Defines a field that will reference a custom property.

LABEL=

Yes

Value will be displayed on the application user interface to represent this custom property.

CATEGORY=

Yes

Value is the name of a content category listed in AVAILABLECATEGORIES for the application.

TAG=

Yes

Value is the TAG of a custom property. The tag must be unique in the FIELDGROUP.

AVAILABLECATEGORIES

Yes

Define which content categories are available to the application.

AVAILABLECATEGORY

Yes

Defines a content category.

LABEL=

Yes

Value defines how the content category is to appear in the user interface.

CONTENTCATEGORY=

Yes

Value is the NAME of the required content category as specified in the Content Category section of the file.