Using custom properties

Custom properties are indexed independently from the document's main content. Before you can use the custom properties, you must create index definitions that specify that this content should be indexed. This is done in the index element of the Index Definition document.

The following line shows the <index> element that would define an index called "Person".CUSTOMPROPERTY="True". The SYNC attribute has been set to TRUE, so the content will be updated whenever a document is added to the document base.

<index NAME="Person" CUSTOMPROPERTY="True" SYNC="True">
</index>

Here is how to define an asynchronous index:

<index NAME="Person" CUSTOMPROPERTY="True" SYNC="False">
</index>

Here is how to control when an asynchronous index is updated:

  1. Start TEXTML Console, login to a server, and connect to a document base.
  2. In the tree shown in the TEXTML Administration view, select the document base.
  3. In the Properties view for the document base, view and change the Indexing Properties, the Deindexing Properties, and the Custom Properties.

These properties have no impact on any synchronous indexes.

The lines below show a definition for one index, including the XPATH statements that define the content to be indexed.

<index NAME="Person" CUSTOMPROPERTY="True" SYNC="True">
   <wordindex CASESENSITIVE="False" ACCENTSENSITIVE="False">
      <wordindexproperties>
         <unindexablewords NAME="FullTextStopWordList"></unindexablewords>
      </wordindexproperties>
      <elements>
         <element XPATH="//identified-content/person" DEPTH="INFINITE">
         </element>
         <element XPATH="//pam:message//prism:person" DEPTH="INFINITE">
         </element>
      </elements>
   </wordindex>