EMC Documentum Content Management Interoperability Services

Transcription

1 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide EMC Corporation Corporate Headquarters: Hopkinton, MA

2 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks used herein are the property of their respective owners. Copyright 2011 EMC Corporation. All rights reserved.

3 Table of Contents Chapter 1 Overview...7 About CMIS...7 Chapter 2 Capabilities...9 Repository capabilities...10 Chapter 3 Bindings...13 Restful AtomPub binding...13 Web services binding...15 Authentication in the EMC CMIS implementation...15 Authentication in the web services binding...15 Authentication in the RESTful AtomPub binding...17 Chapter 4 CMIS/Documentum Mapping...19 Repository mapping...20 Folder mapping...21 Type mapping...22 Property type mapping...23 Property mapping...24 Query mapping...27 Format mapping...29 Allowable actions mapping...30 ACL mapping...32 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 3

4

5 Preface This document is a reference to the EMC Documentum implementation of CMIS (Content Management Interoperability Services); specifically its capabilities, its bindings, authentication, and the way in which elements of the CMIS data model map to constructs in the Documentum repository. This document is not intended to serve as a reference to CMIS itself, nor is it intended to serve as a guide to CMIS development. Revision history The following changes have been made to this document. Revision date April 2011 Description Initial release Intended audience This reference is for application developers, architects, and other technical professionals who require specific information about how the CMIS standard is implemented for the EMC Documentum platform. EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 5

6 Preface 6 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

7 Chapter 1 Overview This chapter discusses the following: About CMIS About CMIS Content Management Interoperability Services (CMIS) is an OASIS specification that defines a domain model and bindings that enable interoperability among enterprise content management (ECM) systems and applications. EMC Documentum CMIS is an implementation of CMIS 1.0 that works with the EMC Documentum repository. The need for CMIS arose from a recognition that many enterprises have production Enterprise Content Management (ECM) systems from multiple vendors, and that the complexity of making these systems interoperable is a burden on IT departments and an impediment to developing enterprise-wide applications. The principal goal of CMIS is to reduce this burden by providing a standard domain model for ECM systems and expose this model through industry-standard web service (SOAP) and RESTful AtomPub bindings. CMIS enables enterprises to develop applications that are interoperable with various ECM systems and access the content in those system in a uniform manner. CMIS also provides a way for independent software vendors to develop applications that can be marketed for use with any CMIS-enabled ECM system. Because the CMIS domain model is generic to ECM systems provided by different vendors, it is not a goal of CMIS to provide access to all the features of any one ECM system. Therefore, the CMIS API is not appropriate for all types of ECM applications. For detailed information on CMIS, refer to the CMIS 1.0 specification. EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 7

8 Overview 8 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

9 Chapter 2 Capabilities This chapter discusses the following: Repository capabilities EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 9

10 Capabilities Repository capabilities This section specifies what optional CMIS capabilities are supported for a Documentum repository. These are exposed to consumers by the getrepositoryinfo service or resource. The capabilities may depend on the enabled features of a particular Documentum repository (such as full-text search). CMIS capability Description Value for Documentum capabilitygetdescendants capabilitygetfoldertree capabilitycontentstreamupdatability capabilitychanges capabilityrenditions capabilitymultifiling capabilityunfiling capabilityversionspecificfiling capabilitypwcupdatable Ability for an application to enumerate the descendants of a folder via the getdescendants service. Ability for an application to retrieve the folder tree via the getfoldertree service. Indicates the support a repository has for updating a document s content stream. Indicates what level of changes (if any) the repository exposes via the change log service. Indicates whether or not the repository exposes renditions of document objects. Ability for an application to file a document or other file-able object in more than one folder. Ability for an application to leave a document or other file-able object not filed in any folder. Ability for an application to file individual versions (that is, not all versions) of a document in a folder. Ability for an application to update the Private Working Copy (PWC) of a checked-out document. repository true true enumcapabilitycontentstreamupdates.anytime A content stream cannot be updated if the document is checked out. enumcapabilitychanges.none Documentum does not support the change log service. enumcapabilityrendition.read Note that folder renditions are not implemented. true false Documentum does not support this feature. false When moving a document, Documentum will move the CURRENT version. When getting descendants, Documentum will get the latest version. false This capability cannot be implemented because Documentum does not have a PWC feature. 10 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

