CMIS

A query to run against the source system using The CMIS Query Language. Must begin with

select * from cmis:document d

from there you can perform any type of query needed to collect the specific documents or types you wish. Most commonly, we walk a file tree using the root folder's node reference like so:

select * from cmis:document d WHERE in_tree('workspace://SpacesStore/3144f53f-55b9-478e-9ad8-bca477a54238')

As with most query based repo connections, we append the start and end times from the Details tab of the job to restrict the documents based on their last modified date

This appends the following to the query:

d.cmis:lastModificationDate >= TIMESTAMP (Your Configured Start Time) AND d.cmis:lastModificationDate <= TIMESTAMP (Your Configured End Time)

CMIS Query Order By:

The field and ordering in the form of (Field) [ASC/DESC]. This will be added as an ORDER BY clause

If left blank, the following will be added to the query, after the modified time clause

cmis:lastModificationDate DESC

Version Depth:

How many versions of a document to retrieve, going backwards. If the value is five, then the connector will attempt to retrieve the current document and its five most recent versions, if they exist.

Search All Versions:

Must be true if connecting to a Nuxeo repository. Must be false if connecting to an Alfresco repository.

Process Relationships:

Supported in most Alfresco systems. This will attach any relationships found as metadata, similar to version information.

Important:  WARNING
If you are running with process relationships checked, and the source system does not support it, there will be an error in the logs, but the document should continue processing without error.

Output Folder Path: The folder where you wish the files to be written. This folder will be created if it does not exist.

Tip:  
To write to a site, prepend 'site/[shortname]/' to the path

Strict Version Mode: Required to be true for most ECM systems. This simply means that if a document is retrieved by ID, it will retrieve that object, and not attempt to retrieve the latest version.

CMIS Cache Enabled: A setting for the cmis session. All retrieved objects will be cached for quicker lookup later. If false, the connector will search the source system each time for a document for folder.

Add ACLs: Requires a task to set the transformedPermissions field on a repository document before output. The acls should take the form of map with principals as the keys and sets of permissions as the values. Example:

{"principal1":["read","write"],"principal2":["read"]}

Include Aspects With No Field Mappings: Aspects will be applied to documents even if the data for their fields is missing or unmapped.

Aspect Remove Field Mapping: Takes a JSON string. Remove aspects if the listed fields are not present. The example of the UI:

{"myaspect:two":["field1","field2"],"myaspect:one":["field1","field2"]}

Meaning that if field 1 or field 2 is not present, do not add the aspects.

CMIS Update Query: If populated, this query will be run, for every document, before any other attempt to upload the document. Any document ids which are returned by this query will be updated using the metadata and content from the document being processed.

Check in In/Check Out on Updates: If using an update query, the documents being updated will be checked out, have updates to metadata applied, and then be checked back in.

Update Binary on Updates: If using an update query, the document's content will be updated in addition to metadata.

• The API supports GET, POST, and DELETE calls.

• All the endpoints take the "id" parameter, which takes the form of a string.

  Ex. 5dba1525-44a6-45ed-a42e-4a155a3f0539

Read Permissions (ACLs)

Request: GET /api/repo/(connectorid)/acls?id=(id)

Description: Retrieves a list of in the format of ["principalID:permission1,permissions2",..... ]

Path Parameters:

• connectorid :The connector id of your content service connector

Query Parameters:

• id:The repository id of the item.

  GET /api/repo/cmis/acls?id=5dba1525-44a6-45ed-a42e-4a155a3f0539

Returns:

Copy

{
  "results": [
    "user@alfresco.com:cmis:all"
  ],
  "success": true
}

Example With CURL

Copy

curl -u admin:admin "localhost:8081/3sixty-admin/api/repo/cmis/acls?id=5dba1525-44a6-45ed-a42e-4a155a3f0539" | json_pp

Write Permissions (ACLs)

Request:

Copy

POST /repo/(connectorid)/acls?id=(id)&acls=(acls)

Description: Adds a principal to an object with the specified permissions. If the object exists, replace its permissions with those supplied.

Path Parameters:

• connectorid :The connector id of your content service connector

Query Parameters:

• id:The repository id of the item.

• acls: A JSON String in the format of {"principalID":"permission1,permission2",....}

Copy

POST /api/repo/cmis/acls?id=5dba1525-44a6-45ed-a42e-4a155a3f0539&acls={"newuser@alfresco.com":"cmis:read,cmis:write"}

Returns:

Copy

{
  "results": [
    "user@alfresco.com:cmis:all",
    "newuser@alfresco.com:cmis:read,cmis:write"
  ],
  "success": true
}

Example With CURL

Copy

curl -u admin:admin -X POST "localhost:8081/3sixty-admin/repo/fn/acls?id=5dba1525-44a6-45ed-a42e-4a155a3f0539&acls={%22newuser@alfresco.com%22:%22cmis:read,cmis:write%22}" | json_pp

Delete Permissions (ACLs)

Request:

Copy

DELETE /repo/(connectorid)/acls?id=(id)&acls=(acls)

Description: Remove a principle from an object.

Path Parameters:

• connectorid: The connector id of your content service connector

Query Parameters:

• id:The repository id of the item.

• aclId:a comma delimited link of principal Ids to remove from the target document.

Copy

DELETE /api/repo/cmis/acls?id=5dba1525-44a6-45ed-a42e-4a155a3f0539&aclId=newuser@alfresco.com

Returns:

Copy

{
  "success": true
}

And the following GET call should return:

Copy

{
  "results": [
    "user@alfresco.com:cmis:all"
  ],
  "success": true
}

Example With CURL

Copy

curl -u admin:admin -X DELETE "localhost:8081/3sixty-admin/repo/fn/acls?id=5dba1525-44a6-45ed-a42e-4a155a3f0539&aclId=newuser@alfresco.com| json_pp

• checkIn

• checkOut

• createFile

• createFolder

• deleteACL

• deleteFolder

• deleteObjectByID

• findTypeDefinition

• getACLs

• getFileContent

• getObjectProperties

• getTypes

• listFolderItems

• listVersions

• setACLs

• updateFile

• updateProperties