IBM Content Navigator, Version 2.0.3     Supports:  CMIS for Content Manager

sortByNameIdealAttribute

This parameter enables sorting folder children or search results by name, if sorting children or search results is configured for ideal case sorting. Use this parameter to specify which single universal standardized name attribute is used in your data model and can be used as the ideal case for sorting support.

sortByNameIdealAttribute = attribute name

This parameter applies in the following situations:
  • It applies to sorting only when the sortChildrenByNameAndTitle or sortSearchByNameAndTitle parameter is set to DATABASE.
  • It always applies to retrieving by name-only paths or existing item detection, but it depends on whether the application uses the feature.
  • It applies to name-only path generation if fast paths are disabled (the fastFolderAccessPaths or fastDocumentAccessPaths parameter is set to FALSE).

Content Manager EE does not enforce a single universal standardized name attribute common to all item types. The location and name of the name attribute can vary by item type and in some cases might not exist at all as an attribute. You can only optimally sort on a single root component attribute common to all possible results. Therefore, it is not possible to sort some data models by name depending on location of the name attribute, and not possible to as optimally sort mixed data models. This configuration setting helps you work around this restriction.

Content Manager EE Version 8.4.3 or later provides a standardized name attribute, ICM$NAME to all new item types that are designated as hierarchical. Content Manager EE Version 8.4.3 Fix Pack 1 or later enables the universal standardized name attribute, ICM$NAME for use by any new or existing item type of any designation. However, the existing item types, existing data, and other existing name attribute extensions from individual solutions yield multiple possibilities. A sophisticated name mapping algorithm can detect and display names of documents and folders from many data models with different name attributes and locations. However, some features, such as sorting, can only work optimally under ideal conditions when the entire data uses model matches a single ideal case.

The following attributes are common ideal case name attributes depending on your model:
ICM$NAME
Available in Content Manager EE Version 8.4.3 Fix Pack 1 or later for use with any item type. Automatically added to any hierarchical item type available in Content Manager EE Version 8.4.3 or later. Used by new installations of IBM® Content Manager Collaboration Services Version 1.2 or later and IBM CMIS for Content Manager Version 1.0 Fix Pack 1 or later.
clbContent.clbLabel
Original name attribute extension added by IBM CMIS for Content Manager Version 1.0 and IBM Content Manager Collaboration Services Version 1.0, Version 1.1, and Version 1.1 Fix Pack 1.
FileName
IBM Document Manager name attribute extension.
The following attributes are common name attributes that are not ideal for universal sorting.
  • Root component system attribute original file name, OriFName. This is located on the root component on documents of item types classified as a resource.
  • Document part system attribute original file name, OriFName. This is located on the document parts of an item type classified as a document that supports compound documents with zero or more document parts each with a file name.

Action

You must identify which attribute should be used as the ideal case for name values in your data model.
  1. Review the attributes listed for the item types in your repository for attributes used to store a file or folder name. Check attribute groups as well as individual attributes.
  2. Identify if a name attribute is used universally on all types that can appear as folder children or search results.
  3. Check example best practices item types such as ClbFolder and CmisDocument which you might or might not be using.
  4. Check which name attribute is used by the predefined item type such as ClbSavedSearch, ClbLibrary, and ClbDraft. But you do not need to match these predefined item types. See additional notes.
  5. If there is no ideal name attribute, consider extending existing item types or creating new item types using DocumentTypeEnable to add a new ideal case name attribute, such as the universal standardized name attribute, ICM$NAME.
  6. Specify which single universal standardized name attribute is used in your data model and can be used as the ideal case for sorting support. If the attribute belongs to an attribute group, use the group qualified name, such as MyGroupName.MyAttributeName.

Additional information

Data migration is not required for existing data. If an existing item type with existing data is extended to add the ideal case name attribute as an optional metadata extension without data migration, then no data is filtered out, new data sorts correctly, but existing data that is not migrated displays the correct original name value but will sort incorrectly based on empty ideal name attribute value.

You do not have to match the name attribute used by predefined item types such as ClbLibrary, ClbApplication, ClbDraft, and ClbSavedSearch. The library, library group or application, and draft item types appear only in special folders and queries and will sort by the correct name attribute automatically for special cases. However, if you create any search based folders, these use the ClbSavedSearch item type, and are affected by the ideal case name attribute choice when sorting.

But you must match the example best practices item types, ClbFolder and CmisDocument, if you are using them. These types are the initial default folder type and default document type that you can keep or change. If you are using the example types for folders or documents, you must make their name attribute the ideal case or they will be filtered out or not work in ideal case sorting.

Parent topic: Advanced IBM CMIS for Content Manager configuration parameters