About Authoring Keywords

Keyword is the metadata of the semantic attached to catalogs, catalog chapters and catalog items. This page describes their main characteristics.

Keyword Characteristics

The following are the defining characteristics of keywords:


  • Keywords have a given type. Catalog supports most of the types of knowledge literal. (e.g. Boolean, real, integer, string, length, temperature).
  • Keyword values: Keyword value is the data itself, e.g. Diameter = 5 mm
  • Keywords are defined on Chapters; all items classified in this chapter inherit values from their parent chapter keywords.
  • Child chapters inherit keywords from the parent Chapter. This is true at the time of creating a child chapter as well as afterward when keywords are added or removed or renamed.
  • Keyword values are carried by Chapters and Items, i.e. Chapters and Items can both be searched and filtered against keyword values.

Special Keyword Values

The following are special Keyword values:


  • Unset value: It means that the value is intentionally unset and <Unset> is displayed.
  • Default value: Default value is only applicable to items. It is the value given to any classified item at classification time. It means that the actual (and displayed) value is the value from the father chapter (this is recursive on chapter tree). If the father chapter value is changed, the item whose value is default will get the new value, while the one which value has been explicitly set will keep its set value.
  • *Multi value: The value is actually a list a values. The filter criteria will take into account all of these values. Ex: = criteria will be fulfilled if at least one of the values matches the criteria. Example: Supported countries = {USA;France;India}
  • *Range value: The value is actually a range between 2 limits. It is only available on orderable types of Keywords (i.e. based on Real or Integer, not string or Boolean) Example: Power range = 100-230V

* not yet available

Manage Keywords User Interface

When the Manage Keywords command is activated, the Keyword Edition toolbar is displayed:



The following are the details about the Keyword Edition toolbar:


  • Add Keyword: enables you to add keyword to the chapter.
  • Remove Selected Keywords: enables you to remove direct keyword from the chapter.
  • Activate Edit Mode: enables you to modify the name and value of keywords.
  • Activate Propagate Mode: enables you to propagate the modification of the default value of a keyword on the sub chapter default values .

Note: It is possible to select the chapters on the fly.

The left part of the immersive Manage Keywords on Chapter dialog box displays the Tree View.


  • The Chapter is displayed as root.
  • All keywords defined on the Chapter are displayed as nodes of the tree.
  • The type of keywords are displayed as leaves of the tree with their associated type icons.

The following are some of the frequently used types and their icons:



The right part of the immersive Manage Keywords on Chapter dialog box displays the detailed view. It contains the keyword values of the chapter and its items. Sub-chapters are not included here.


  • Chapter keyword values are displayed in the first row. If a Keyword is inherited, the icon is displayed.
  • Item names are displayed in the first column.
  • If an item value is a default value, the icon is displayed.
  • If applicable, the unit is displayed with the keyword value.
  • Sorting of rows is available by clicking the column header.
  • The bottom part of the dialog box is a work area. When modifying keywords and their values, inputs are keyed-in here.
Warning:
  • Inserted chapters inherit keywords and keyword values from their Parent chapter

  • You cannot add keywords to items, you can only modify the values of existing keywords
  • Keywords are recursively propagated to subchapters and can only be renamed or removed at the level of their creation.
Important:
  • When a keyword is added on a chapter, the keyword and the keyword value are always propagated to the items directly classified under the chapter and to all subchapters.
  • For later modifications of keyword values, selecting the Propagate option causes keyword values to be propagated to subchapters and to all items using the default value.
  • The propagate option does not affect the values of items for which the value has been modified or is different from the default value.
Warning: The display mode buttons at the upper-right corner enable you to modify the presentation of the Item table. They are used exactly as in a Search Results window. See Search Results Display Modes.

Considerations

This section mentions about the points to be considered in relation to keywords.


  • Keyword names are not NLS-compliant, e.g. if a keyword is defined with Japanese characters it will not be translated.
  • Keyword type cannot be modified. (Only keyword names and values can be modified.)
  • User changes cannot be undone. (The Keyword Edition supports short transaction only.)