incubator-connectors-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From piergior...@apache.org
Subject svn commit: r1163569 - in /incubator/lcf/trunk: ./ site/src/documentation/content/xdocs/ site/src/documentation/resources/images/
Date Wed, 31 Aug 2011 10:50:53 GMT
Author: piergiorgio
Date: Wed Aug 31 10:50:53 2011
New Revision: 1163569

URL: http://svn.apache.org/viewvc?rev=1163569&view=rev
Log:
added the end-user documentation for the CMIS Connector

Added:
    incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-repository.png
  (with props)
    incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-save.png
  (with props)
    incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-usermapping.png
  (with props)
    incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration-save.png
  (with props)
    incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration.png
  (with props)
    incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-cmisquery.png
  (with props)
    incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-save.png
  (with props)
Modified:
    incubator/lcf/trunk/CHANGES.txt
    incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml

Modified: incubator/lcf/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/CHANGES.txt?rev=1163569&r1=1163568&r2=1163569&view=diff
==============================================================================
--- incubator/lcf/trunk/CHANGES.txt (original)
+++ incubator/lcf/trunk/CHANGES.txt Wed Aug 31 10:50:53 2011
@@ -3,6 +3,9 @@ $Id$
 
 ======================= 0.3-dev =========================
 
+CONNECTORS-229: CMIS connector needs to be documented in "how to build and deploy"
+(Piergiorgio Lucidi)
+
 CONNECTORS-244: Add a fix to recover for another Derby deadlock situation.
 (Karl Wright)
 

Modified: incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml?rev=1163569&r1=1163568&r2=1163569&view=diff
==============================================================================
--- incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml (original)
+++ incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml Wed
Aug 31 10:50:53 2011
@@ -681,6 +681,34 @@
                 <p>If you need specific ManifoldCF logging information, contact your
system integrator.</p>
             </section>
             
+            <section id="cmisauthority">
+              <title>CMIS Authority Connection</title>
+              <p>A CMIS authority connection is required for enforcing security for
documents retrieved from CMIS repositories.</p>
+              <p>The CMIS specification includes the concept of authorities only depending
on a specific document, this authority connector is only based on a regular expression comparator.</p>
+              <p>A CMIS authority connection has the following special tabs you will
need to configure: the "Repository" tab and the "User Mapping" tab. The "Repository" tab looks
like this:</p>
+              <br/><br/>
+              <figure src="images/cmis-authority-connection-configuration-repository.png"
alt="CMIS Authority, Repository configuration" width="80%"/>
+              <br/><br/>
+              <p>The repository configuration will be only used to track an ID for
a specific CMIS repository. No calls will be performed against the CMIS repository.</p>
+              <br/><br/>
+              <p>The second tab that you need to configure is the "User Mapping" tab
that allows you to define a regular expression to specify the user mapping.</p>
+              <p>The "User Mapping" tab looks like the following:</p>
+              <br/><br/>
+              <figure src="images/cmis-authority-connection-configuration-usermapping.png"
alt="CMIS Authority, User Mapping configuration" width="80%"/>
+              <br/><br/>
+              <p>The purpose of the "User Mapping" tab is to allow you to map the incoming
user name and domain (usually from Active Directory) to its CMIS user equivalent.
+                     The mapping consists of a match expression, which is a regular expression
where parentheses ("("
+                     and ")") mark sections you are interested in, and a replace string.
 The sections marked with parentheses are called "groups" in regular expression parlance.
 The replace string consists of constant text plus
+                     substitutions of the groups from the match, perhaps modified.  For example,
"$(1)" refers to the first group within the match, while "$(1l)" refers to the first match
group
+                     mapped to lower case.  Similarly, "$(1u)" refers to the same characters,
but mapped to upper case.</p>
+              <p>For example, a match expression of <code>^(.*)\@([A-Z|a-z|0-9|_|-]*)\.(.*)$</code>
with a replace string of <code>$(2)\$(1l)</code> would convert an AD username
of
+                  <code>MyUserName@subdomain.domain.com</code> into the LiveLink
user name <code>subdomain\myusername</code>.</p>
+              <p>When you are done, click the "Save" button.  You will then see a summary
and status for the authority connection:</p>
+              <br/><br/>
+              <figure src="images/cmis-authority-connection-configuration-save.png" alt="CMIS
Authority, saving configuration" width="80%"/>
+              <br/><br/>
+            </section>
+            
         </section>
         
         <section id="repositoryconnectiontypes">