11 Capabilities CMIS capability Description Value for Documentum capabilitypwcsearchable capabilityallversionssearchable capabilityquery capabilityjoin capabilityacl Ability of the repository to include the Private Working Copy (PWC) of checked-out documents in query search scope; otherwise PWCs are not searchable. Ability of the repository to include the non-latest versions of a document in query search scope; otherwise, only the latest version of each document is searchable. Indicates the types of queries that the repository has the ability to fulfill. Indicates the types of JOIN keywords that the repository can fulfill in queries. Indicates the level of support for ACLs by the repository. repository false This capability cannot be implemented because Documentum does not have a PWC feature. true With Fulltext: enumcapabilityquery.bothcombined Without Fulltext: enumcapabilityquery.metadataonly enumcapabilityjoin.inneronly enumcapabilityacl.manage principalanonymous A preconfigured anonymous user. If set, this field holds the principal who is used for anonymous repository access. This principal can then be passed to the ACL services to access the services as an anonymous user. See the EMC Documentum CMIS Deployment Guide. principalanyone A preconfigured user that has defined default privileges common to all users. Not supported in 6.7. EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 11

12 Capabilities 12 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

13 Chapter 3 Bindings This chapter discusses the following: Restful AtomPub binding Web services binding Authentication in the EMC CMIS implementation Authentication in the web services binding Authentication in the RESTful AtomPub binding Restful AtomPub binding Authentication The Restful AtomPub binding as implemented by EMC Documentum CMIS supports HTTP Basic authentication (see Authentication in the RESTful AtomPub binding, page 17). HTTP EMC Documentum CMIS implements optimistic locking using the ETag HTTP header, the value of which maps to the Documentum i_vstamp property. Cache control is implemented using the HTTP ETag header for the Object services. For non-content stream resources, HTTP PATCH is supported instead of HTTP PUT. Content ranges The Restful AtomPub binding implements content ranges as specified in section (Content-Range) of RFC URI templates EMC Documentum CMIS supports all of the URI templates defined by the CMIS 1.0 specification. Atom feed links EMC Documentum CMIS serves the first, last, next and previous links of an atom feed when appropriate. EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 13

14 Bindings Updated time of feeds The updated time on a feed will be computed based on the current time to prevent excessive performance cost in attempting to calculate the latest update time in all pages of a feed. Feed titles Feeds will use the following titles (where <TypeName> is the display name of a type definition): Type Children Collection Type Descendants Feed <TypeName> Type Descendants Feed <TypeName> Type Children Collection Query Collection Checked Out Collection Folder Children Collection Object Parents Collection Relationships Collection Folder Descendants Folder Tree All Versions Feed Overlapping elements and properties Certain AtomPub elements duplicate object properties (for example, atom:title and cmis:objectname). When this is the case in a request, the following rules apply: Atom element Object property Resolution not specified specified Use property specified not specified Use element specified specified Use element Enclosures AtomPub enclosures are populated for a contentful document entry. Invalid Boolean resource parameters When an invalid value is specified in a Boolean parameter (such as includeallowableactions or includeacl), the value is treated as false. 14 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

15 Bindings Web services binding Authentication The EMC Documentum CMIS Web Services binding supports WS Security UsernameToken Profile 1.1. See Authentication in the web services binding, page 15. Optimistic locking EMC Documentum CMIS uses the changetoken input and output to implement optimistic locking using the Documentum i_vstamp property. Content ranges EMC Documentum CMIS supports content ranges as described in section (Content Ranges) of the CMIS specification. Authentication in the EMC CMIS implementation All CMIS services as implemented in a Documentum repository require authentication. Note that authentication is also required to list available repositories that are advertised on a connection broker (historically called docbroker); if the user cannot authenticate across all the repositories, only the authenticated repositories will be returned in the repository list. The supported authentication protocols supported are binding-specific. Credentials may be in the form of a token. Authentication in the web services binding EMC Documentum CMIS supports WS-Securtiy UsernameToken Profile 1.1 as the authentication protocol for the web service binding. For a detailed description of the WS-Security UsernameToken profile, see Client SOAP messages should be secured using a WS-Security UsernameToken Profile header. If the authentication fails, the CMIS implementation will respond with a WS-Security SOAP fault. The following examples show a WS authenticated request and response. WS authenticated request Content-type: text/xml;charset="utf-8" Soapaction: "" Accept: text/xml, multipart/related, text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2 <?xml version= 1.0 encoding= UTF-8?> <S:Envelope xmlns:s=" xmlns:wsse=" oasis wss-wssecurity-secext-1.0.xsd" xmlns:wsu=" oasis wss-wssecurity-utility-1.0.xsd" xmlns:xs=" <S:Header> <wsse:security S:mustUnderstand="1"> EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 15

