Enablement of the cmis:checkinComment property (checkinCommentProperty)

The checkinCommentProperty determines whether or not the Content Engine preserves comments written about a document at the time it is checked in. With this property, checkin comments can be stored so that users can view the comment provided each time a document has been checked in, typically a summary of the changes done during checkout of the document.

OASIS Content Management Interoperability Services (CMIS) supports a cmis:checkinComment property that can be specified to let users write comments about a document version at the time it is checked in. However, the base document class of Content Engine does not have a corresponding, native property that persists the value set in the cmis:checkinComment property.

IBM ECM CMIS has the checkinCommentProperty to persist the cmis:checkinComment so that a comment submitted with each version of a document is stored in the Content Engine repository. The value set in the checkinCommentProperty specifies the symbolic name of a Content Engine string property. The cmis:checkinComment information persists because the value of the checkinCommentProperty property maps to an existing Content Engine property. Because the IBM ECM CMIS property maps to a string property in the document class of the object store, the document that is checked in must be of the same class or a subclass of the document type.

Usage of the checkinCommentProperty is optional. By default, there is no setting for the checkinCommentProperty in the advanced properties file.

Important: If checkinCommentProperty is undefined or specifies a string property that does not exist in the document’s object class, the document is checked in but the comment about the version does not persist. In this case, the document version will not have a value for the cmis:checkinComment property.

Example using checkinCommentProperty

As an example, there can be a Content Engine object store called "vendors" that stores documents. There are two subclasses under "vendors": "invoices" and "letters." The IBM ECM CMIS administrator sets the checkinCommentProperty parameter to "remarks," which is a property defined in the "vendors" class. No other document class has a string property with "remarks" as a symbolic name.

When a user checks in a document that is a member of the "vendors," "invoices," or "letters" class, the "remarks" property persists in the Content Engine and the user comment is stored. If the user checks in a document that does not belong to "vendors" or one of the subclasses, the comment specified on the checkIn service is not stored in the Content Engine.