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 2014/10/24 10:48:08 UTC
svn commit: r1634028 - in /manifoldcf/trunk: ./
site/src/documentation/content/xdocs/en_US/
site/src/documentation/content/xdocs/ja_JP/
site/src/documentation/content/xdocs/zh_CN/
Author: kwright
Date: Fri Oct 24 08:48:07 2014
New Revision: 1634028
URL: http://svn.apache.org/r1634028
Log:
Fix for CONNECTORS-1081
Modified:
manifoldcf/trunk/CHANGES.txt
manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml
manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/included-connectors.xml
manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml
manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/included-connectors.xml
manifoldcf/trunk/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml
manifoldcf/trunk/site/src/documentation/content/xdocs/zh_CN/included-connectors.xml
Modified: manifoldcf/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/manifoldcf/trunk/CHANGES.txt?rev=1634028&r1=1634027&r2=1634028&view=diff
==============================================================================
--- manifoldcf/trunk/CHANGES.txt (original)
+++ manifoldcf/trunk/CHANGES.txt Fri Oct 24 08:48:07 2014
@@ -3,6 +3,9 @@ $Id$
======================= 2.0-dev =====================
+CONNECTORS-1081: ElasticSearch documentation update.
+(Jens Jahnke)
+
CONNECTORS-1080: Elastic search: go from "content" field to "_content".
(Jens Jahnke)
Modified: manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml
URL: http://svn.apache.org/viewvc/manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml?rev=1634028&r1=1634027&r2=1634028&view=diff
==============================================================================
--- manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml (original)
+++ manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml Fri Oct 24 08:48:07 2014
@@ -301,6 +301,74 @@
<p><strong>If the proper version of the plugin is not deployed and properly integrated, documents will not be properly secured.</strong> Thus, it is essential to verify that the
proper plugin version has been deployed for the version of ManifoldCF you are using.</p>
+ <p>To work with ManifoldCF, your ElasticSearch instance must also include the appropriate indexes created as well.
+ Here are some simple steps for creating an ElasticSearch index, using the CURL utility:</p>
+ <p></p>
+ <source>
+% curl -XPUT 'http://localhost:9200/manifoldcf'
+% curl -XPUT 'http://localhost:9200/manifoldcf/attachment/_mapping' -d '
+{
+ "attachment" : {
+ "_source" : {
+ "excludes" : [ "file" ]
+ },
+ "properties": {
+ "allow_token_document" : {
+ "type" : "string"
+ },
+ "allow_token_parent" : {
+ "type" : "string"
+ },
+ "allow_token_share" : {
+ "type" : "string"
+ },
+ "attributes" : {
+ "type" : "string"
+ },
+ "createdOn" : {
+ "type" : "string"
+ },
+ "deny_token_document" : {
+ "type" : "string"
+ },
+ "deny_token_parent" : {
+ "type" : "string"
+ },
+ "deny_token_share" : {
+ "type" : "string"
+ },
+ "lastModified" : {
+ "type" : "string"
+ },
+ "shareName" : {
+ "type" : "string"
+ },
+ "file" : {
+ "type" : "attachment",
+ "path" : "full",
+ "fields" : {
+ "file" : {
+ "store" : true,
+ "term_vector" : "with_positions_offsets",
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+}'
+ </source>
+ <p>This command creates an index called <code>manifoldcf</code> with a mapping named <code>attachment</code>
+ which has some generic fields for access tokens and a field <code>file</code> which makes use of the
+ ElasticSearch attachment mapper plugin. It is configured for highlighting (<code>"term_vector" : "with_positions_offsets"</code>).</p>
+ <p>The following part is useful for not saving the source json on the index which reduces the index size significantly. Be
+ aware that you shouldn't do this if you will need to re-index data on the ElasticSearch side or you need access to the
+ whole document:</p>
+ <source>
+"_source" : {
+ "excludes" : [ "file" ]
+},
+ </source>
</section>
</section>
Modified: manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/included-connectors.xml
URL: http://svn.apache.org/viewvc/manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/included-connectors.xml?rev=1634028&r1=1634027&r2=1634028&view=diff
==============================================================================
--- manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/included-connectors.xml (original)
+++ manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/included-connectors.xml Fri Oct 24 08:48:07 2014
@@ -50,7 +50,7 @@
<tr><td>LiveLink (OpenText)</td><td> Pure Java </td><td> Win </td><td> LAPI 9.7.1, 10.2.0 </td><td> Tested with 9.2.0 - 10.2.0 </td></tr>
<tr><td>Solr</td><td> Pure Java </td><td> N/A </td><td> N/A</td><td> Tested with Solr 1.4, 3.6.2, 4.0.0, 4.1.0, 4.2.0, 4.3.0, 4.5.1 </td></tr>
<tr><td>OpenSearchServer</td><td> Pure Java </td><td> N/A </td><td> N/A</td><td> Tested with OpenSearchServer 1.2.1, 1.2.2, 1.2.3, 1.3, 1.4, 1.5.x </td></tr>
- <tr><td>ElasticSearch</td><td> Pure Java </td><td> N/A </td><td> N/A</td><td> Tested with ElasticSearch 0.18.3, 0.18.4, 0.18.5, 0.18.6, 0.18.7 </td></tr>
+ <tr><td>ElasticSearch</td><td> Pure Java </td><td> N/A </td><td> N/A</td><td> Tested with ElasticSearch 1.0, 1.1, 1.2, 1.3 </td></tr>
<tr><td>Documentum (EMC)</td><td> Win, RedHat </td><td> Win, RedHat </td><td> Tested with DFC 5.3 SP5 </td><td> Tested against 5.3, 6.0, and 6.5 servers </td></tr>
<tr><td>SharePoint (MSFT)</td><td>Pure Java </td><td>Win</td><td> N/A </td><td> Tested with SharePoint 2003 (2.0), 2007 (3.0), 2010 (4.0), 2013 (5.0)</td></tr>
<tr><td>Meridio (Autonomy)</td><td> Pure Java </td><td> Win </td><td> N/A </td><td> Tested with Meridio 4.1, 5.0 </td></tr>
Modified: manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml
URL: http://svn.apache.org/viewvc/manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml?rev=1634028&r1=1634027&r2=1634028&view=diff
==============================================================================
--- manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml (original)
+++ manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml Fri Oct 24 08:48:07 2014
@@ -301,6 +301,74 @@
<p><strong>If the proper version of the plugin is not deployed and properly integrated, documents will not be properly secured.</strong> Thus, it is essential to verify that the
proper plugin version has been deployed for the version of ManifoldCF you are using.</p>
+ <p>To work with ManifoldCF, your ElasticSearch instance must also include the appropriate indexes created as well.
+ Here are some simple steps for creating an ElasticSearch index, using the CURL utility:</p>
+ <p></p>
+ <source>
+% curl -XPUT 'http://localhost:9200/manifoldcf'
+% curl -XPUT 'http://localhost:9200/manifoldcf/attachment/_mapping' -d '
+{
+ "attachment" : {
+ "_source" : {
+ "excludes" : [ "file" ]
+ },
+ "properties": {
+ "allow_token_document" : {
+ "type" : "string"
+ },
+ "allow_token_parent" : {
+ "type" : "string"
+ },
+ "allow_token_share" : {
+ "type" : "string"
+ },
+ "attributes" : {
+ "type" : "string"
+ },
+ "createdOn" : {
+ "type" : "string"
+ },
+ "deny_token_document" : {
+ "type" : "string"
+ },
+ "deny_token_parent" : {
+ "type" : "string"
+ },
+ "deny_token_share" : {
+ "type" : "string"
+ },
+ "lastModified" : {
+ "type" : "string"
+ },
+ "shareName" : {
+ "type" : "string"
+ },
+ "file" : {
+ "type" : "attachment",
+ "path" : "full",
+ "fields" : {
+ "file" : {
+ "store" : true,
+ "term_vector" : "with_positions_offsets",
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+}'
+ </source>
+ <p>This command creates an index called <code>manifoldcf</code> with a mapping named <code>attachment</code>
+ which has some generic fields for access tokens and a field <code>file</code> which makes use of the
+ ElasticSearch attachment mapper plugin. It is configured for highlighting (<code>"term_vector" : "with_positions_offsets"</code>).</p>
+ <p>The following part is useful for not saving the source json on the index which reduces the index size significantly. Be
+ aware that you shouldn't do this if you will need to re-index data on the ElasticSearch side or you need access to the
+ whole document:</p>
+ <source>
+"_source" : {
+ "excludes" : [ "file" ]
+},
+ </source>
</section>
</section>
Modified: manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/included-connectors.xml
URL: http://svn.apache.org/viewvc/manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/included-connectors.xml?rev=1634028&r1=1634027&r2=1634028&view=diff
==============================================================================
--- manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/included-connectors.xml (original)
+++ manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/included-connectors.xml Fri Oct 24 08:48:07 2014
@@ -49,7 +49,7 @@
<tr><td>LiveLink (OpenText)</td><td>Java </td><td> Win </td><td> LAPI 9.7.1 </td><td>9.2.0 - 10.2.0ã§æ¤è¨¼æ¸ã¿</td></tr>
<tr><td>Solr</td><td>Java </td><td> N/A </td><td> N/A</td><td>Solr 1.4, 3.6.2, 4.0.0, 4.1.0, 4.2.0, 4.3.0ã§æ¤è¨¼æ¸ã¿</td></tr>
<tr><td>OpenSearchServer</td><td>Java </td><td> N/A </td><td> N/A</td><td>OpenSearchServer 1.2.1, 1.2.2, 1.2.3ã§æ¤è¨¼æ¸ã¿</td></tr>
- <tr><td>ElasticSearch</td><td>Java </td><td> N/A </td><td> N/A</td><td>ElasticSearch 0.18.3, 0.18.4, 0.18.5, 0.18.6, 0.18.7ã§æ¤è¨¼æ¸ã¿</td></tr>
+ <tr><td>ElasticSearch</td><td>Java </td><td> N/A </td><td> N/A</td><td>ElasticSearch 1.0, 1.1, 1.2, 1.3ã§æ¤è¨¼æ¸ã¿</td></tr>
<tr><td>Documentum (EMC)</td><td>Win, RedHat</td><td> Win, RedHat </td><td>DFC 5.3 SP5ã§æ¤è¨¼æ¸ã¿</td><td>5.3, 6.0, and 6.5ãµã¼ãã§æ¤è¨¼æ¸ã¿</td></tr>
<tr><td>SharePoint (MSFT)</td><td>Java </td><td>Win</td><td> N/A </td><td>SharePoint 2003 (2.0), 2007 (3.0)ã§æ¤è¨¼æ¸ã¿, Claim Space Authãªãæ¤è¨¼2010 (4.0)</td></tr>
<tr><td>Meridio (Autonomy)</td><td>Java </td><td> Win </td><td> N/A </td><td>Meridio 4.1, 5.0ã§æ¤è¨¼æ¸ã¿</td></tr>
Modified: manifoldcf/trunk/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml
URL: http://svn.apache.org/viewvc/manifoldcf/trunk/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml?rev=1634028&r1=1634027&r2=1634028&view=diff
==============================================================================
--- manifoldcf/trunk/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml (original)
+++ manifoldcf/trunk/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml Fri Oct 24 08:48:07 2014
@@ -301,6 +301,74 @@
<p><strong>If the proper version of the plugin is not deployed and properly integrated, documents will not be properly secured.</strong> Thus, it is essential to verify that the
proper plugin version has been deployed for the version of ManifoldCF you are using.</p>
+ <p>To work with ManifoldCF, your ElasticSearch instance must also include the appropriate indexes created as well.
+ Here are some simple steps for creating an ElasticSearch index, using the CURL utility:</p>
+ <p></p>
+ <source>
+% curl -XPUT 'http://localhost:9200/manifoldcf'
+% curl -XPUT 'http://localhost:9200/manifoldcf/attachment/_mapping' -d '
+{
+ "attachment" : {
+ "_source" : {
+ "excludes" : [ "file" ]
+ },
+ "properties": {
+ "allow_token_document" : {
+ "type" : "string"
+ },
+ "allow_token_parent" : {
+ "type" : "string"
+ },
+ "allow_token_share" : {
+ "type" : "string"
+ },
+ "attributes" : {
+ "type" : "string"
+ },
+ "createdOn" : {
+ "type" : "string"
+ },
+ "deny_token_document" : {
+ "type" : "string"
+ },
+ "deny_token_parent" : {
+ "type" : "string"
+ },
+ "deny_token_share" : {
+ "type" : "string"
+ },
+ "lastModified" : {
+ "type" : "string"
+ },
+ "shareName" : {
+ "type" : "string"
+ },
+ "file" : {
+ "type" : "attachment",
+ "path" : "full",
+ "fields" : {
+ "file" : {
+ "store" : true,
+ "term_vector" : "with_positions_offsets",
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+}'
+ </source>
+ <p>This command creates an index called <code>manifoldcf</code> with a mapping named <code>attachment</code>
+ which has some generic fields for access tokens and a field <code>file</code> which makes use of the
+ ElasticSearch attachment mapper plugin. It is configured for highlighting (<code>"term_vector" : "with_positions_offsets"</code>).</p>
+ <p>The following part is useful for not saving the source json on the index which reduces the index size significantly. Be
+ aware that you shouldn't do this if you will need to re-index data on the ElasticSearch side or you need access to the
+ whole document:</p>
+ <source>
+"_source" : {
+ "excludes" : [ "file" ]
+},
+ </source>
</section>
</section>
Modified: manifoldcf/trunk/site/src/documentation/content/xdocs/zh_CN/included-connectors.xml
URL: http://svn.apache.org/viewvc/manifoldcf/trunk/site/src/documentation/content/xdocs/zh_CN/included-connectors.xml?rev=1634028&r1=1634027&r2=1634028&view=diff
==============================================================================
--- manifoldcf/trunk/site/src/documentation/content/xdocs/zh_CN/included-connectors.xml (original)
+++ manifoldcf/trunk/site/src/documentation/content/xdocs/zh_CN/included-connectors.xml Fri Oct 24 08:48:07 2014
@@ -49,7 +49,7 @@
<tr><td>LiveLink (OpenText)</td><td>Java </td><td> Win </td><td> LAPI 9.7.1 </td><td>9.2.0 - 10.2.0éè¿éªè¯</td></tr>
<tr><td>Solr</td><td>Java </td><td> N/A </td><td> N/A</td><td>Solr 1.4, 3.6.2, 4.0.0, 4.1.0, 4.2.0, 4.3.0éè¿éªè¯</td></tr>
<tr><td>OpenSearchServer</td><td>Java </td><td> N/A </td><td> N/A</td><td>OpenSearchServer 1.2.1, 1.2.2, 1.2.3éè¿éªè¯</td></tr>
- <tr><td>ElasticSearch</td><td>Java </td><td> N/A </td><td> N/A</td><td>ElasticSearch 0.18.3, 0.18.4, 0.18.5, 0.18.6, 0.18.7éè¿éªè¯</td></tr>
+ <tr><td>ElasticSearch</td><td>Java </td><td> N/A </td><td> N/A</td><td>ElasticSearch 1.0, 1.1, 1.2, 1.3éè¿éªè¯</td></tr>
<tr><td>Documentum (EMC)</td><td>Win, RedHat</td><td> Win, RedHat </td><td>DFC 5.3 SP5éè¿éªè¯</td><td>5.3, 6.0å6.5æå¡å¨éè¿éªè¯</td></tr>
<tr><td>SharePoint (MSFT)</td><td>Java </td><td>Win</td><td> N/A </td><td>SharePoint 2003 (2.0), 2007 (3.0)éè¿éªè¯, æ Claim Space Authæ¡ä»¶ä¸éªè¯2010 (4.0)</td></tr>
<tr><td>Meridio (Autonomy)</td><td>Java </td><td> Win </td><td> N/A </td><td>Meridio 4.1, 5.0éè¿éªè¯</td></tr>