16 Bindings <wsse:usernametoken xmlns:ns15=" addressingidentity" xmlns:ns14=" ws-secureconversation/200512" xmlns:ns13=" wsu:id="xwssgid "> <wsse:username>my-user</wsse:username> <wsse:password Type=" oasis wss-username-token-profile-1.0#passwordtext"> my-password</wsse:password> </wsse:usernametoken> </wsse:security> </S:Header> <S:Body> <getrepositoryinfo xmlns=" xmlns:ns2=" <repositoryid>my-repository</repositoryid> </getrepositoryinfo> </S:Body> </S:Envelope> WS authenticated response Transfer-encoding: chunked null: HTTP/ OK Content-type: text/xml;charset=utf-8 Server: Apache-Coyote/1.1 Date: Mon, 31 Jan :36:17 GMT <?xml version= 1.0 encoding= UTF-8?> <S:Envelope xmlns:s=" xmlns:wsse=" oasis wss-wssecurity-secext-1.0.xsd" xmlns:wsu=" oasis wss-wssecurity-utility-1.0.xsd" xmlns:xs=" <S:Header> <wsse:security S:mustUnderstand="1"> <wsu:timestamp xmlns:ns15=" xmlns:ns14=" xmlns:ns13=" wsu:id="xwssgid "> <wsu:created> t03:36:18z</wsu:created> <wsu:expires> t03:41:18z</wsu:expires> </wsu:timestamp> </wsse:security> </S:Header> <S:Body> <getrepositoryinforesponse xmlns=" xmlns:ns2=" <repositoryinfo> <ns2:repositoryid>my-repository</ns2:repositoryid> <ns2:repositoryname>my-repository</ns2:repositoryname> <ns2:repositorydescription>my-repository</ns2:repositorydescription> <ns2:vendorname>emc</ns2:vendorname> 16 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

17 Bindings <ns2:productname>documentum</ns2:productname> <ns2:productversion> </ns2:productversion> <ns2:rootfolderid>root</ns2:rootfolderid>... <ns2:cmisversionsupported>1.0</ns2:cmisversionsupported> </repositoryinfo> </getrepositoryinforesponse> </S:Body> </S:Envelope> Authentication in the RESTful AtomPub binding HTTP basic authentication is the supported authentication protocol for the Restful AtomPub binding in the EMC CMIS implementation. For a detailed description of the HTTP basic authentication protocol, refer to As credentials passed in clear text in HTTP can be captured and misused, HTTP basic authentication should be used with HTTPS to provide encrypted communication. EMC Documentum CMIS supports this option. EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 17

18 Bindings 18 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

19 Chapter 4 CMIS/Documentum Mapping This chapter discusses the following: Repository mapping Folder mapping Type mapping Property type mapping Property mapping Query mapping Format mapping Allowable actions mapping ACL mapping EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 19

20 CMIS/Documentum Mapping Repository mapping Repository elements mapping CMIS Documentum Description repositoryid repositoryname repositorydescription vendorname productname productversion Unique repository name as obtained from connection broker Identical to repositoryid Description of repository in connection broker "EMC" "Documentum" dm_server_config.r_server_version rootfolderid "root" A fictitious root folder for the repository. latestchangelogtoken Not set Change log not supported cmisversionsupported 1.0 thinclienturi Not set An optional repository-specific URI pointing to the repository s web interface. capabilities aclcapability The collection of CMIS capabilities supported by the repository. See Repository capabilities, page 10. The collection of ACL-related capabilities supported by the repository. See ACL mapping, page 32. changesincomplete Not set Change log not supported changesontype Not set Change log not supported 20 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

21 CMIS/Documentum Mapping Folder mapping Root folder CMIS has a single root folder per repository and Documentum has multiple root folders (cabinets) per repository. To address this difference, the implementation exposes a fictitious root folder that contains all root cabinets. The cmis:object of this root folder is root. Because the root folder is a fictitious object, it is not queryable, and no ACL can be applied to it. Beneath the root folder, only objects of type dm_cabinet can be created. A consumer can check this by examining the root folder s cmis:allowedchildobjecttypeids property. Folder multi-filing CMIS specifies that folders only have one parent. Documentum allows folders to be multi-filed in multiple folders, creating multiple possible paths to a folder. In cases where the parent or path to a folder is in a response, the implementation returns only the primary parent folder or path (that is, the first of all the possible paths as determined by Content Server). When accessing an object by path the implementation locates the object using any folder path. In determining the parent of an object the parent may be reassigned if the folder s primary parent is not accessible (that is, if permission = none). If a folder has multiple parents and the client navigates from root to leaf, the parent link in the child entry will be directed to the parent that traverses to the child entry. Thus, if a folder has multiple parents, its parent link (cmis:parentid) may be different in different branches. This applies to the navigation service s getchildren, getdescendants, and getfoldertree operations. Similarly, if a folder has multiple parents and the client navigates from root to leaf, the path for the folder (the cmis:path property) will be the traversal path from its dynamic parent. Thus, if a folder has multiple parents, its path may be different in different branches. Path segments CMIS allows documents to be addressed by path. In some ECM systems the path to a document is unique, but in Documentum a document cannot be uniquely identified by what would normally be considered a path, because identically named objects can reside in the same folder. The Documentum CMIS implementation therefore exposes unique document path segments when requested using a combination of the object_name and r_object_id. This is done for every document, not just those that cannot be addressed by path. The path segments take this form: with name: b _docname without name: b _ getfoldertree default depth The default depth of the getfoldertree resource or service is 2. EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 21

