You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@manifoldcf.apache.org by kw...@apache.org on 2015/02/09 18:24:52 UTC

svn commit: r1658478 - in /manifoldcf/branches/dev_1x: ./ site/src/documentation/content/xdocs/en_US/ site/src/documentation/resources/images/en_US/

Author: kwright
Date: Mon Feb  9 17:24:51 2015
New Revision: 1658478

URL: http://svn.apache.org/r1658478
Log:
Pull up fix for CONNECTORS-1064 from trunk.

Added:
    manifoldcf/branches/dev_1x/site/src/documentation/resources/images/en_US/alfresco-authority.png
      - copied unchanged from r1658463, manifoldcf/trunk/site/src/documentation/resources/images/en_US/alfresco-authority.png
    manifoldcf/branches/dev_1x/site/src/documentation/resources/images/en_US/alfresco-connector-job.png
      - copied unchanged from r1658463, manifoldcf/trunk/site/src/documentation/resources/images/en_US/alfresco-connector-job.png
    manifoldcf/branches/dev_1x/site/src/documentation/resources/images/en_US/alfresco-connector-save.png
      - copied, changed from r1658463, manifoldcf/trunk/site/src/documentation/resources/images/en_US/alfresco-connector-save.png
    manifoldcf/branches/dev_1x/site/src/documentation/resources/images/en_US/alfresco-connector.png
      - copied unchanged from r1658476, manifoldcf/trunk/site/src/documentation/resources/images/en_US/alfresco-connector.png
Modified:
    manifoldcf/branches/dev_1x/   (props changed)
    manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml

Propchange: manifoldcf/branches/dev_1x/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Feb  9 17:24:51 2015
@@ -121,4 +121,4 @@
 /manifoldcf/branches/CONNECTORS-981:1605049-1605773
 /manifoldcf/branches/CONNECTORS-989:1611600-1612101
 /manifoldcf/branches/CONNECTORS-990:1610284-1610707
-/manifoldcf/trunk:1620703,1620748,1620812,1620862,1621449,1621613,1621855,1622213,1622740,1622850,1622853-1622854,1623249,1623251,1623314,1623599,1623951,1623953-1623954,1623956,1623972,1624058,1624085,1624174,1624236,1624377,1624384,1624399,1624449,1624464,1624504,1624729-1624731,1624906,1624909-1624910,1624982,1625023,1625095,1625103,1625108,1625264,1625270,1625394,1625400,1625910,1626090,1626097,1626102,1626638-1626639,1626973,1627687,1627690,1627959,1628046,1628066,1628106,1628168,1628188,1628699,1628798,1628808,1628845,1628905,1629122,1629374-1629375,1629379,1629541,1629994,1630188,1630535,1630623,1630671,1630812,1630885,1631039,1631162,1631164,1631252,1631750,1631953,1632013,1632225,1632289,1632562,1632844,1632847,1632854,1633062-1633063,1633108,1633193,1633202,1633282,1633284,1633295,1633336,1633339,1633345,1633348,1633364,1633378,1633383,1633432,1633546,1633590,1633634,1633668,1633727,1633760,1633764,1633786,1633910,1633923,1634021,1634028,1634067,1634132,1634145,1634148,163
 4155,1634188,1634202,1634264,1634373,1634530,1634688,1634850,1634857,1635103,1635116,1635421,1635438,1635478,1635481,1635484,1635490,1635809,1635939,1636146,1636167,1636180,1636207,1636215,1636232,1636334,1636519,1636570,1636684,1636940,1637011,1637310,1637350,1637364,1637373,1637378,1639259,1639593,1639600,1640018,1640101,1640199,1640204,1640208,1640314,1640319,1640749,1640772,1640805,1640888,1640925,1640941-1640942,1641222,1641328,1641557,1641559,1641629,1641633,1641724,1641754,1641911,1642163,1642255,1642318,1642531,1642650,1642658,1642673,1642716,1644197,1644399,1644538,1644920,1644931,1646317,1646397,1646403,1646408,1646640,1646947,1647574,1647585,1647608,1648686,1648976,1649201,1649203,1649529,1649605,1649628,1649794,1650351,1650722,1650741-1650742,1650745,1650747,1650911,1650954,1651332,1651539,1651907,1651921,1652071,1652974,1653175,1653899,1654651,1655205,1655261,1655264,1655377,1655411,1655618,1655914,1657346,1657443,1658004,1658036,1658121,1658155,1658188
