Search <book_title>...

Enterprise Vault™ Setting up Domino Server Archiving

Last Published: 2024-03-04

Product(s): Enterprise Vault (15.0)

Defining how custom properties are presented in third party applications

The presentation section of the file, <PRESENTATION>, defines how available content categories and custom properties are presented to external applications, such as a proprietary 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.

Entries in the presentation section define the following:

Custom properties available for displaying by the named application
How properties are to be grouped and displayed in the application
Content categories available to the application
How each content category should be displayed in the application

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 a web search application:

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

<PRESENTATION>
 <APPLICATION NAME="engsearch.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="jpnsearch.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 versions of an application - the US English (locale "1033") version, and a Japanese (locale "1041") version. In this particular case, the same elements and attributes have been specified for both versions, but the LABEL values for the second version (omitted in the example) would be in Japanese.

Note the following:

The properties available to each application are grouped using the <APPLICATION> element.
The NAME attribute identifies the application.
The value of the LOCALE attribute is defined by the calling application. It is assumed here that the application uses the standard Microsoft Locale ID for the language that the application will use: 1033 represents US English. The second application in the example, jpnsearch.asp, also uses the Microsoft Locale ID; 1041 represents Japanese.

In the application 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:

The <FIELDGROUPS> element is used to define all the groups of custom properties to be displayed.
Each group is defined in a <FIELDGROUP> element. The LABEL attribute gives the title that will be displayed in the application for the group of properties. The value of the LABEL attribute must be unique in the application.
<FIELD> elements define each property to be displayed in the group.
The value of the TAG attribute identifies the property to be displayed. The value specified here must match the associated TAG value of the property in the <CUSTOMPROPERTIES> section of the file.
The value of the CATEGORY attribute identifies the content category with which this property is to be associated. When the user selects this content category in the search criteria, a box for this property could be displayed. The value specified for CATEGORY must match the associated NAME for the content category in the content category section of the file. Also, CATEGORY must be one defined in the <AVAILABLECATEGORIES> element.
TAG must be unique in the <FIELDGROUP> and the TAG/CATEGORY combination must be unique within the <APPLICATION> element.
LABEL defines the name that you want displayed in the user interface for the custom property.
<AVAILABLECATEGORIES> groups the content categories that are to be available for selection in the application. Each content category is defined using the <AVAILABLECATEGORY> element; the value of the CONTENTCATEGORY attribute must match the name of the content category specified in the content category section of the file. The LABEL attribute defines the name you want displayed for the content category in the user interface.