System documents: descriptions

Each docbase contains several system documents (in addition to its user documents). System documents are required for the operation of TEXTML Server. Most of them DTDs for queries, ResultSpaces, docbases, properties, etc.

The names of system documents cannot be changed. Accordingly, a docbase cannot have more that one copy of a system document.

Table 1. System documents that are DTDs
DTD Describes the structure of...
INDEXDEFINITION.DTD INDEXDEFINITION.XML
REQUEST_DOCUMENTDATA.DTD The fieldList parameter of IxiaDocumentServices.GetDocumentsData (java.lang.String[] docNames, java.lang.String fieldList)
REQUEST_DOCUMENTDATA_RESULTS.DTD The IxiaDocumentServices.ResultData objects returned by a call to IxiaDocumentServices.GetDocumentsData
SEARCH_DOCUMENTS.DTD Document queries
SEARCH_INDEX.DTD Index queries
SEARCH_INDEXRESULT.DTD The result returned from an index query
SEARCH_RESULTINFO.DTD The result returned in a ResultSpace by a document query
SEARCH_SORT.DTD How search results can be sorted
TEXTMLSERVER_COLLECTION_PROPERTIES.DTD Properties of collections
TEXTMLSERVER_DOCBASE_PROPERTIES.DTD Properties of document bases
TEXTMLSERVER_DOCUMENT_PROPERTIES.DTD Properties of documents (including system documents)
TEXTMLSERVER_SERVER_PROPERTIES.DTD Properties of TEXTML Server instances
TEXTMLSERVER_TRANSACTION_LOG.DTD Events, errors, exceptions, etc. that are logged by TEXTML Server
Table 2. System documents that are not DTDs
Document Description
INDEXDEFINITION.XML

Index Definition document. Defines each index of a docbase. You must customize this file so that it defines the indexes required for your application.

The Index Definition document for the sample news documents distributed with TEXTML Server is available in your Program Files directory for TEXTML Server: [...]\IxiaSoft\TextmlServer[version]\SDK\indexdefinition.xml.

DATETIME_FORMATS.XML Defines all the date and time formats supported by TEXTML Server.