Oracle® Fusion Middleware

Repository

For this release, some of the optional capabilities listed in section 2.1.1 have not been implemented. Versioning, ACL, Policies, Relationships, Change Log, Folder Descendants/Tree, and Renditions will be considered for future releases.

Specifically, the Content Management REST Service implementation has the following optional capabilities:

capabilityGetDescendants = true
capabilityGetFolderTree = false 
capabilityContentStreamUpdatability = anytime 
capabilityChanges = none
capabilityRenditions = none 
capabilityMultifiling = false 
capabilityUnfiling = false 
capabilityVersionSpecificFiling = false 
capabilityPWCUpdateable = false 
capabilityPWCSearchable = false 
capabilityAllVersionsSearchable = false 
capabilityJoin = none    
capabilityACL = none
capabilityQuery = none, metadataonly, or both combined

Object

Content Management REST Service supports document and folder objects. In CMIS the cmis:baseTypeId for a Node will be cmis:folder or cmis:document. Also, the cmis:baseId for a Type will be cmis:folder or cmis:document.

Object-Type

A CMIS Object-Type contains fields mapped from the UCM Content Server metadata field definitions and UCM Content Server SiteStudio region definitions.

The mapping from UCM Content Server metadata fields to CMIS property definitions is as follows:

• TEXT metadata field with option list configured with select list validated and YesNoView or TrueFalseView view: cmis:propertyBoolean

• All other TEXT metadata fields: cmis:propertyString

• LONG TEXT metadata field: cmis:propertyString

• MEMO metadata field: cmis:propertyString

• INTEGER metadata field: cmis:propertyInteger

• DATE metadata field: cmis:propertyDateTime

• DECIMAL metadata field: cmis:propertyDecimal

The mapping from UCM Content Server SiteStudio Region Definition fields to CMIS property definitions is as follows:

• Image Element Definition fields: cmis:propertyString

• WYSIWYG Element Definition fields: cmis:propertyString

• Plain Text Element Definition fields: cmis:propertyString

• Static List Element Definition fields: cmis:propertyString

Document Object

Document Objects are the elementary information entities managed by the repository. As defined by the CMIS specification, Document Objects may be version-able, file-able, query-able, control-able and ACLControl-able. As stated earlier, the Content Management REST Service does not support versioning, multi-filing, Policies or ACL for this release.

If a Node is determined to be a Document (not a Folder) then any children it has will not be exposed through CMIS. In CMIS, each Document Object is associated with a single content stream, and for WebCenter CMIS REST, this stream is the Oracle Content Server binary associated with the document.

Folder Object

The CMIS specification states that Folder Objects do not have a content-stream and are not version-able. If a Node is determined to be a Folder, then the Content Management REST Services exposes it in this manner. (In UCM, folders do not have a content stream and are not versionable).

Relationship Object

The Relationship Object section does not apply, since the Content Management REST Service does not support Relationships for this release.

Policy Object

The Policy Object section does not apply, since the Content Management REST Service does not support Policies for this release.

Access Control

Most of the Access Control section does not apply, since the Content Management REST Service does not support ACL for this release. See below for details on allowable actions.

Versioning

Section 2.10 does not apply, since the Content Management REST Service does not support versioning for this release.

Query

CMIS queries return a Result Set where each Entry object will contain only the properties that were specified in the query. As the Content Management REST Service does not support JOINs in queries, each result entry will represent properties from a single node. Common searches use a query like "SELECT * FROM …".

• The FROM clause specifies a content-type to be searched.

  • FROM cmis:document ==> any UCM document (for example, IDC:GlobalProfile)

  • FROM cmis:folder ==> any UCM folder (for example, IDC:Folder)

  • FROM typeQueryName ==> type's cmis queryName, as long as the type is queryable (for example, ora:t:IDC!;GlobalProfile)

• The cmis:document and cmis:folder types are always queryable. Other types will be queryable if they are searchable in the repository.

• The IN_FOLDER predicate is implemented as the folder ID specified, being the parent of the results.

• The IN_TREE predicate is implemented as the folder ID specified, being a parent in the folder structure of the results.

• The CONTAINS() predicate is a full-text query expression operator.

