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 2010/05/04 20:19:37 UTC
svn commit: r940988 - in /incubator/lcf/site: publish/ publish/images/
src/documentation/content/xdocs/ src/documentation/resources/images/
Author: kwright
Date: Tue May 4 18:19:37 2010
New Revision: 940988
URL: http://svn.apache.org/viewvc?rev=940988&view=rev
Log:
Add LiveLink authority documentation.
Added:
incubator/lcf/site/publish/images/livelink-authority-server.PNG (with props)
incubator/lcf/site/publish/images/livelink-authority-status.PNG (with props)
incubator/lcf/site/publish/images/livelink-authority-user-mapping.PNG (with props)
incubator/lcf/site/src/documentation/resources/images/livelink-authority-server.PNG (with props)
incubator/lcf/site/src/documentation/resources/images/livelink-authority-status.PNG (with props)
incubator/lcf/site/src/documentation/resources/images/livelink-authority-user-mapping.PNG (with props)
Modified:
incubator/lcf/site/publish/developer-resources.pdf
incubator/lcf/site/publish/end-user-documentation.html
incubator/lcf/site/publish/end-user-documentation.pdf
incubator/lcf/site/publish/faq.pdf
incubator/lcf/site/publish/index.pdf
incubator/lcf/site/publish/linkmap.pdf
incubator/lcf/site/publish/mail.pdf
incubator/lcf/site/publish/who.pdf
incubator/lcf/site/src/documentation/content/xdocs/end-user-documentation.xml
Modified: incubator/lcf/site/publish/developer-resources.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/developer-resources.pdf?rev=940988&r1=940987&r2=940988&view=diff
==============================================================================
Binary files - no diff available.
Modified: incubator/lcf/site/publish/end-user-documentation.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/end-user-documentation.html?rev=940988&r1=940987&r2=940988&view=diff
==============================================================================
--- incubator/lcf/site/publish/end-user-documentation.html (original)
+++ incubator/lcf/site/publish/end-user-documentation.html Tue May 4 18:19:37 2010
@@ -924,12 +924,47 @@ document.write("Last Published: " + docu
<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>
<a name="N10424"></a><a name="livelinkauthority"></a>
<h3 class="h4">OpenText LiveLink Authority Connection</h3>
-<p>More here later</p>
-<a name="N1042E"></a><a name="documentumauthority"></a>
+<p>A LiveLink authority connection is needed to enforce security for documents retrieved from LiveLink repositories.</p>
+<p>In order to function, this connection type needs to be provided with
+ information about the name of the LiveLink server, and credentials appropriate for retrieving a user's ACLs from that machine. Since LiveLink operates with its own list of users, you
+ may also want to specify a rule-based mapping between an Active Directory user and the corresponding LiveLink user. The authority type allows you to specify such a mapping using
+ regular expressions.</p>
+<p>A LiveLink authority connection has two special tabs you will need to configure: the "Server" tab, and the "User Mapping" tab.</p>
+<p>The "Server" tab looks like this:</p>
+<br>
+<br>
+<div id="" style="text-align: center;">
+<img id="" class="figure" alt="LiveLink Authority, Server tab" src="images/livelink-authority-server.PNG" width="80%"></div>
+<br>
+<br>
+<p>Enter the name of the desired LiveLink server, the LiveLink port, and the LiveLink credentials.</p>
+<p>The "User Mapping" tab looks like this:</p>
+<br>
+<br>
+<div id="" style="text-align: center;">
+<img id="" class="figure" alt="LiveLink Authority, User Mapping tab" src="images/livelink-authority-user-mapping.PNG" width="80%"></div>
+<br>
+<br>
+<p>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 <span class="codefrag">^(.*)\@([A-Z|a-z|0-9|_|-]*)\.(.*)$</span> with a replace string of <span class="codefrag">$(2)\$(1l)</span> would convert an AD username of
+ <span class="codefrag">MyUserName@subdomain.domain.com</span> into the LiveLink user name <span class="codefrag">subdomain\myusername</span>.</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>
+<div id="" style="text-align: center;">
+<img id="" class="figure" alt="LiveLink Authority Status" src="images/livelink-authority-status.PNG" width="80%"></div>
+<br>
+<br>
+<p>We suggest that you examine the status carefully and correct any reported errors before proceeding. Note that in this example, the LiveLink server would not accept connections, which
+ is leading to an error status message instead of "Connection working".</p>
+<a name="N10476"></a><a name="documentumauthority"></a>
<h3 class="h4">EMC Documentum Authority Connection</h3>
-<p>A Documentum authority connection is required for enforcing security for documents retrieved from Documentum repositories.
- This connection type needs to be provided with information about what Content Server to connect to, and the credentials that should be used to retrieve a user's ACLs from that machine.</p>
-<p>In addition, you can also specify whether or not you wish to include auto-generated ACLs in every user's list. Auto-generated ACLs are created within Documentum for every folder
+<p>A Documentum authority connection is required for enforcing security for documents retrieved from Documentum repositories.</p>
+<p>This connection type needs to be provided with information about what Content Server to connect to, and the credentials that should be used to retrieve a user's ACLs from that machine.
+ In addition, you can also specify whether or not you wish to include auto-generated ACLs in every user's list. Auto-generated ACLs are created within Documentum for every folder
object. Because there are often a very large number of folders, including these ACLs can bloat the number of LCF access tokens returned for a user to tens of thousands, which can negatively
impact perfomance. Even more notably, few Documentum installations make any real use of these ACLs in any way. Since Documentum's ACLs are purely additive (that is, there are no
mechanisms for 'deny' semantics), the impact of a missing ACLs is only to block a user from seeing something they otherwise could see. It is thus safe, and often desirable, to simply ignore the
@@ -974,19 +1009,19 @@ document.write("Last Published: " + docu
<br>
<p>Pay careful attention to the status, and be prepared to correct any
problems that are displayed.</p>
-<a name="N10482"></a><a name="memexauthority"></a>
+<a name="N104CA"></a><a name="memexauthority"></a>
<h3 class="h4">Memex Patriarch Authority Connection</h3>
<p>More here later</p>
-<a name="N1048C"></a><a name="meridioauthority"></a>
+<a name="N104D4"></a><a name="meridioauthority"></a>
<h3 class="h4">Autonomy Meridio Authority Connection</h3>
<p>More here later</p>
</div>
-<a name="N10497"></a><a name="repositoryconnectiontypes"></a>
+<a name="N104DF"></a><a name="repositoryconnectiontypes"></a>
<h2 class="h3">Repository Connection Types</h2>
<div class="section">
-<a name="N1049D"></a><a name="filesystemrepository"></a>
+<a name="N104E5"></a><a name="filesystemrepository"></a>
<h3 class="h4">Generic File System Repository Connection</h3>
<p>The generic file system repository connection type was developed primarily as an example, demonstration, and testing tool, although it can potentially be useful for indexing local
files that exist on the same machine that Lucene Connectors Framework is running on. Bear in mind that there is no support in this connection type for any kind of
@@ -1025,7 +1060,7 @@ document.write("Last Published: " + docu
may then add rules to it. Each rule has a match expression, an indication of whether the rule is intended to match files or directories, and an action (include or exclude).
Rules are evaluated from top to bottom, and the first rule that matches the file name is the one that is chosen. To add a rule, select the desired pulldowns, type in
a match file specification (e.g. "*.txt"), and click the "Add" button.</p>
-<a name="N104D5"></a><a name="rssrepository"></a>
+<a name="N1051D"></a><a name="rssrepository"></a>
<h3 class="h4">Generic RSS Repository Connection</h3>
<p>The RSS connection type is specifically designed to crawl RSS feeds. While the Web connection type can also extract links from RSS feeds, the RSS connection type
differs in the following ways:</p>
@@ -1237,7 +1272,7 @@ document.write("Last Published: " + docu
<br>
<br>
<p>Select the mode you want the connection to operate in.</p>
-<a name="N10656"></a><a name="webrepository"></a>
+<a name="N1069E"></a><a name="webrepository"></a>
<h3 class="h4">Generic Web Repository Connection</h3>
<p>The Web connection type is effectively a reasonably full-featured web crawler. It is capable of handling most kinds of authentication (basic, all forms of NTLM,
and session-based), and can extract links from the following kinds of documents:</p>
@@ -1519,7 +1554,7 @@ document.write("Last Published: " + docu
<br>
<br>
<p>Enter the name of the desired metadata on the left, and the desired value (if any) on the right, and click the "Add" button.</p>
-<a name="N1082D"></a><a name="jcifsrepository"></a>
+<a name="N10875"></a><a name="jcifsrepository"></a>
<h3 class="h4">Windows Share/DFS Repository Connection</h3>
<p>The Windows Share connection type allows you to access content stored on Windows shares, even from non-Windows systems. Also supported are Samba and various
third-party Network Attached Storage servers.</p>
@@ -1641,7 +1676,7 @@ document.write("Last Published: " + docu
<p>The mappings specified here are similar in all respects to the path attribute mapping setup described above. If no mappings are present, the file path is converted
to a canonical file IRI. If mappings are present, the conversion is presumed to produce a valid URL, which can be used to access the document via some
variety of Windows Share http server.</p>
-<a name="N108F9"></a><a name="jdbcrepository"></a>
+<a name="N10941"></a><a name="jdbcrepository"></a>
<h3 class="h4">Generic Database Repository Connection</h3>
<p>The generic database connection type allows you to index content from a database table, served by one of the following databases:</p>
<br>
@@ -1827,10 +1862,10 @@ document.write("Last Published: " + docu
<br>
<br>
<p>Enter a desired access token, and click the "Add" button. You may enter multiple access tokens.</p>
-<a name="N10A29"></a><a name="filenetrepository"></a>
+<a name="N10A71"></a><a name="filenetrepository"></a>
<h3 class="h4">IBM FileNet P8 Repository Connection</h3>
<p>More here later</p>
-<a name="N10A33"></a><a name="documentumrepository"></a>
+<a name="N10A7B"></a><a name="documentumrepository"></a>
<h3 class="h4">EMC Documentum Repository Connection</h3>
<p>The EMC Documentum connection type allows you index content from a Documentum Content Server instance. A single connection allows you
to reach all documents contained on a single Content Server instance. Multiple connections are therefore required to reach documents from multiple Content Server instances.</p>
@@ -1884,16 +1919,16 @@ document.write("Last Published: " + docu
<p>For example, suppose you had a rule which had ".*/(.*)/(.*)/.*" as a match expression, and "$(1) $(2)" as the replace string. If presented with the path
<span class="codefrag">Project/Folder_1/Folder_2/Filename</span>, it would output the string <span class="codefrag">Folder_1 Folder_2</span>.</p>
<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>
-<a name="N10A97"></a><a name="livelinkrepository"></a>
+<a name="N10ADF"></a><a name="livelinkrepository"></a>
<h3 class="h4">OpenText LiveLink Repository Connection</h3>
<p>More here later</p>
-<a name="N10AA1"></a><a name="mexexrepository"></a>
+<a name="N10AE9"></a><a name="mexexrepository"></a>
<h3 class="h4">Memex Patriarch Repository Connection</h3>
<p>More here later</p>
-<a name="N10AAB"></a><a name="meridiorepository"></a>
+<a name="N10AF3"></a><a name="meridiorepository"></a>
<h3 class="h4">Autonomy Meridio Repository Connection</h3>
<p>More here later</p>
-<a name="N10AB5"></a><a name="sharepointrepository"></a>
+<a name="N10AFD"></a><a name="sharepointrepository"></a>
<h3 class="h4">Microsoft SharePoint Repository Connection</h3>
<p>The Microsoft SharePoint connection type allows you to index documents from a Microsoft SharePoint site. Bear in mind that a single SharePoint installation actually represents
a set of sites. Some sites
Modified: incubator/lcf/site/publish/end-user-documentation.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/end-user-documentation.pdf?rev=940988&r1=940987&r2=940988&view=diff
==============================================================================
Files incubator/lcf/site/publish/end-user-documentation.pdf (original) and incubator/lcf/site/publish/end-user-documentation.pdf Tue May 4 18:19:37 2010 differ
Modified: incubator/lcf/site/publish/faq.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/faq.pdf?rev=940988&r1=940987&r2=940988&view=diff
==============================================================================
Files incubator/lcf/site/publish/faq.pdf (original) and incubator/lcf/site/publish/faq.pdf Tue May 4 18:19:37 2010 differ
Added: incubator/lcf/site/publish/images/livelink-authority-server.PNG
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/images/livelink-authority-server.PNG?rev=940988&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/lcf/site/publish/images/livelink-authority-server.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/lcf/site/publish/images/livelink-authority-status.PNG
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/images/livelink-authority-status.PNG?rev=940988&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/lcf/site/publish/images/livelink-authority-status.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/lcf/site/publish/images/livelink-authority-user-mapping.PNG
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/images/livelink-authority-user-mapping.PNG?rev=940988&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/lcf/site/publish/images/livelink-authority-user-mapping.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: incubator/lcf/site/publish/index.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/index.pdf?rev=940988&r1=940987&r2=940988&view=diff
==============================================================================
Binary files - no diff available.
Modified: incubator/lcf/site/publish/linkmap.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/linkmap.pdf?rev=940988&r1=940987&r2=940988&view=diff
==============================================================================
Binary files - no diff available.
Modified: incubator/lcf/site/publish/mail.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/mail.pdf?rev=940988&r1=940987&r2=940988&view=diff
==============================================================================
Binary files - no diff available.
Modified: incubator/lcf/site/publish/who.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/who.pdf?rev=940988&r1=940987&r2=940988&view=diff
==============================================================================
Binary files - no diff available.
Modified: incubator/lcf/site/src/documentation/content/xdocs/end-user-documentation.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/site/src/documentation/content/xdocs/end-user-documentation.xml?rev=940988&r1=940987&r2=940988&view=diff
==============================================================================
--- incubator/lcf/site/src/documentation/content/xdocs/end-user-documentation.xml (original)
+++ incubator/lcf/site/src/documentation/content/xdocs/end-user-documentation.xml Tue May 4 18:19:37 2010
@@ -496,14 +496,40 @@
<section id="livelinkauthority">
<title>OpenText LiveLink Authority Connection</title>
- <p>More here later</p>
+ <p>A LiveLink authority connection is needed to enforce security for documents retrieved from LiveLink repositories.</p>
+ <p>In order to function, this connection type needs to be provided with
+ information about the name of the LiveLink server, and credentials appropriate for retrieving a user's ACLs from that machine. Since LiveLink operates with its own list of users, you
+ may also want to specify a rule-based mapping between an Active Directory user and the corresponding LiveLink user. The authority type allows you to specify such a mapping using
+ regular expressions.</p>
+ <p>A LiveLink authority connection has two special tabs you will need to configure: the "Server" tab, and the "User Mapping" tab.</p>
+ <p>The "Server" tab looks like this:</p>
+ <br/><br/>
+ <figure src="images/livelink-authority-server.PNG" alt="LiveLink Authority, Server tab" width="80%"/>
+ <br/><br/>
+ <p>Enter the name of the desired LiveLink server, the LiveLink port, and the LiveLink credentials.</p>
+ <p>The "User Mapping" tab looks like this:</p>
+ <br/><br/>
+ <figure src="images/livelink-authority-user-mapping.PNG" alt="LiveLink Authority, User Mapping tab" width="80%"/>
+ <br/><br/>
+ <p>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/livelink-authority-status.PNG" alt="LiveLink Authority Status" width="80%"/>
+ <br/><br/>
+ <p>We suggest that you examine the status carefully and correct any reported errors before proceeding. Note that in this example, the LiveLink server would not accept connections, which
+ is leading to an error status message instead of "Connection working".</p>
</section>
<section id="documentumauthority">
<title>EMC Documentum Authority Connection</title>
- <p>A Documentum authority connection is required for enforcing security for documents retrieved from Documentum repositories.
- This connection type needs to be provided with information about what Content Server to connect to, and the credentials that should be used to retrieve a user's ACLs from that machine.</p>
- <p>In addition, you can also specify whether or not you wish to include auto-generated ACLs in every user's list. Auto-generated ACLs are created within Documentum for every folder
+ <p>A Documentum authority connection is required for enforcing security for documents retrieved from Documentum repositories.</p>
+ <p>This connection type needs to be provided with information about what Content Server to connect to, and the credentials that should be used to retrieve a user's ACLs from that machine.
+ In addition, you can also specify whether or not you wish to include auto-generated ACLs in every user's list. Auto-generated ACLs are created within Documentum for every folder
object. Because there are often a very large number of folders, including these ACLs can bloat the number of LCF access tokens returned for a user to tens of thousands, which can negatively
impact perfomance. Even more notably, few Documentum installations make any real use of these ACLs in any way. Since Documentum's ACLs are purely additive (that is, there are no
mechanisms for 'deny' semantics), the impact of a missing ACLs is only to block a user from seeing something they otherwise could see. It is thus safe, and often desirable, to simply ignore the
Added: incubator/lcf/site/src/documentation/resources/images/livelink-authority-server.PNG
URL: http://svn.apache.org/viewvc/incubator/lcf/site/src/documentation/resources/images/livelink-authority-server.PNG?rev=940988&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/lcf/site/src/documentation/resources/images/livelink-authority-server.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/lcf/site/src/documentation/resources/images/livelink-authority-status.PNG
URL: http://svn.apache.org/viewvc/incubator/lcf/site/src/documentation/resources/images/livelink-authority-status.PNG?rev=940988&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/lcf/site/src/documentation/resources/images/livelink-authority-status.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/lcf/site/src/documentation/resources/images/livelink-authority-user-mapping.PNG
URL: http://svn.apache.org/viewvc/incubator/lcf/site/src/documentation/resources/images/livelink-authority-user-mapping.PNG?rev=940988&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/lcf/site/src/documentation/resources/images/livelink-authority-user-mapping.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream