Defining how properties are presented in applications

The presentation section of the file, <PRESENTATION>, defines how available content categories and custom properties are presented to external applications, such as an archive search engine.

Separating the presentation of properties from the underlying property definitions enables flexible mapping of custom property details onto a user interface. This also facilitates the support of multiple languages.

To access the custom property information in the Custom Properties.xml file, external applications must use the custom filter and property API.

See the Enterprise Vault Application Programmer's Guide.

Entries in the presentation section define the following:

Presentation information can be defined for each application that will require access to custom properties in archived items.

Here is an example of a presentation section (partially completed) that shows how to define how custom properties are displayed in the Enterprise Vault browser search application:

<!-- 3. DEFINITION OF PRESENTATION PROPERTIES AVAILABLE -->

<PRESENTATION>
 <APPLICATION NAME="search.asp" LOCALE="1033">
  <FIELDGROUPS>
   <FIELDGROUP LABEL="Case Properties">
	<FIELD TAG="CaseAuthor" LABEL="Author" CATEGORY="Litigation">
	</FIELD>
	<FIELD TAG="CaseStatus" LABEL="Status" CATEGORY="Litigation">
	</FIELD>
   </FIELDGROUP>
   <FIELDGROUP LABEL="Client Properties">
   <FIELD TAG="Client" LABEL="Client Name" CATEGORY="ClientAction">
	</FIELD>
  <FIELD TAG="Topic" LABEL="Message Topic" CATEGORY="ClientAction">
	</FIELD>
   </FIELDGROUP>
  </FIELDGROUPS>

<AVAILABLECATEGORIES>
<AVAILABLECATEGORY CONTENTCATEGORY="Litigation" LABEL="Litigation">
 </AVAILABLECATEGORY>
 <AVAILABLECATEGORY CONTENTCATEGORY="ClientAction" LABEL="Client Action">
 </AVAILABLECATEGORY>
</AVAILABLECATEGORIES>
  </APPLICATION>

  <APPLICATION NAME="mysearch.asp" LOCALE="1041">
  <FIELDGROUPS>
  <FIELDGROUP LABEL="...">
 <FIELD TAG="CaseAuthor" LABEL="..." CATEGORY="Litigation"></FIELD>
 <FIELD TAG="CaseStatus" LABEL="..." CATEGORY="Litigation"></FIELD>
  </FIELDGROUP>
  <FIELDGROUP LABEL="...">
   <FIELD TAG="Client" LABEL="..." CATEGORY="ClientAction"></FIELD>
   <FIELD TAG="Topic" LABEL="..." CATEGORY="ClientAction">
   </FIELD>
  </FIELDGROUP>
  </FIELDGROUPS>
  <AVAILABLECATEGORIES>
   <AVAILABLECATEGORY CONTENTCATEGORY="Litigation" LABEL="...">
   </AVAILABLECATEGORY>
   <AVAILABLECATEGORY CONTENTCATEGORY="ClientAction" LABEL="...">
   </AVAILABLECATEGORY>
  </AVAILABLECATEGORIES>
  </APPLICATION>
</PRESENTATION>

The example shows entries for two applications - the US English (locale "1033") version of the Enterprise Vault browser search and a Japanese (locale "1041") version of a proprietary application. In this particular case, the same elements and attributes have been specified for both applications, but the LABEL values for the second application (omitted in the example) would be in Japanese.

Note the following:

In the Web search page, custom properties are displayed in groups defined by their content category; that is, when a particular content category is selected, the custom properties with that content category are displayed.

Note the following: