Documentation Center

MetadataConfig XML structure for list views

The second element (ishlistdef) of the MetadataConfig XML describes the list views in the ClientTools (Authoring Bridge and Publication Manager).

XML description

This part describes all components to create a list view.

XMLDescription
ishlistdefishlistdef groups all list view specifications
ishlist

This element contains the specification for one list view. The required attribute "id" must be unique and is used to select the requested list view specification.

On the list view you can specify default sort settings:
  • defaultsort: The name attribute of the ishlistfield on which the list view is sorted by default.
  • defaultsortorder: the default sorting; descending or ascending
ishlistfield

This element contains all information to display the field on the list view.

The specification of the field is a combination of the following:
  • The field that is shown

    This information is specified with the attributes name, ishfieldref, level and ishfielddatatype.

  • The alignment of the values
  • If you can filter on the field (Currently not implemented in the clienttool lists)
  • If you can sort on the field (Currently not implemented in the clienttool lists)
  • How The width for the column for the field

ishfielddatatype

This optional attribute can be used on ishlistfield and normally indicates the type of the field in the database.

The following values link with an existing database types: typedatetime, typenumber, typestring, typelongtext, typelanguagedependentstring, typecard, typecardreference and typelov.

In contrast with the above-mentioned values the following ishfielddatatypes does not linked with a database type. These values are used to link special behaviour to a specific field:
  • typeversion: This datatype can only be specified on the field VERSION.

    This type is used to create a correct new version number and to check that the value is a correct version

  • typelanguage: This datatype can be used on fields that are linked with the language list of values to convert the value to a label. Example: Convert the language "en" to the label "English".
  • typedate: In the database the dates are always saved inclusive time. However, if you don't want to show the time, you can use this datatype.
<ishlist id="InboxList" defaultsort="TitleField">
  <ishlistfield name="TitleField" ishfieldref="FTITLE" level="logical" ishfielddatatype="typestring">
    <label resourceref="InboxList.TitleField.Label">Title</label>
    <alignment>left</alignment>
    <width>50</width>
  </ishlistfield>
  <ishlistfield name="VersionField" ishfieldref="VERSION" level="version" ishfielddatatype="typeversion">
    <label resourceref="InboxList.VersionField.Label">Version</label>
    <alignment>left</alignment>
    <width>6</width>
  </ishlistfield>
  <ishlistfield name="ChangesField" ishfieldref="FCHANGES" level="version" ishfielddatatype="typestring">
    <label resourceref="InboxList.ChangesField.Label">Changes</label>
    <alignment>left</alignment>
    <width>20</width>
  </ishlistfield>
  <ishlistfield name="LanguageField" ishfieldref="DOC-LANGUAGE" level="lng" ishfielddatatype="typelanguage">
    <label resourceref="InboxList.LanguageField.Label">Lng</label>
    <alignment>left</alignment>
    <width>5</width>
  </ishlistfield>
  <ishlistfield name="StatusField" ishfieldref="FSTATUS" level="lng" ishfielddatatype="typestring" ishcondition="ISHType in ('ISHIllustration', 'ISHMasterDoc', 'ISHModule', 'ISHTemplate', 'ISHLibrary')">
    <label resourceref="InboxList.StatusField.Label">Status</label>
    <alignment>left</alignment>
    <width>20</width>
  </ishlistfield>
  <ishlistfield name="CheckedOutByField" ishfieldref="CHECKED-OUT-BY" level="lng" ishfielddatatype="typestring">
    <label resourceref="InboxList.CheckedOutByField.Label">Checked out by</label>
    <alignment>left</alignment>
    <allowfilter/>
    <sortable/>
    <width>50</width>
  </ishlistfield>
</ishlist>