Data model extensions

The groups of IBM® ECM CMIS fields are organized into attribute groups (starting with clb ). Some fields are supported by independent attributes without an attribute group.

The following groups of IBM ECM CMIS fields are available as extensions to item types:

Independent
Includes the following field: label (name)
Content standard metadata
Includes the following fields: label (deprecated), title, description, authors, categories, effective date, is hidden, language, and owners.
Version info
Includes the following fields: version comments and version labels.
Application-controlled system attributes copy (deprecated)
Overrides the system control of the following fields: created, creator, modified, and modifier. You can also override the following binary resource fields: data length, data MIME type, and data modified.
Important: If CMIS fields are added, the applications control these fields, not the system. All applications must set and maintain these fields. The values are set, updated, and retrieved exactly as specified by the applications. If the values are not set by the applications, the fields are null. Adding this extension is not recommended because most applications depend on the system for setting and maintaining values for these fields. Adding this extension might negatively affect applications that depend on values that are not null values for these fields.

Some attributes in these groups must be marked with specific constraints, such as required minimum and maximum values or lengths, and default values for the best interoperability with all applications and with database indexes for performance and scaling. You can add the required attributes only to the new document types that do not have any data store using them. The DocumentTypeEnable tool checks whether the data exists. If no data exists, the appropriate attributes are marked as required. If the data exists, such as if you are extending an existing document type, then all attributes are not required. For existing items or items created by other applications without the required values, the items behave in a mixed compatibility model so that the values are mapped when required. However the values might not be always available, and the mapping can vary depending on operation. The primary attribute that is required is the label or the file name.

You can optionally update your existing items to enter the values. The following table lists the field groups that are available as extensions for making document types optimized for CMIS.

Table 1. Field Groups that are available as extensions
Extension group Definition name Display name
Content clbContent Clb-Item Content
Version clbVersion Clb-Item Version
AppCtrlSysAttrs (not recommended) clbAppCtrlSysAttrs Application-Controlled System Attributes Copy
AppCtrlSysResAttrs (not recommended) clbAppCtrlSysResAttrs Application-Controlled System Resource Attributes Copy
Content group
The following table lists the field information for the Content group. Constraints for this group include the following required fields:
  • Label
  • Title
  • Is Hidden

The clbIsHidden field is a BOOLEAN field and must have a defined range of [0,1], with the minimum value as 0 and maximum value as 1.

Important: The label is the standardized name attribute. The label value is a file name or short name, such as CMISRelease.doc. The long name of the file is the file name only without the extension, such as CMIS Release.
Table 2. Content group fields
Field names Definition names Data types
Label clbLabel Varchar(255)
Title clbTitle Varchar(255)
Description clbDescription Varchar(510)
Authors clbAuthors Varchar(400)
Categories clbCategories Varchar(255)
Effective Date cmbEffectiveDate Date
Is Hidden clbIsHidden Short
Language clbLanguage Varchar(25)
Owners clbOwners Varchar(255)
Table 3. Independent group fields
Field names Definition names Data types Constraints
label ICM$NAME Varchar(255) Required, minimum length 1
Table 4. Version group fields
Field names Definition names Data types
Comments clbVerComments Varchar(500)
Version labels clbVerLabels Varchar(255)
Table 5. AppCtrlSysAttrs group fields (Deprecated)
Field names Definition names Data types
Created clbCreatedTS Timestamp
Creator clbCreatedBy Varchar(32)
Modified clbUpdatedTS Timestamp
Modifier clbUpdatedBy Varchar(32)
Table 6. AppCtrlSysResAttrs group fields (Deprecated)
Field names Definition names Data types
Data length clbBinaryLength Long
Data MIME type clbMimeType Varchar(20)
Data modified clbBinaryLastModified Timestamp