+/manifoldcf/trunk:1620703,1620748,1620812,1620862,1621449,1621613,1621855,1622213,1622740,1622850,1622853-1622854,1623249,1623251,1623314,1623599,1623951,1623953-1623954,1623956,1623972,1624058,1624085,1624174,1624236,1624377,1624384,1624399,1624449,1624464,1624504,1624729-1624731,1624906,1624909-1624910,1624982,1625023,1625095,1625103,1625108,1625264,1625270,1625394,1625400,1625910,1626090,1626097,1626102,1626638-1626639,1626973,1627687,1627690,1627959,1628046,1628066,1628106,1628168,1628188,1628699,1628798,1628808,1628845,1628905,1629122,1629374-1629375,1629379,1629541,1629994,1630188,1630535,1630623,1630671,1630812,1630885,1631039,1631162,1631164,1631252,1631750,1631953,1632013,1632225,1632289,1632562,1632844,1632847,1632854,1633062-1633063,1633108,1633193,1633202,1633282,1633284,1633295,1633336,1633339,1633345,1633348,1633364,1633378,1633383,1633432,1633546,1633590,1633634,1633668,1633727,1633760,1633764,1633786,1633910,1633923,1634021,1634028,1634067,1634132,1634145,1634148,163
 4155,1634188,1634202,1634264,1634373,1634530,1634688,1634850,1634857,1635103,1635116,1635421,1635438,1635478,1635481,1635484,1635490,1635809,1635939,1636146,1636167,1636180,1636207,1636215,1636232,1636334,1636519,1636570,1636684,1636940,1637011,1637310,1637350,1637364,1637373,1637378,1639259,1639593,1639600,1640018,1640101,1640199,1640204,1640208,1640314,1640319,1640749,1640772,1640805,1640888,1640925,1640941-1640942,1641222,1641328,1641557,1641559,1641629,1641633,1641724,1641754,1641911,1642163,1642255,1642318,1642531,1642650,1642658,1642673,1642716,1644197,1644399,1644538,1644920,1644931,1646317,1646397,1646403,1646408,1646640,1646947,1647574,1647585,1647608,1648686,1648976,1649201,1649203,1649529,1649605,1649628,1649794,1650351,1650722,1650741-1650742,1650745,1650747,1650911,1650954,1651332,1651539,1651907,1651921,1652071,1652974,1653175,1653899,1654651,1655205,1655261,1655264,1655377,1655411,1655618,1655914,1657346,1657443,1658004,1658036,1658121,1658155,1658188,1658463,1658476

Modified: manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml
URL: http://svn.apache.org/viewvc/manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml?rev=1658478&r1=1658477&r2=1658478&view=diff
==============================================================================
--- manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml (original)
+++ manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml Mon Feb  9 17:24:51 2015
@@ -1139,6 +1139,29 @@ curl -XGET http://localhost:9200/index/_
                 <p>Note that in this example, the Active Directory connection is not responding, which is leading to an error status message instead of "Connection working".</p>
             </section>
 
+            <section id="alfrescowebscriptauthority">
+                <title>Alfresco Webscript Authority Connection</title>
+                <p>The Alfresco Webscript authority connection type helps secure documents indexed using the Alfresco Webscript repository connection type.</p>
+                <p>Independently of how the permissions schema is finally configured within the Alfresco instance, the Alfresco Webscript Autorithy service can retrieve the ACLs tokens associated to the users
+                  at request time. The connector is based on a single, secured service that directly enquires the Alfresco instance for the users permissions at all levels. The permissions tokens returned will be
+                  consistent with the Alfresco permissions model, therefore this Authority Connector makes sense to work only with the Alfresco Webscript Repository Connector and not any other connector</p>
+                <p>IMPORTANT: in order to put available the required services within Alfresco, it is necessary FIRST to install and deploy within the Alfresco instance the 
+                  following <a href="https://github.com/maoo/alfresco-indexer">Alfresco Webscript</a> </p>. Please follow the instructions in the README file.
+                <p>The Alfresco Webscript Authority Connection has a single configuration tab in the authority connection editing screen called "Server" where one needs to configure the Alfresco's services endpoint:</p>
+                <br/><br/>
+                <figure src="images/en_US/alfresco-authority.png" alt="Alfresco Server Endpoint Configuration" width="80%"/>
+                <br/><br/>
+                <p>As you can see, the Alfresco endpoint settings are quite simple and almost self-explicative:</p>
+                <ul>
+                  <li><strong>Protocol:</strong> HTTP or HTTPS depending on your instance</li>
+                  <li><strong>HostName:</strong> IP or domain where the Alfresco instance is hosted in your network</li>
+                  <li><strong>Port:</strong> port where the Alfresco instance has been deployed</li>
+                  <li><strong>Context:</strong> URL path where the webscript services has been deployed (/alfresco/service by default) after installed the WebScript</li>
+                  <li><strong>User:</strong> user ID used for performing the authored request to Alfresco. The user MUST have enough privileges for consulting any other user permissions, therefore admin user used to be a good idea</li>
+                  <li><strong>Password:</strong> password of the above user in Alfresco</li>
+                </ul>
+            </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>
@@ -1573,6 +1596,46 @@ curl -XGET http://localhost:9200/index/_
               <br/><br/>
             </section>
 