22 CMIS/Documentum Mapping Type mapping Base types CMIS includes a standardization of base types. The CMIS base types are mapped to the local Documentum types as shown below: CMIS Type Documentum (local) type Notes cmis:document cmis:folder dm_document (and subtypes) dm_folder (and subtypes) cmis:relationship dm_relation (and subtypes) An instance of dm_relation, or of a subtype of dm_relation, where its definition (that is, its relation name) is an instance of dm_relation_type. cmis:policy Not supported. Only these Documentum types and their corresponding subtypes are supported. When a base type is used in a service input, the CMIS type must be specified. The equivalent local types (dm_document, dm_folder, dm_relation) must not be used as service inputs. Object types are cached. You can configure object type caching characteristics. See the EMC Documentum CMIS Deployment Guide, CMIS runtime properties section. 22 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

23 CMIS/Documentum Mapping Property type mapping CMIS property type CmisPropertyBoolean CmisPropertyDateTime CmisPropertyDecimal CmisPropertyHtml CmisPropertyId CmisPropertyInteger CmisPropertyString CmisPropertyUri Documentum property type DM_BOOLEAN DM_TIME DM_DOUBLE DM_STRING DM_ID DM_INTEGER DM_STRING DM_STRING EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 23

24 CMIS/Documentum Mapping Property mapping General information All property names and query names are case-insensitive in service requests. CMIS services respond with lowercase local (or custom) properties, and lower camel case CMIS properties. Document properties CMIS property Documentum property Description cmis:name cmis:objectid object_name r_object_id cmis:basetypeid cmis:document See Type mapping, page 22. cmis:objecttypeid cmis:createdby cmis:creationdate cmis:lastmodifiedby cmis:lastmodificationdate cmis:changetoken cmis:isimmutable cmis:islatestversion r_object_type r_creator_name r_creation_date r_modifier r_modification_date i_vstamp r_immutable_flag i_has_folder cmis:ismajorversion none Determined from r_version_label cmis:islatestmajorversion none Computed cmis:versionlabel r_version_label Numeric label cmis:versionseriesid i_chronicle_id cmis:isversionseriescheckedout none Determined from r_lock_owner cmis:versionseriescheckedoutby r_lock_owner cmis:versionseriescheckedoutid none Always Not set cmis:checkincomment cmis:contentstreamlength cmis:contentstreammimetype log_entry r_full_content_size a_content_type cmis:contentstreamfilename object_name Read-only cmis:contentstreamid i_contents_id 24 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

25 CMIS/Documentum Mapping Behavior when property filter is not set When the property filter is Not set in a request, CMIS will return all CMIS properties (that is, all properties in the CMIS namespace), with the exception of cmis:islatestmajorversion. This property is excluded for performance reasons (that is, it is a computed value that is expensive to calculate). To get the cmis:islatestmajorversion property, the consumer can set filter=cmis:islatestmajorversion or filter=*. Folder properties CMIS property Documentum property Description cmis:name cmis:objectid object_name r_object_id cmis:basetypeid cmis:folder See Type mapping, page 22. cmis:objecttypeid cmis:createdby cmis:creationdate cmis:lastmodifiedby cmis:lastmodificationdate cmis:changetoken cmis:parentid cmis:path r_object_type r_creator_name r_creation_date r_modifier r_modification_date i_vstamp i_folder_id r_folder_path cmis:allowedchildobjecttypeids See Type mapping, page 22. Relationship properties CMIS property Documentum property Description cmis:name cmis:objectid object_name r_object_id cmis:basetypeid cmis:relationship See Type mapping, page 22. cmis:objecttypeid cmis:createdby cmis:creationdate cmis:lastmodifiedby cmis:lastmodificationdate cmis:changetoken none none none none none i_vstamp EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 25

26 CMIS/Documentum Mapping CMIS property Documentum property Description cmis:sourceid cmis:targetid parent_id child_id 26 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

