Configure the columns and values displayed in views

By editing the display.xml file, you can define which columns are available in views and how they are displayed. By editing the Index Definition document, you can control the display of values in views.

You can define a column as a <key> element inside the <columns> section in the display.xml file. Each <key> contains attributes that define the heading, index name, alignment, sort order, sort type, type of information, visibility, and column width for the column. You must define the index in the Index Definition document with the attribute KEEPEXTRACTEDVALUES="True" and with a <field> element in the <summaries> section.

CAUTION: Making changes to the Index Definition document requires advanced technical skills and an understanding of the consequences of each change. MadCap Software strongly recommends that you consult with IXIA CCMS Customer Support before making significant changes.
Important: Make configuration changes in a test environment and confirm they work before copying them to a production environment. For dedicated SaaS deployments, test the changes and then ask IXIA CCMS Customer Support to copy the changes to your production environment.

To configure the columns and values displayed in views:

  1. In the TEXTML Administration perspective, connect to your server.
  2. Locate the display.xml file in the repository's /system/conf collection.
  3. Check out the file and open it for editing.
  4. Inside the <columns> element, add a <key> element for the column with the following attributes:
    Table 1. key element attributes
    Attribute Description
    name Type the name of the index (or system property) as its name is specified in the Index Definition document.
    label Type the heading to be displayed at the top of the column in the view.
    width Type the column width in pixels to set the initial size of the column by default.
    halign Define the type of horizontal alignment for the content in the column. Valid values are: LEFT, RIGHT, CENTER.
    sortType Define the sort algorithm to be used in the column. Valid values are: ALPHA, DATE, NUMERIC.
    sortOrder Define the sort order used as the initial order displayed in the column. Valid values are: ASC (ascending), DESC (descending).
    visibility Type 255. This attribute is required, but obsolete.
    type Define the type of information displayed in the column. Valid values are:
    • Index: information that is referenced by one of the indexes in the Index Definition document.
    • Property: information (such as size, name, and so on) that is kept in a TEXTML property index.
    • Other: information used as a special case with Locked By.

    For example:

    <key halign="LEFT" label="Title from source language" name="authoringTitle" sortOrder="ASC" sortType="ALPHA" type="Index" visibility="255" width="100"/>
    Tip:

    List the <key> elements in alphabetical order by their name attribute to make the list easier to read.

  5. Save, close, and check in the file.
  6. Locate the Index Definition document.
  7. Check out the file and open it for editing.
  8. Locate the <summaries> section.
  9. In the <summary NAME="fullsummary"> element, add a new <field> element inside <fieldlist>.
  10. Define the <field> with the following attributes:
    Table 2. field element attributes
    Attribute Description
    Name Type the name (Name attribute value) of the index as it is defined in the <Indexes> section.
    Type Type either Index for an index defined in the Index Definition or Property for a system or custom document property.
    Value Type All to retrieve all instances of the value or First to retrieve only the first instance of the value.

    For example:

    <field NAME="authoringTitle" TYPE="Index" VALUE="All"/>
    Tip:

    List the <field> elements in alphabetical order by their name attribute to make the list easier to read.

  11. Save, close, and check in the file.
  12. Inform users of the changes.
    The changes will be applied automatically once users close and then reopen their IXIA CCMS Desktop. Users can also apply the changes without restarting their CCMS Desktop by clicking IXIA CCMS > Synchronize Configuration.
The columns and values displayed in views are configured.