Index Object

Index — Fields of an index.

Introduction

Holds a collection of data dictionaries which will be the fields of an index.

Properties

Table 11. Index Object Properties

NameDetailsPossible ValuesDefault Value
ExternalNameName of index in data provider.*-
DescriptionDescription to be used in lists.*-
DetailDescriptionDetailed description.*-
ModifiedModification date-time stamp in ISO 8601 format.ccyy-mm-ddThh:mm:ssdate stamp
OccurrencesIndexEntry

Table 12. Occurrences IndexEntry

NameDetailsPossible ValuesDefault Value
DataDictionaryNameName of the DataDictionary.*-
SortSorting of the data.Ascending, DescendingAscending

  

Example

<Object Application="MyOrder" Type="Index" Name="Country">
  <Index>
    <ExternalName/>
    <Description>Country</Description>
    <DetailDescription>Compound index of  country and code</DetailDescription>
    <Modified>2007-11-12T09:58:00</Modified>
    <OccurencesIndexEntry>
      <IndexEntry SequenceNo="1">
        <DataDictionaryName>Country</DataDictionaryName>
        <Sort>Ascending</Sort>
      </IndexEntry>
      <IndexEntry SequenceNo="2">
        <DataDictionaryName>CountryCode</DataDictionaryName>
        <Sort>Ascending</Sort>
      </IndexEntry>
    </OccurencesIndexEntry>
  </Index>
</Object>