Difference between revisions of "CMIS"
(→Current Status) |
m (→Current Status) |
||
(30 intermediate revisions by 2 users not shown) | |||
Line 3: | Line 3: | ||
management domain-specific data model, a set of generic services that act on that data model and several protocol bindings for these services, including: SOAP and Representational State Transfer (REST). | management domain-specific data model, a set of generic services that act on that data model and several protocol bindings for these services, including: SOAP and Representational State Transfer (REST). | ||
− | The LogicalDOC CMIS API allows CMIS compliant clients to communicate with a LogicalDOC repository using the AtomPub format. | + | The LogicalDOC CMIS API allows CMIS compliant clients to communicate with a LogicalDOC repository using the AtomPub format. |
− | |||
New functionality will be added over time. Check this page for the latest updates. | New functionality will be added over time. Check this page for the latest updates. | ||
Line 18: | Line 17: | ||
* The combination of an open standards based interface and open source means even more peace of mind knowing that your document repository is completely future-proof. | * The combination of an open standards based interface and open source means even more peace of mind knowing that your document repository is completely future-proof. | ||
− | === | + | ===Versions=== |
− | + | The LogicalDOC CMIS connector supports CMIS 1.0 specifications starting from LogicalDOC 6.5.1. | |
− | |||
− | |||
− | |||
− | |||
===Communication Protocol=== | ===Communication Protocol=== | ||
Line 30: | Line 25: | ||
The LogicalDOC CMIS API currently accepts requests and returns responses using the Atom Publishing Protocol (AtomPub.) | The LogicalDOC CMIS API currently accepts requests and returns responses using the Atom Publishing Protocol (AtomPub.) | ||
− | == | + | ==Usage== |
− | + | Make sure that the LogicalDOC server is started: check that there are no ERRORs in the startup logs and that you can normally connect to your server using a browser, at http://localhost:8080/logicaldoc. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | ===AtomPub=== | |
− | + | You can use a CMIS 1.0 AtomPub client and point it at http://localhost:8080/logicaldoc/service/cmis. | |
− | + | If you want to check the AtomPub XML returned using the command line, this can be done using curl or wget: | |
− | + | <pre> | |
− | + | curl -u admin:admin http://localhost:8080/logicaldoc/service/cmis | |
+ | </pre> | ||
− | + | ===CMIS Clients=== | |
− | + | Several free clients for CMIS 1.0 are available. | |
− | |||
− | [ | + | The best one is the [http://chemistry.apache.org/java/developing/tools/dev-tools-workbench.html CMIS Workbench], part of OpenCMIS. |
− | |||
− | + | Other older clients are available: | |
− | + | http://code.google.com/p/cmisspaces/ is an Adobe AIR client, | |
− | + | http://code.google.com/p/cmis-explorer/ is another Adobe AIR client | |
− | |||
− | |||
− | + | And of course you can use the [http://chemistry.apache.org/ Chemistry libraries] to produce your own client (Java, Python, PHP, .NET). Documentation and sample for using OpenCMIS libraries can be found on the [http://chemistry.apache.org/java/developing/index.html OpenCMIS developer wiki] with also [http://chemistry.apache.org/java/examples/index.html example code] and [http://chemistry.apache.org/java/how-to/index.html howtos]. | |
==Supported Functionality== | ==Supported Functionality== | ||
This section lists the functions which are supported by the LogicalDOC CMIS API. Not all of these will necessarily be available in all CMIS clients. | This section lists the functions which are supported by the LogicalDOC CMIS API. Not all of these will necessarily be available in all CMIS clients. | ||
+ | |||
+ | '''This list refers to LogicalDOC 6.8.2''' | ||
#View repository information and capabilities. | #View repository information and capabilities. | ||
Line 72: | Line 61: | ||
#Add Folders and Documents | #Add Folders and Documents | ||
#Deletion of Documents and Folders | #Deletion of Documents and Folders | ||
− | #Viewing of Documents via the document's contentStream property | + | #Viewing/Download of Documents via the document's contentStream property |
− | + | #Viewing/Editing of Documents custom attributes | |
− | + | #Get the Document or Folder object by it's path | |
==Current Status== | ==Current Status== | ||
− | This section describes CMIS functionality which is currently '' | + | This section describes CMIS functionality which is currently ''production ready'' (LD 6.8.1).<br/> |
+ | Functionality listed here are already available: | ||
#Moving of Documents and Folders | #Moving of Documents and Folders | ||
Line 85: | Line 75: | ||
#Update of document content | #Update of document content | ||
#Search for documents (full-text) | #Search for documents (full-text) | ||
− | #Search for documents ( | + | #Search for documents (parametric) |
#Folder search | #Folder search | ||
− | + | #Retrieve of a Document or Folder by it's path (starting from LD 6.8.2) | |
− | + | <br/> | |
− | + | <br/> | |
− | + | <br/> | |
− | + | <br/> | |
− |
Latest revision as of 09:03, 20 January 2014
Content Management Interoperability Services (CMIS) is a technical specification domain model for interacting with an document centric ECM repository via Web Services. It provides a content management domain-specific data model, a set of generic services that act on that data model and several protocol bindings for these services, including: SOAP and Representational State Transfer (REST).
The LogicalDOC CMIS API allows CMIS compliant clients to communicate with a LogicalDOC repository using the AtomPub format. New functionality will be added over time. Check this page for the latest updates.
Contents
Background
CMIS is an OASIS initiative, a consortium focused on driving the definition and uptake of open standards on the web. OASIS is an incubator for a number of draft standards significant in the content management space, in particular, (CMIS) and the recently initiated Integrated Collaboration Object Model (ICOM) specifications.
Aim
- Seamless (and out-the-box) integration between LogicalDOC and your existing content management infrastructure;
- Federated searching among multiple LogicalDOC repositories and other content management systems;
- A far richer set of tools and plugins integrated with LogicalDOC such as the AIR/FLEX and JavaFX Clients;
- The combination of an open standards based interface and open source means even more peace of mind knowing that your document repository is completely future-proof.
Versions
The LogicalDOC CMIS connector supports CMIS 1.0 specifications starting from LogicalDOC 6.5.1.
Communication Protocol
The LogicalDOC CMIS API currently accepts requests and returns responses using the Atom Publishing Protocol (AtomPub.)
Usage
Make sure that the LogicalDOC server is started: check that there are no ERRORs in the startup logs and that you can normally connect to your server using a browser, at http://localhost:8080/logicaldoc.
AtomPub
You can use a CMIS 1.0 AtomPub client and point it at http://localhost:8080/logicaldoc/service/cmis.
If you want to check the AtomPub XML returned using the command line, this can be done using curl or wget:
curl -u admin:admin http://localhost:8080/logicaldoc/service/cmis
CMIS Clients
Several free clients for CMIS 1.0 are available.
The best one is the CMIS Workbench, part of OpenCMIS.
Other older clients are available:
http://code.google.com/p/cmisspaces/ is an Adobe AIR client, http://code.google.com/p/cmis-explorer/ is another Adobe AIR client
And of course you can use the Chemistry libraries to produce your own client (Java, Python, PHP, .NET). Documentation and sample for using OpenCMIS libraries can be found on the OpenCMIS developer wiki with also example code and howtos.
Supported Functionality
This section lists the functions which are supported by the LogicalDOC CMIS API. Not all of these will necessarily be available in all CMIS clients.
This list refers to LogicalDOC 6.8.2
- View repository information and capabilities.
- List folder contents (children or descendant collections) and browse into sub-folders.
- Fetch Folder or Document parent object
- Add Folders and Documents
- Deletion of Documents and Folders
- Viewing/Download of Documents via the document's contentStream property
- Viewing/Editing of Documents custom attributes
- Get the Document or Folder object by it's path
Current Status
This section describes CMIS functionality which is currently production ready (LD 6.8.1).
Functionality listed here are already available:
- Moving of Documents and Folders
- Update Document metadata
- Update Folder metadata (folder rename, update folder description)
- Update of document content
- Search for documents (full-text)
- Search for documents (parametric)
- Folder search
- Retrieve of a Document or Folder by it's path (starting from LD 6.8.2)