Documentation Center

The Header Record

The inclusion of this record is mandatory. There is only one such record, and it must appear as the first record in the file. The values of this record provide field names for the records that follow. These field names are used by WorldServer to identify the meaning of the field data. The ordering of the field names is not specified, but of course, the ordering must be consistent with the field values in subsequent records.

There are some well-known field names. These correspond to WorldServer system defined attributes. Some are mandatory; others are optional with default values provided. These are described in the table below.

NameMeaningRequiredDefault
LanguageThe Locale associated with the term value.YesN/A
TermThe value (text) of the term.YesN/A
Created OnCreation time of the term.NoCurrent timestamp
Created ByUser who created the term.NoCurrent user
Modified OnModification time of the term.NoCurrent timestamp
Modified ByUser who modified the term.NoCurrent user
Created On-EntryCreation time of the term entry.NoCurrent timestamp
Created By-EntryUser who created the term entry.NoCurrent user
Modified On-EntryModification time of the term entry.NoCurrent timestamp
Modified By-EntryUser who modified the term entry.NoCurrent user

All other field names are assumed to be user-defined within WorldServer. Because user-defined attributes on term and term entries can have the same name, by convention all field names for term entry attributes must append a suffix of -Entry. For example, if there is a user-defined term entry attribute named MyAttribute then the corresponding field name in the header record must be MyAttribute-Entry. This is true regardless of whether or not there is a term attribute defined with the same name.