Confirm an index definition already exists

The Index Definition document defines values that are stored or indexed for use in views or in searches.

Before you make any modifications to the Index Definition document, examine it to determine if an index definition already exists.

Note: Making changes to the Index Definition document requires advanced technical skills and an understanding of the consequences of each change. For this reason, always check the Index Definition document first to see if it already contains the index definition you need.

In addition to the indexes defined in the Index Definition document, IXIASOFT CCMS also contains a number of system properties whose values can be configured to be displayed in the views. Although the system properties do not have to be defined as an index, they do need to be defined in a summary in the Index Definition document.

Summaries improve the performance of your applications by allowing selected document data to be indexed as a set, so that when a search is carried out, instead of performing multiple read operations, TEXTML Server retrieves a set of document data in a single operation.

The following properties are available by default:

Table 1. Document properties
Property Description Example
Collection The collection to which the document belongs. 
<property NAME="Collection" TYPE="String">
 /Documents/
CreatedBy The username of the person who imported the document. 
<property NAME="CreatedBy" TYPE="String">
 smithj
CreationDate The date the document was imported into the docbase. 
<property NAME="CreationDate" TYPE="Date">
 2019-09-14
CreationTime The time the document was imported into the docbase. 
<property NAME="CreationTime" TYPE="Time">
 13:32:06
DocType Whether the document is a user document or a system document (TEXTML_DOCUMENT or SYSTEM_DOCUMENT, respectively). 
<property NAME="DocType" TYPE="String">
 TEXTML_DOCUMENT
Indexable Boolean indicating whether indexing has been enabled for the document. 
<property NAME="Indexable" TYPE="String">
 false
LockComment Comment pertaining to the lock. 
<property NAME="LockComment" TYPE="String">
LockedBy Username of the person who checked out the document. 
<property NAME="LockedBy" TYPE="String">
 jjones
LockedDate Date the document was checked out. 
<property NAME="LockedDate" TYPE="Date">
 2019-10-18
LockedTime Time the document was checked out. 
<property NAME="LockedTime" TYPE="Time">
 14:53:04
LockOwner If true, the document was checked out directly; if false, it was checked out indirectly by checking out its parent collection. 
<property NAME="LockOwner" TYPE="String">
 true
MimeType A two-part identifier for file formats on the Internet, used by applications calling TEXTML Server. The default value, application/octet_stream, identifies files not associated with a specific application. 
<property NAME="MimeType" TYPE="String">
 application/octet_stream
ModificationDate Date the document was last saved. 
<property NAME="ModificationDate" TYPE="Date">
 2019-09-14
ModificationTime Time the document was last saved. 
<property NAME="ModificationTime" TYPE="Time">
 13:32:06
ModifiedBy Username of the person that last modified the document. 
<property NAME="ModifiedBy" TYPE="String">
 rsmith
Name The file name of the document. 
<property NAME="Name" TYPE="String">
 eoq1453833968759.xml
Size Size of the document, in bytes. 
<property NAME="Size" TYPE="Numeric">
 15558
StorageType The document format in the docbase. 
<property NAME="StorageType" TYPE="String">
 BINARY
Version Version number assigned by TEXTML Server. 
<property NAME="Version" TYPE="Numeric">
 1
PreviousVersionsCount Number of previous versions of the document. 
<property NAME="PreviousVersionsCount" TYPE="Numeric">
Only available if TEXTML Server is configured with 
<IndexPreviousVersionsInfo>True </IndexPreviousVersionsInfo>
 0
PreviousVersionsSize Total size (in bytes) of the previous version. 
<property NAME="PreviousVersionsSize" TYPE="Numeric">
Only available if TEXTML Server is configured with 
<IndexPreviousVersionsInfo>True </IndexPreviousVersionsInfo>
 0

To confirm an index definition already exists:

  1. Open the TEXTML Administration perspective by clicking the TEXTML Administration shortcut on the tool bar. If the shortcut is not displayed, follow these steps:
    1. Select Window > Perspective > Open Perspective > Other
    2. Click TEXTML Administration.
    3. Click Open.
  2. In the TEXTML Administration view, double-click the server.
  3. If your server is not displayed in the view, add it by doing the following:
    1. To find the server name, click Window > Preferences and select IXIASOFT CCMS.
      In the TEXTML Server Connection section, the server name is the Hostname.
    2. Copy the Hostname and close the Preferences window.
    3. In the TEXTML Administration view, right-click and select Add Server.
    4. In the Server field, enter the server name.
      The Port field should fill automatically. If you need the port number, you can find it in the same place as the server name in the Preferences window.
    5. Click OK.
  4. When the Connect as dialog opens, type your username and password and click OK.
  5. Double-click the name of your Content Store to open a connection to it.
  6. Expand the Content Store node.
  7. Double-click Index Definition to open it in the editor.
  8. Look in the <summaries> section to see if the system property or index you need is listed.
    • If it is listed, then you can use it to configure CCMS.
    • If the system property is not listed, then you will need to edit the Index Definition document to add it to the <summaries> section.
    • If the index is not listed, then you need to determine if it has been defined.
  9. To see if the index you need is defined, look for it in the <indexes> section. The index must be defined and set as KEEPEXTRACTEDVALUES="True" to enable its values to be listed.
    • If the index is defined but is set as KEEPEXTRACTEDVALUES="False", you must edit the Index Definition document to set the index's attribute to "True".
    • If the index is defined but does not appear in the <summaries> section, you must edit the Index Definition document to add it to a summary.
    • If the index is not defined, you will have to create it.
You determined whether the index definition you need already exists, needs modification, or if you need to create a new index definition.