You are here

README.txt in CMIS API 3.0.x

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Credits
 * Maintainers


INTRODUCTION
------------

The CMIS API project aims to provide a generic API for integrating with CMIS
(http://en.wikipedia.org/wiki/Content_Management_Interoperability_Services)
compliant Enterprise CMS (ECM) systems.

When to use this module:

 * If your needs for managing structured and unstructured content go beyond
   Drupal's current file handling capabilities.
 * If you need advanced workflow or security for managed documents that need to
   be exposed to the web or an intranet.
 * If you already have a CMIS compliant document management system in place and
   need a way for web content managers to easily be able to add documents to
   sites Resources.

What this project does:

The CMIS API is composed of several modules and primarily provides an API for
connecting to CMIS compliant systems to bi-directionally synchronize content
between the CMIS ECM system and Drupal.

In addition to the API, this package provides a range of basic functionality for
creating, updating, browsing and searching content in the CMIS ECM system via
the Drupal interface.

The overall goal of the modules is to provide an easy-to-use, WCM front-end in
Drupal for ECM systems that are often unfamiliar to web content managers.

While this module does provide interfaces and functionality out of the box,
most developers doing advanced integrations will want to create custom modules
that invoke the included API for custom authentication, synchronization, content
type extension, etc.

What is included:
 * CMIS:
   - A connection config entity to be able to connect as many CMIS compliant
     system as you want.
   - A browser to interact with the remote documents: folder creation, deletion,
     document upload, document deletion.
   - A query page to directly make query against the remote system (cmis/query).
   - A new field type to get links to remote document.
 * CMIS Alfresco Auth User:
   - Allow users to use CMIS features by connecting to Alfresco using Drupal's
     login/password.
   - When the Alfresco's connection ticket will expire, the user will be logged
     out.


REQUIREMENTS
------------

The module requires the https://github.com/dkd/php-cmis-client library. And
therefore you need to use Composer to download the module.

Otherwise, this module has no requirement except Drupal core.


INSTALLATION
------------

 * Install and enable this module like any other drupal 8 module.


CONFIGURATION
-------------

 * Enable the CMIS module on your site
 * Go to the configuration page
   (/admin/config/cmis/connection/cmis_connection_entity)
 * Configure a connection
 * Save the connection
 * Use the browse link on the configuration page


CREDITS
-------

Contributors on previous versions / drupal.org projects related to CMIS:
 * Dries Buytaert (Dries) - https://www.drupal.org/user/1
 * Yong Qu
 * Matt Asay
 * Scott Davis (jhabiteici) - https://www.drupal.org/user/1599684
 * Jeff Potts (jpotts) - https://www.drupal.org/user/226200
 * Dave Gynn
 * Rich McKnight (richmck) - https://www.drupal.org/user/334839


MAINTAINERS
-----------

Current maintainers:
 * Florent Torregrosa (Grimreaper) - https://www.drupal.org/user/2388214
 * Ines WALLON (liber_t) - https://www.drupal.org/user/3377176

Previous maintainers:
 * Chris Fuller (cfuller12) - https://www.drupal.org/user/61928
 * Ian Norton (IanNorton) - https://www.drupal.org/user/1314428
 * Catalin Balan (cbalan) - https://www.drupal.org/user/435484
 * József Dudás (dj1999) - https://www.drupal.org/user/387119
 * Ruben Teijeiro (rteijeiro) - https://www.drupal.org/user/780508
 * tudor.sitaru - https://www.drupal.org/user/665088
 * Mark Payne (webcurl) - https://www.drupal.org/user/2483100

This project has been sponsored by:

 * Acquia - https://www.drupal.org/acquia
   Sponsored development, maintenance and support on previous versions /
   drupal.org projects related to CMIS.
 * Optaros - http://www.optaros.com
   Sponsored development, maintenance and support on previous versions /
   drupal.org projects related to CMIS.
 * Alfresco - https://www.alfresco.com/
   Sponsored development, maintenance and support on previous versions /
   drupal.org projects related to CMIS.
 * Tieto - https://www.drupal.org/tieto
   Sponsored Drupal 8 port.
 * Brainsum - https://www.drupal.org/brainsum
   Sponsored Drupal 8 port.
 * 040lab - https://www.drupal.org/040lab
   Sponsored Drupal 8 port.
 * Smile - https://www.drupal.org/smile
   Sponsored evolutions, maintenance and support.

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Installation
  6. * Configuration
  7. * Credits
  8. * Maintainers
  9. INTRODUCTION
  10. ------------
  11. The CMIS API project aims to provide a generic API for integrating with CMIS
  12. (http://en.wikipedia.org/wiki/Content_Management_Interoperability_Services)
  13. compliant Enterprise CMS (ECM) systems.
  14. When to use this module:
  15. * If your needs for managing structured and unstructured content go beyond
  16. Drupal's current file handling capabilities.
  17. * If you need advanced workflow or security for managed documents that need to
  18. be exposed to the web or an intranet.
  19. * If you already have a CMIS compliant document management system in place and
  20. need a way for web content managers to easily be able to add documents to
  21. sites Resources.
  22. What this project does:
  23. The CMIS API is composed of several modules and primarily provides an API for
  24. connecting to CMIS compliant systems to bi-directionally synchronize content
  25. between the CMIS ECM system and Drupal.
  26. In addition to the API, this package provides a range of basic functionality for
  27. creating, updating, browsing and searching content in the CMIS ECM system via
  28. the Drupal interface.
  29. The overall goal of the modules is to provide an easy-to-use, WCM front-end in
  30. Drupal for ECM systems that are often unfamiliar to web content managers.
  31. While this module does provide interfaces and functionality out of the box,
  32. most developers doing advanced integrations will want to create custom modules
  33. that invoke the included API for custom authentication, synchronization, content
  34. type extension, etc.
  35. What is included:
  36. * CMIS:
  37. - A connection config entity to be able to connect as many CMIS compliant
  38. system as you want.
  39. - A browser to interact with the remote documents: folder creation, deletion,
  40. document upload, document deletion.
  41. - A query page to directly make query against the remote system (cmis/query).
  42. - A new field type to get links to remote document.
  43. * CMIS Alfresco Auth User:
  44. - Allow users to use CMIS features by connecting to Alfresco using Drupal's
  45. login/password.
  46. - When the Alfresco's connection ticket will expire, the user will be logged
  47. out.
  48. REQUIREMENTS
  49. ------------
  50. The module requires the https://github.com/dkd/php-cmis-client library. And
  51. therefore you need to use Composer to download the module.
  52. Otherwise, this module has no requirement except Drupal core.
  53. INSTALLATION
  54. ------------
  55. * Install and enable this module like any other drupal 8 module.
  56. CONFIGURATION
  57. -------------
  58. * Enable the CMIS module on your site
  59. * Go to the configuration page
  60. (/admin/config/cmis/connection/cmis_connection_entity)
  61. * Configure a connection
  62. * Save the connection
  63. * Use the browse link on the configuration page
  64. CREDITS
  65. -------
  66. Contributors on previous versions / drupal.org projects related to CMIS:
  67. * Dries Buytaert (Dries) - https://www.drupal.org/user/1
  68. * Yong Qu
  69. * Matt Asay
  70. * Scott Davis (jhabiteici) - https://www.drupal.org/user/1599684
  71. * Jeff Potts (jpotts) - https://www.drupal.org/user/226200
  72. * Dave Gynn
  73. * Rich McKnight (richmck) - https://www.drupal.org/user/334839
  74. MAINTAINERS
  75. -----------
  76. Current maintainers:
  77. * Florent Torregrosa (Grimreaper) - https://www.drupal.org/user/2388214
  78. * Ines WALLON (liber_t) - https://www.drupal.org/user/3377176
  79. Previous maintainers:
  80. * Chris Fuller (cfuller12) - https://www.drupal.org/user/61928
  81. * Ian Norton (IanNorton) - https://www.drupal.org/user/1314428
  82. * Catalin Balan (cbalan) - https://www.drupal.org/user/435484
  83. * József Dudás (dj1999) - https://www.drupal.org/user/387119
  84. * Ruben Teijeiro (rteijeiro) - https://www.drupal.org/user/780508
  85. * tudor.sitaru - https://www.drupal.org/user/665088
  86. * Mark Payne (webcurl) - https://www.drupal.org/user/2483100
  87. This project has been sponsored by:
  88. * Acquia - https://www.drupal.org/acquia
  89. Sponsored development, maintenance and support on previous versions /
  90. drupal.org projects related to CMIS.
  91. * Optaros - http://www.optaros.com
  92. Sponsored development, maintenance and support on previous versions /
  93. drupal.org projects related to CMIS.
  94. * Alfresco - https://www.alfresco.com/
  95. Sponsored development, maintenance and support on previous versions /
  96. drupal.org projects related to CMIS.
  97. * Tieto - https://www.drupal.org/tieto
  98. Sponsored Drupal 8 port.
  99. * Brainsum - https://www.drupal.org/brainsum
  100. Sponsored Drupal 8 port.
  101. * 040lab - https://www.drupal.org/040lab
  102. Sponsored Drupal 8 port.
  103. * Smile - https://www.drupal.org/smile
  104. Sponsored evolutions, maintenance and support.