@@ -1595,6 +1623,45 @@
                 <p>If more than one rule is present, the rules are all executed in
sequence.  That is, the output of the first rule is modified by the second rule, etc.</p>
             </section>
             
+            <section id="cmisrepository">
+              <title>CMIS Repository Connection</title>
+              <p>The CMIS Repository Connection type allows you to index content from
any CMIS-compliant repository.</p>
+              <p>By default each CMIS Connection manages a single CMIS repository,
this means that if you have multiple CMIS repositories exposed by a single endpoint, you need
to create a specific connection for each CMIS repository.</p>
+              <br/><br/>
+              <p>A CMIS connection has the following configuration parameters on the
repository connection editing screen:</p>
+              <br/><br/>
+              <figure src="images/cmis-repository-connection-configuration.png" alt="CMIS
Repository Connection, configuration parameters" width="80%"/>
+              <br/><br/>
+              <p>Select the correct CMIS binding protocol (AtomPub or Web Services)
and enter the correct username, password and the endpoint to reference the CMIS document server
services.</p>
+              <p>The endpoint consists of the HTTP protocol, hostname, port and the
context path of the CMIS service exposed by the CMIS server:</p>
+              <br/><br/>
+              <p><code>http://HOSTNAME:PORT/CMIS_CONTEXT_PATH</code></p>
+              <br/><br/>
+              <p>Optionally you can provide the repository ID to select one of the
exposed CMIS repository, if this parameter is null the CMIS Connector will consider the first
CMIS repository exposed by the CMIS server.</p>
+              <br/><br/>
+              <p>Note that, in a CMIS system, a specific binding protocol has its own
context path, this means that the endpoints are different:</p>
+              <p>for example the endpoint of the AtomPub binding exposed by the actual
version of the InMemory Server provided by the OpenCMIS framework is the following:</p>
+              <p><code>http://localhost:8080/chemistry-opencmis-server-inmemory-war-0.5.0-SNAPSHOT/atom</code></p>
+              <br/><br/>
+              <p>The Web Services binding is exposed using a different endpoint:</p>
+              <p><code>http://localhost:8080/chemistry-opencmis-server-inmemory-war-0.5.0-SNAPSHOT/services/RepositoryService</code></p>
+              <br/><br/>
+              <p>After you click the "Save" button, you will see a connection summary
screen, which might look something like this:</p>
+              <br/><br/>
+              <figure src="images/cmis-repository-connection-configuration-save.png" alt="CMIS
Repository Connection, saving configuration" width="80%"/>
+              <br/><br/>
+              <p>When you configure a job to use the CMIS repository connection an
additional tab is presented. This is the "CMIS Query" tab:</p>
+              <br/><br/>
+              <figure src="images/cmis-repository-connection-job-cmisquery.png" alt="CMIS
Repository Connection, CMIS Query" width="80%"/>
+              <br/><br/>
+              <p>The CMIS Query tab allows you to specify the query based on the CMIS
Query Language to get all the result documents that need to be ingested.</p>
+              <p>Note that the CMIS Connector during the ingestion process, for each
result, if it will find a folder node (that must have cmis:folder as the baseType), it will
ingest all the children of the folder node; otherwise it will directly ingest the document
(that must have cmis:document as the baseType).</p>
+              <p>When you are done, and you click the "Save" button, you will see a
summary page looking something like this:</p>
+              <br/><br/>
+              <figure src="images/cmis-repository-connection-job-save.png" alt="CMIS Repository
Connection, saving job" width="80%"/>
+              <br/><br/>
+            </section>
+            
         </section>
 
 </body>

Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-repository.png
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-repository.png?rev=1163569&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-repository.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-save.png
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-save.png?rev=1163569&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-save.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-usermapping.png
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-usermapping.png?rev=1163569&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-authority-connection-configuration-usermapping.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration-save.png
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration-save.png?rev=1163569&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration-save.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration.png
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration.png?rev=1163569&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-configuration.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-cmisquery.png
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-cmisquery.png?rev=1163569&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-cmisquery.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-save.png
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-save.png?rev=1163569&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/cmis-repository-connection-job-save.png
------------------------------------------------------------------------------
    svn:mime-type = image/png



Mime
View raw message