• Properties of cmis:document and cmis:folder will be queryable and orderable if their corresponding UCM system property is searchable and sortable. The system property mappings are:

  • cmis:createdBy ==> dDocAuthor

  • cmis:lastModifiedBy ==> dDocCreator

  • cmis:creationDate ==> dCreateDate

  • cmis:lastModificationDate ==> dLastModifiedDate (for 10g, folders map to dLastModifiedDate and documents map to dCreateDate)

  • cmis:name ==> dOriginalName (for a document) or dCollectionName (for a folder)

  • cmis:contentStreamFileName ==> dOriginalName

  • cmis:contentStreamLength ==> VaultFileSize

  • cmis:contentStreamMimeType ==> dFormat

  • cmis:objectId ==> dDocName

  • cmis:objectTypeId ==> UCM profile name or SiteStudio Region Definition name

    Note:

    cmis:objectTypeId is never orderable.

  • cmis:path ==> use IN_FOLDER or IN_TREE predicate

  Note:

  Some repositories may have capabilities that are not representable in a CMIS query, and some repositories may have restrictions which will limit the CMIS-query predicates (or combinations of predicates) that can be used in a query. The above mappings should assist you in translating repository capabilities and restrictions into corresponding considerations for CMIS queries.

• Nested properties are not queryable or orderable.

• The Content Management REST Service implementation reports as orderable any properties which UCM specifies as sortable. This list can in some cases include properties which UCM cannot actually sort on. If you wish to allow ordering on a field for which UCM is reporting a sort error, follow the steps below to make the specified UCM field sortable:

  1. Go to Administration and open Admin Applets.

  2. Open the Configuration Manager applet and click Advanced Search Design...

  3. Edit the field you wish to make orderable and select 'Is sortable'.

  4. Save your changes and exit Administration.

For example queries, see Content Management REST Service Best Practices and Examples.

Folder Children Collection

The specification defines the following CMIS services:

• GET: getChildren

• POST: createDocument or createFolder or createPolicy or moveObject or addObjectToFolder

The Content Management REST Service also provides the following:

• POST: create This new service has five query parameters: uid, fileName, contentId, comments, simpleResponse, and one header parameter: Slug. This new service is meant to be used as a simple binary request upload. A new document is created with this service. Slug and fileName (optional, though only one needs to be defined and fileName is checked first) are used to name the binary that is attached to the request. The comments parameter is optional and contentId is optional if UCM is set up to auto-generate the dDocName.

• POST: create Content-Type: multipart/form-data This new service has a single query parameter: uid, which is the uid of the folder in which the document is to be created. The boolean query parameter simpleResponse will return a response of media type: application/atom+xml;type=entry, if set to false. If set to true, a response of media type: text/html will be returned with a URI pointing to the newly created document. The comments and simpleResponse parameters are both optional, contentId is optional if UCM is set up to auto-generate the dDocName, and the name "fileUpload" is required.

  <html>
  <head>
      <title>simple post</title>
  </head>
  <body>
  <form action="http://<host>:<port>/rest/api/cmis/children/StellentRepository?uid=IDC:Folder/2"
        method="POST"
        enctype="multipart/form-data">
      Select a document to upload: <input type="file" name="fileUpload"/><br>
       <input type="hidden" name="comments" value="this is just a comment"/>
       <input type="hidden" name="contentId" value="uniqueID1"/>
       <input type="hidden" name="simpleResponse" value="true"/> 
      <input type="submit" value="Submit"/>
  </form>
  </body>
  </html>
  

Document Entry

The specification defines the following CMIS services:

• GET: getObject, getObjectOfLatestVersion (getObject)

• PUT: updateProperties

• DELETE: deleteObject

The Content Management REST Service also provides the following:

• POST: postToDelete This new service has two query parameters: uid and _method, and allows a document to be deleted through POST.

  http://<host>:<port>/rest/api/cmis/document/repoName?uid=ABC&_method="delete"
  

Content Stream

The specification defines the following CMIS services:

• GET: getContentStream

• PUT: setContentStream

• DELETE: deleteContentStream

The Content Management REST Service also provides the following:

• POST: postTunnelContentStream This new service has five query parameters: uid, overwriteFlag, fileName, comments, _method, and one header parameter: Slug. This new service is meant to be used as a simple binary request upload or delete through POST. A document must already exist for this service. Slug and fileName (optional, though only one needs to be defined and fileName is checked first) are used to name the binary that is attached to the request. The overwriteFlag parameter defaults to true, the comments parameter is optional and _method can be "delete" or "put" (not case sensitive).

  http://<host>:<port>/rest/api/cmis/stream/repoName?uid=ABC&_method="delete"
  

• POST: postTunnelContentStream Content-Type: multipart/form-data This new service has a single query parameter: uid and is meant to be used as a simple html multipart/form-data upload or delete through POST. A document must already exist for this service. The attribute name="fileUpload" is required, "comments" is optional, and valid values for "_method" are "delete" or "put" (not case sensitive).

  <form action="http://<host>:<port>/rest/api/cmis/stream/repoName?uid=WDOC019113"      method="POST"      enctype="multipart/form-data">
      Select a document to upload: <input type="file" name="fileUpload"/><br>
       <input type="hidden" name="comments" value="this is just a comment"/>
       <input type="hidden" name="_method" value="PUT"/>
      <input type="submit" value="Submit"/>
  </form>