27 CMIS/Documentum Mapping Query mapping Queryable types The types cmis:document and cmis:folder are queryable; the type cmis:relationship is not queryable. Type cmis:document cmis:folder Queryable true true cmis:relationship Note: All properties of an object of type cmis:relationship are non-queryable because cmis:relationship is a non-queryable type. Type names in queries Only type query names can be used in CMIS SQL queries. For the base types, the query name is equivalent to the CMIS name. Local base type names (such as dm_document, dm_folder, dm_relation) cannot be used in queries. (For information on Documentum types, refer to the EMC Documentum System Object Reference.) All type names and query names are case-insensitive for service inputs (as are (column names, table names and reserved keywords). When responding, the CMIS services responds with lowercase type names. Properties not allowed in WHERE clause Some CMIS properties are computed, rather than mapped to a single persistent Documentum property. In some cases, the Documentum CMIS implementation may not support including these computed properties in the WHERE clause of a query. For example, because cmis:ismajorversion is computed from multiple Documentum properties, the following query is not supported: false SELECT * FROM cmis:document WHERE cmis:ismajorversion=true These cmis:folder and cmis:document properties cannot be used in the WHERE clause: cmis:basetypeid cmis:objecttypeid cmis:ismajorversion cmis:islatestmajorversion cmis:isversionseriescheckedout cmis:versionseriescheckedoutid cmis:contentstreammimetype cmis:contentstreamfilename cmis:allowedchildobjecttypeids Search queries Query of both metadata and full-text content of documents are supported and can be combined in a single query. The following is an example of a simple search query: EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 27

28 CMIS/Documentum Mapping SELECT * FROM cmis:document WHERE CONTAINS( documentum ) Limitations Please note the following limitations on EMC Documentum CMIS queries: Duplicate column aliases are not supported in CMIS queries, because during the SQL to DQL translation and conversion process, ambiguity that limits alias use is introduced. For example, the following query would not be supported because two different columns use the same alias ( id_or_name ): SELECT cmis:objectid AS id_or_name, cmis:name AS id_or_name FROM cmis:document Due to a limitation of the DQL interpreter in Documentum, a table alias cannot be used in combination with an asterisk when querying versions of Content Server prior to 6.5 SP3. For example, this query is not supported when executed against Content Server 6.5: SELECT doc.* FROM cmis:document AS doc Note: However, provided that specific properties are listed in the query, a table alias can be used with any Content Server version. International characters in table names or column names are not supported. 28 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

29 CMIS/Documentum Mapping Format mapping Format and MIME type CMIS content is categorized by MIME type, whereas Documentum content is mapped to a format configured in repository metadata. Multiple Documentum formats can be mapped to a single MIME type, as is typically the case with the MIME type text/plain. To address this, the Documentum CMIS implementation uses a configured list of default formats for well-known MIME types. The format mapping configuration file is located at WEB-INF/classes/mapping.xml (or under APP-INF in EAR file deployments). If a format cannot be found for a specified MIME type, the content is treated as binary. The MIME type for binaries is application/octet-stream. MIME types are cached. You can configure MIME type caching characteristics. See the EMC Documentum CMIS Deployment Guide, CMIS runtime properties. EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 29

30 CMIS/Documentum Mapping Allowable actions mapping Mapping CMIS allowable actions to permissions CMIS allowable actions enable an application to determine which service operations can be performed on a specified object. The following table shows mappings between CMIS allowable actions and permissions. Other factors may affect the ability to apply a service operation to an object. For more information on CMIS and Documentum permissions, see ACL mapping, page 32. CMIS Allowable Action cangetdescendents.folder cangetchildren.folder cangetparents.folder cangetfolderparent.object cancreatedocument.folder cancreatefolder.folder cancreaterelationship.source cancreaterelationship.target cangetproperties.object canviewcontent.object canupdateproperties.object canmove.object canmove.target canmove.source candelete.object cansetcontent.document candeletecontent.document canaddtofolder.object canremovefromfolder.folder cancheckout.document cancancelcheckout.document cancheckin.document cangetallversions.versionseries cangetobjectrelationships.object Required permission(s) browse browse browse browse cmis:write cmis:write relate relate browse cmis:read cmis:write cmis:write, change_location cmis:write cmis:write delete cmis:write cmis:write cmis:write, change_location cmis:write version version version cmis:read browse 30 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

31 CMIS/Documentum Mapping CMIS Allowable Action cangetacl.object canapplyacl.object Required permission(s) browse change_permit EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 31

32 CMIS/Documentum Mapping ACL mapping About ACLs The CMIS 1.0 specification states that an implementation can support a set of CMIS basic permissions and/or a set of repository-specific permissions. The Documentum implementation supports the CMIS basic permissions and extends the CMIS permissions with a set of repository-specific permissions that map directly to Documentum permissions. In the Documentum repository, when an object is created an ACL is either explicitly assigned to it by the user or a default ACL (which is configurable) is assigned to it by Documentum. This repository behavior is not changed in by the CMIS implementation. The (fictitious) root folder of a Documentum repository has no ACL. CMIS basic and Documentum permissions A CMIS client has the option of getting the ACL of an object with just the CMIS-defined basic permissions, or with the Documentum permission set. The default behavior of Documentum implementation for the getacl service, as well as for services that have an includeacl parameter, is to return the CMIS basic permissions. ACL type mapping The following table shows the mapping between CMIS ACL-related types and properties to Documentum types and properties. CMIS Type/Property Documentum Type/Property Notes CmisAccessControlListType dm_acl CmisACLType.exact CmisAccessControlEntryType CmisAccessControlEntryType.permission CmisAccessControlEntryType.direct r_accessor_permit A value of false indicates that there are security constraints applied to this object other than those designated by the CMIS ACL object. An ACL entry. There is no direct correspondence to the Documentum type. A Documentum basic or extended permission. A value of true indicates that the ACE is directly assigned to the object; that is, it is not derived. CmisAccessControlPrincipalType r_accessor_name A user, group, role, or Documentum-specific accessor. 32 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

33 CMIS/Documentum Mapping Permissions mapping Documentum permissions are of two types: basic permissions, which are hierarchical, and extended permissions, which are composite. This distinction is applicable for CMIS as well. The cmis:read and cmis:write permissions map to the Documentum read and write permissions, and each of them includes all permissions below them in the basic permission hierarchy. The cmis:all permission includes all basic and extended permissions. Basic permissions (hierarchical) CMIS Permission none browse cmis:read relate version cmis:write delete Documentum Permission none browse read relate version write delete EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 33

34 CMIS/Documentum Mapping Extended permissions (composite) CMIS Permission change_location change_owner change_permit change_state change_folder_links delete_object execute_proc Documentum Extended Permission change_location change_owner change_permit change_state change_folder_links delete_object execute_proc ACL representation with only CMIS basic permissions <cmis:acl> <cmis:permission> <cmis:principal> <cmis:principalid>dm_world</cmis:principalid> </cmis:principal> <cmis:permission>cmis:read</cmis:permission> <cmis:direct>true</cmis:direct> </cmis:permission> <cmis:permission> <cmis:principal> <cmis:principalid>dm_owner</cmis:principalid> </cmis:principal> <cmis:permission>cmis:write</cmis:permission> <cmis:direct>true</cmis:direct> </cmis:permission> <cmis:permission> <cmis:principal> <cmis:principalid>docu</cmis:principalid> </cmis:principal> <cmis:permission>cmis:read</cmis:permission> <cmis:direct>true</cmis:direct> </cmis:permission> </cmis:acl> ACL representation with Documentum permissions <cmis:acl> <cmis:permission> <cmis:principal> <cmis:principalid>dm_world</cmis:principalid> </cmis:principal> <cmis:permission>cmis:read</cmis:permission> <cmis:permission>execute_proc</cmis:permission> <cmis:permission>change_location</cmis:permission> <cmis:direct>true</cmis:direct> </cmis:permission> <cmis:permission> 34 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

35 CMIS/Documentum Mapping <cmis:principal> <cmis:principalid>dm_owner</cmis:principalid> </cmis:principal> <cmis:permission>delete</cmis:permission> <cmis:permission>execute_proc</cmis:permission> <cmis:permission>change_location</cmis:permission> <cmis:direct>true</cmis:direct> </cmis:permission> <cmis:permission> <cmis:principal> <cmis:principalid>docu</cmis:principalid> </cmis:principal> <cmis:permission>version</cmis:permission> <cmis:direct>true</cmis:direct> </cmis:permission> </cmis:acl> EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 35

36 CMIS/Documentum Mapping 36 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

37 Index A a_content_type ACL, 32 See also permission CMIS and Documentum permissions example, 34 CMIS permissions only example, 34 CMIS-to-Documentum mapping, 32 getacl service, 32 includeacl parameter, 32 repository support, 11 retrieving, 32 root folder, 32 aclcapability description, 20 allowable action Documentum permissions, 30 anonymous access user, 11 AtomPub authentication, 13, 17 content ranges, 13 element vs. object property duplicates, 14 enclosures, 14 feed links, 13 feed titles, 14 feed, updated time, 14 HTTP, 13 invalid Boolean parameter value, 14 URI templates, 13 authentication AtomPub, 13, 17 overview, 15 Web services binding, 15 Web services binding request example, 15 Web services binding response example, 16 B browse permission CMIS-to-Documentum mapping, 33 Documentum-to-CMIS mapping, 33 required for CMIS allowable actions, C cache ETag HTTP header, 13 MIME types, 29 object types, 22 canaddtofolder.object canapplyacl.object Documentum permission, 31 cancancelcheckout.document cancheckin.document cancheckout.document cancreatedocument.folder cancreatefolder.folder cancreaterelationship.source cancreaterelationship.target candelete.object candeletecontent.document cangetacl.object Documentum permission, 31 cangetallversions.versionseries cangetchildren.folder cangetdescendents.folder cangetfolderparent.object cangetobjectrelationships.object cangetparents.folder cangetproperties.object canmove.object canmove.source canmove.target canremovefromfolder.folder cansetcontent.document canupdateproperties.object canviewcontent.object capabilities description, 20 capability supported in Documentum, 10 capabilityacl description, 11 capabilityallversionssearchable description, 11 capabilitychanges description, 10 capabilitycontentstreamupdatability description, 10 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 37

38 Index capabilitygetdescendants description, 10 capabilitygetfoldertree description, 10 capabilityjoin description, 11 capabilitymultifiling description, 10 capabilitypwcsearchable description, 11 capabilitypwcupdatable description, 10 capabilityquery description, 11 capabilityrenditions description, 10 capabilityunfiling description, 10 capabilityversionspecificfiling description, 10 case-sensitivity queries, 27 change_folder_links permission CMIS-to-Documentum mapping, 34 Documentum-to-CMIS mapping, 34 change_location permission CMIS-to-Documentum mapping, 34 Documentum-to-CMIS mapping, 34 required for CMIS allowable actions, 30 change_owner permission CMIS-to-Documentum mapping, 34 Documentum-to-CMIS mapping, 34 change_permit permission CMIS-to-Documentum mapping, 34 Documentum-to-CMIS mapping, 34 required for CMIS allowable actions, 31 change_state permission CMIS-to-Documentum mapping, 34 Documentum-to-CMIS mapping, 34 changesincomplete not supported, 20 changesontype not supported, 20 child_id CMIS-to-Documentum mapping, 26 CMIS 1.0 specification, 7 introduction, 7 cmis:allowedchildobjecttypeids CMIS-to-Documentum mapping, 25 WHERE clause, 27 cmis:basetypeid 25 WHERE clause, 27 cmis:changetoken 25 cmis:checkincomment cmis:contentstreamfilename WHERE clause, 27 cmis:contentstreamid cmis:contentstreamlength cmis:contentstreammimetype WHERE clause, 27 cmis:createdby 25 cmis:creationdate 25 cmis:document CMIS-to-Documentum mapping, 22, 24 queries, 27 cmis:folder CMIS-to-Documentum mapping, 22, 25 query, 27 cmis:isimmutable cmis:islatestmajorversion retrieving, 25 WHERE clause, 27 cmis:islatestversion cmis:ismajorversion WHERE clause, 27 cmis:isversionseriescheckedout WHERE clause, 27 cmis:lastmodificationdate 25 cmis:lastmodifiedby 25 cmis:name 25 cmis:objectid 25 cmis:objecttypeid 25 WHERE clause, 27 cmis:parentid CMIS-to-Documentum mapping, 25 cmis:path CMIS-to-Documentum mapping, 25 cmis:policy not supportedmapping, 22 cmis:read permission CMIS-to-Documentum mapping, 33 required for CMIS allowable actions, 30 cmis:relationship CMIS-to-Documentum mapping, 22, 25 query, 27 cmis:sourceid 38 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

39 Index CMIS-to-Documentum mapping, 26 cmis:targetid CMIS-to-Documentum mapping, 26 cmis:versionlabel cmis:versionseriescheckedoutby cmis:versionseriescheckedoutid WHERE clause, 27 cmis:versionseriesid cmis:write permission CMIS-to-Documentum mapping, 33 required for CMIS allowable actions, 30 CmisAccessControlEntryType CMIS-to-Documentum mapping, 32 CmisAccessControlEntryType.direct CMIS-to-Documentum mapping, 32 CmisAccessControlEntryType.permission CMIS-to-Documentum mapping, 32 CmisAccessControlListType CMIS-to-Documentum mapping, 32 CmisAccessControlPrincipalType CMIS-to-Documentum mapping, 32 CmisACLType.exact CMIS-to-Documentum mapping, 32 CmisPropertyBoolean CMIS-to-Documentum mapping, 23 CmisPropertyDateTime CMIS-to-Documentum mapping, 23 CmisPropertyDecimal CMIS-to-Documentum mapping, 23 CmisPropertyHtml CMIS-to-Documentum mapping, 23 CmisPropertyId CMIS-to-Documentum mapping, 23 CmisPropertyInteger CMIS-to-Documentum mapping, 23 CmisPropertyString CMIS-to-Documentum mapping, 23 CmisPropertyUri CMIS-to-Documentum mapping, 23 cmisversionsupported value, 20 column name duplicate aliases, 28 international characters, 28 Content Management Interoperability Services, See CMIS content ranges AtomPub, 13 Web services binding, 15 content stream updating, 10 CURRENT version, 10 D delete permission CMIS-to-Documentum mapping, 33 Documentum-to-CMIS mapping, 33 required for CMIS allowable actions, 30 delete_object permission CMIS-to-Documentum mapping, 34 Documentum-to-CMIS mapping, 34 descendants enumerating folder, 10 dm_acl Documentum-to-CMIS mapping, 32 DM_BOOLEAN CMIS-to-Documentum mapping, 23 dm_document CMIS-to-Documentum mapping, 22 DM_DOUBLE CMIS-to-Documentum mapping, 23 dm_folder CMIS-to-Documentum mapping, 22 DM_ID CMIS-to-Documentum mapping, 23 DM_INTEGER CMIS-to-Documentum mapping, 23 dm_relation CMIS-to-Documentum mapping, 22 DM_STRING CMIS-to-Documentum mapping, 23 DM_TIME CMIS-to-Documentum mapping, 23 E enumcapabilityacl.manage Documentum value, 11 enumcapabilitychanges.none Documentum value, 10 enumcapabilitycontentstreamupdates.anytime Documentum value, 10 enumcapabilityjoin.inneronly Documentum value, 11 enumcapabilityquery.bothcombined Documentum value, 11 enumcapabilityquery.metadataonly Documentum value, 11 enumcapabilityrendition.read Documentum value, 10 ETag cache control, 13 i_vstamp property, 13 execute_proc permission CMIS-to-Documentum mapping, 34 Documentum-to-CMIS mapping, 34 F feed links, AtomPub, 13 EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 39

40 Index titles, AtomPub, 14 updated time, AtomPub, 14 file folders, add to multiple, 10 not added to folder, 10 folder add file to multiple, 10 CMIS-to-Documentum mapping, 21 descendants, enumerating, 10 multiple parents, 21 root, 21 tree, retrieving, 10 format CMIS-to-Documentum mapping, 29 full-text search, See query G getacl service default behavior, 32 getchildren multiple parent folders, 21 getdescendants multiple parent folders, 21 getfoldertree default depth, 21 multiple parent folders, 21 H HTTP AtomPub, 13 PATCH, 13 I i_chronicle_id i_contents_id i_folder_id CMIS-to-Documentum mapping, 25 i_has_folder i_vstamp 25 i_vstamp property ETag HTTP header, 13 optimistic locking, 15 includeacl parameter default behavior, 32 international character queries, 28 J JOIN keywords, 11 L latestchangelogtoken not supported, 20 locking Web services binding, 15 log_entry logging support, 10 M MIME type caching, 29 configuration file, 29 default, 29 mapping to Documentum formats, 29 multi-filing folder, 21 N none permission CMIS-to-Documentum mapping, 33 Documentum-to-CMIS mapping, 33 O object property vs. AtomPub element duplicates, 14 object type caching, 22 object_name 25 in path, 21 P parent_id CMIS-to-Documentum mapping, 26 PATCH HTTP, 13 path Documentum, 21 permission, 30 See also ACL basic, CMIS-to-Documentum mapping, 33 CMIS allowable actions, 30 CMIS-to-Documentum mapping, 33 extended, CMIS-to-Documentum mapping, 34 overview, 32 principalanonymous description, 11 principalanyone description, EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide

41 Index Private working copy (PWC) not supported, productname value, 20 productversion Documentum value, 20 property CMIS-to-Documentum mapping for cmis:document, 24 CMIS-to-Documentum mapping for cmis:folder, 25 CMIS-to-Documentum mapping for cmis:relationship, 25 CMIS-to-Documentum type mapping, 23 filter, 25 WHERE clause, 27 Q query case-sensitivity, 27 duplicate column aliases, 28 full-text, 11, 27 international characters, 28 JOIN keywords, 11 limitations, 28 mapping, 27 metadata, 11, 27 table aliases, 28 type names, 27 types allowed in, 27 R r_accessor_name Documentum-to-CMIS mapping, 32 r_accessor_permit Documentum-to-CMIS mapping, 32 r_creation_date r_creation_name CMIS-to-Documentum mapping, 25 r_creator_name 25 r_folder_path CMIS-to-Documentum mapping, 25 r_full_content_size r_immutable_flag r_lock_owner r_modification_date 25 r_modifier 25 r_object_id 25 in path, 21 r_object_type 25 r_version_label read permission Documentum-to-CMIS mapping, 33 relate permission CMIS-to-Documentum mapping, 33 Documentum-to-CMIS mapping, 33 required for CMIS allowable actions, 30 rendition support, 10 repository CMIS-to-Documentum mapping, 20 repositorydescription description, 20 repositoryid description, 20 repositoryname description, 20 root folder, See folder rootfolderid description, 20 S search all versions, including, 11 SQL, See query T table name alias, 28 international characters, 28 thinclienturi description, 20 type, 22 See also object type allowed in queries, 27 CMIS-to-Documentum mapping, 22 U URI templates AtomPub, 13 user anonymous access, 11 default privileges, 11 V vendorname value, 20 version EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide 41

42 Index add single, 10 CURRENT, 10 search, including all in, 11 version permission CMIS-to-Documentum mapping, 33 Documentum-to-CMIS mapping, 33 required for CMIS allowable actions, 30 W Web services binding authenticated request example, 15 authenticated response example, 16 authentication, 15 content ranges, 15 locking, 15 write permission Documentum-to-CMIS mapping, 33 WS-Security UsernameToken Profile support, EMC Documentum Content Management Interoperability Services Version 6.7 Reference Guide