+            <section id="alfrescowebscriptrepository">
+              <title>Alfresco Webscript Repository Connection</title>
+              <p>The Alfresco Webscript Repository connection type allows you to index content from an Alfresco repository.  It also supports document
+                    security, in conjunction with the Alfresco Webscript Authority connection Type.</p>
+              <p>The current connector relies on a set of services that have been developed on top of Alfresco for easing content and metadata retrieving from an Alfresco instance. These services will be available within an Alfresco
+              instance after installing the following artifact: <a href="https://github.com/maoo/alfresco-indexer">Alfresco Indexer</a>. Please, make sure that you, FIRST, install and deploy within the desired Alfresco instance the AMP generated after building the Alfresco Indexer project before trying to index content from ManifoldCF.</p>
+              <p>By default each Alfresco Webscript Connection manages a single Alfresco repository, this means that if you have multiple Alfresco repositories that you want to manage, you need to create a specific connection for each one.</p>
+              <p>The Alfresco Webscript Repository connector has a single configuration tab in the repository connection editing screen called "Server" where one needs to configure the Alfresco's services endpoint:</p>
+              <br/><br/>
+                <figure src="images/en_US/alfresco-connector.png" alt="Alfresco Server Endpoint Configuration" width="80%"/>
+                <br/><br/>
+                <p>As you can see, the Alfresco endpoint settings are quite simple and almost self-explicative:</p>
+                <ul>
+                  <li><strong>Protocol:</strong> HTTP or HTTPS depending on your instance</li>
+                  <li><strong>HostName:</strong> IP or domain where the Alfresco instance is hosted in your network</li>
+                  <li><strong>Port:</strong> port where the Alfresco instance has been deployed</li>
+                  <li><strong>Context:</strong> URL path where the webscript services has been deployed (/alfresco/service by default) after installed the WebScript</li>
+                  <li><strong>Store Protocol: Alfresco's store protocol to be used (workspace/archive)</strong> </li>
+                  <li><strong>StoreID:</strong> store's name</li>
+                  <li><strong>User:</strong> user ID used for performing the authored requests to Alfresco. The user MUST have enough privileges for all the request, therefore admin user used to be a good idea</li>
+                  <li><strong>Password:</strong> password of the above user in Alfresco</li>
+                </ul>
+                <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/en_US/alfresco-connector-save.png" alt="Alfresco Webscript Repository Connection saving" width="80%"/>
+                <br/><br/>
+                <p>When you configure a job to use the Alfresco Webscript repository connection an additional tab is presented. This is the "Filtering Configuration" tab:</p>
+                <br/><br/>
+                <figure src="images/en_US/alfresco-connector-job.png" alt="Alfresco Content Filtering" width="80%"/>
+                <br/><br/>
+                <p>The Filtering Configuration tab allows you to fully customize the crawling job on Alfresco by defining which kind of content do you want to index from your Alfresco repository.
+                  The configuration tab consist on a list of filters that can be combined for indexing only certain documents or certain parts of the repository:</p>
+                <ul>
+                  <li><strong>Site Filtering:</strong> List of sites to be crawled. Only documents belonging to these sites will be indexed</li>
+                  <li><strong>MimeType Filtering:</strong> Allow to filter documents by mimetype in Alfresco</li>
+                  <li><strong>Aspect Filtering:</strong> index only those documents associated to the configured aspects</li>
+                  <li><strong>Metadata Filtering:</strong> index only those documents that at least have the specified value for one of the configured metadata field</li>
+                </ul>
+            </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>

Copied: manifoldcf/branches/dev_1x/site/src/documentation/resources/images/en_US/alfresco-connector-save.png (from r1658463, manifoldcf/trunk/site/src/documentation/resources/images/en_US/alfresco-connector-save.png)
URL: http://svn.apache.org/viewvc/manifoldcf/branches/dev_1x/site/src/documentation/resources/images/en_US/alfresco-connector-save.png?p2=manifoldcf/branches/dev_1x/site/src/documentation/resources/images/en_US/alfresco-connector-save.png&p1=manifoldcf/trunk/site/src/documentation/resources/images/en_US/alfresco-connector-save.png&r1=1658463&r2=1658478&rev=1658478&view=diff
==============================================================================
Binary files - no diff available.