manifoldcf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kwri...@apache.org
Subject svn commit: r943555 - in /incubator/lcf/site: publish/ publish/images/ src/documentation/content/xdocs/
Date Wed, 12 May 2010 15:31:23 GMT
Author: kwright
Date: Wed May 12 15:31:22 2010
New Revision: 943555

URL: http://svn.apache.org/viewvc?rev=943555&view=rev
Log:
Add Memex authority documentation.

Added:
    incubator/lcf/site/publish/images/memex-authority-memex-server.PNG   (with props)
    incubator/lcf/site/publish/images/memex-authority-status.PNG   (with props)
    incubator/lcf/site/publish/images/memex-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=943555&r1=943554&r2=943555&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=943555&r1=943554&r2=943555&view=diff
==============================================================================
--- incubator/lcf/site/publish/end-user-documentation.html (original)
+++ incubator/lcf/site/publish/end-user-documentation.html Wed May 12 15:31:22 2010
@@ -945,7 +945,8 @@ document.write("Last Published: " + docu
 <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 ("("
+<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 LiveLink 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>
@@ -1011,8 +1012,42 @@ document.write("Last Published: " + docu
                     problems that are displayed.</p>
 <a name="N104CA"></a><a name="memexauthority"></a>
 <h3 class="h4">Memex Patriarch Authority Connection</h3>
-<p>More here later</p>
-<a name="N104D4"></a><a name="meridioauthority"></a>
+<p>A Memex authority connection is required for enforcing security for documents retrieved
from Memex repositories.</p>
+<p>This connection type needs to be provided with information about what Memex Server
to connect to, and what user mapping to perform.
+                    Also needed are the Memex credentials that should be used to retrieve
a user's permissions from the Memex server.</p>
+<p>A Memex authority connection has the following special tabs you will need to configure:
the "Memex Server" tab, and the "User Mapping" tab.  The "Memex Server" tab looks like this:</p>
+<br>
+<br>
+<div id="" style="text-align: center;">
+<img id="" class="figure" alt="Memex Authority, Memex Server tab" src="images/memex-authority-memex-server.PNG"
width="80%"></div>
+<br>
+<br>
+<p>You must supply the name of your Memex server, and the connection port, along with
the Memex credentials for a user that has sufficient permissions to retrieve Memex user
+                    information.  You must also select the Memex server's character encoding.
 If you do not know the encoding, consult your Memex system administrator.</p>
+<p>The "User Mapping" tab looks like this:</p>
+<br>
+<br>
+<div id="" style="text-align: center;">
+<img id="" class="figure" alt="Memex Authority, User Mapping tab" src="images/memex-authority-user-mapping.PNG"
width="80%"></div>
+<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 Memex 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 <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 Memex 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="Memex Authority Status" src="images/memex-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 Memex server has a license error, which
+                    is leading to an error status message instead of "Connection working".</p>
+<a name="N10519"></a><a name="meridioauthority"></a>
 <h3 class="h4">Autonomy Meridio Authority Connection</h3>
 <p>A Meridio authority connection is required for enforcing security for documents
retrieved from Meridio repositories.</p>
 <p>This connection type needs to be provided with information about what Document Server
to connect to, what Records Server to connect to, and what User Service Server
@@ -1081,10 +1116,10 @@ document.write("Last Published: " + docu
 </div>
         
         
-<a name="N1054B"></a><a name="repositoryconnectiontypes"></a>
+<a name="N10590"></a><a name="repositoryconnectiontypes"></a>
 <h2 class="h3">Repository Connection Types</h2>
 <div class="section">
-<a name="N10551"></a><a name="filesystemrepository"></a>
+<a name="N10596"></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
@@ -1123,7 +1158,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="N10589"></a><a name="rssrepository"></a>
+<a name="N105CE"></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>
@@ -1336,7 +1371,7 @@ document.write("Last Published: " + docu
 <br>
 <br>
 <p>Select the mode you want the connection to operate in.</p>
-<a name="N1070C"></a><a name="webrepository"></a>
+<a name="N10751"></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>
@@ -1619,7 +1654,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="N108E5"></a><a name="jcifsrepository"></a>
+<a name="N1092A"></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>
@@ -1742,7 +1777,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="N109B3"></a><a name="jdbcrepository"></a>
+<a name="N109F8"></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>
@@ -1929,10 +1964,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="N10AE5"></a><a name="filenetrepository"></a>
+<a name="N10B2A"></a><a name="filenetrepository"></a>
 <h3 class="h4">IBM FileNet P8 Repository Connection</h3>
 <p>More here later</p>
-<a name="N10AEF"></a><a name="documentumrepository"></a>
+<a name="N10B34"></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>
@@ -1987,7 +2022,7 @@ 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="N10B55"></a><a name="livelinkrepository"></a>
+<a name="N10B9A"></a><a name="livelinkrepository"></a>
 <h3 class="h4">OpenText LiveLink Repository Connection</h3>
 <p>The OpenText LiveLink connection type allows you to index content from LiveLink
repositories.  LiveLink has a rich variety of different document types and metadata, which
include
                     basic documents, as well as compound documents, folders, workspaces,
and projects.  A LiveLink connection is able to discover documents contained within all of
these constructs.</p>
@@ -2082,13 +2117,13 @@ 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="N10C04"></a><a name="mexexrepository"></a>
+<a name="N10C49"></a><a name="mexexrepository"></a>
 <h3 class="h4">Memex Patriarch Repository Connection</h3>
 <p>More here later</p>
-<a name="N10C0E"></a><a name="meridiorepository"></a>
+<a name="N10C53"></a><a name="meridiorepository"></a>
 <h3 class="h4">Autonomy Meridio Repository Connection</h3>
 <p>More here later</p>
-<a name="N10C18"></a><a name="sharepointrepository"></a>
+<a name="N10C5D"></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=943555&r1=943554&r2=943555&view=diff
==============================================================================
Files incubator/lcf/site/publish/end-user-documentation.pdf (original) and incubator/lcf/site/publish/end-user-documentation.pdf
Wed May 12 15:31:22 2010 differ

Modified: incubator/lcf/site/publish/faq.pdf
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/faq.pdf?rev=943555&r1=943554&r2=943555&view=diff
==============================================================================
Files incubator/lcf/site/publish/faq.pdf (original) and incubator/lcf/site/publish/faq.pdf
Wed May 12 15:31:22 2010 differ

Added: incubator/lcf/site/publish/images/memex-authority-memex-server.PNG
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/images/memex-authority-memex-server.PNG?rev=943555&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/lcf/site/publish/images/memex-authority-memex-server.PNG
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: incubator/lcf/site/publish/images/memex-authority-status.PNG
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/images/memex-authority-status.PNG?rev=943555&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/lcf/site/publish/images/memex-authority-status.PNG
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: incubator/lcf/site/publish/images/memex-authority-user-mapping.PNG
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/images/memex-authority-user-mapping.PNG?rev=943555&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/lcf/site/publish/images/memex-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=943555&r1=943554&r2=943555&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=943555&r1=943554&r2=943555&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=943555&r1=943554&r2=943555&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=943555&r1=943554&r2=943555&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=943555&r1=943554&r2=943555&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 Wed May
12 15:31:22 2010
@@ -511,7 +511,8 @@
                 <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 ("("
+                <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 LiveLink 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>
@@ -566,7 +567,32 @@
             
             <section id="memexauthority">
                 <title>Memex Patriarch Authority Connection</title>
-                <p>More here later</p>
+                <p>A Memex authority connection is required for enforcing security
for documents retrieved from Memex repositories.</p>
+                <p>This connection type needs to be provided with information about
what Memex Server to connect to, and what user mapping to perform.
+                    Also needed are the Memex credentials that should be used to retrieve
a user's permissions from the Memex server.</p>
+                <p>A Memex authority connection has the following special tabs you
will need to configure: the "Memex Server" tab, and the "User Mapping" tab.  The "Memex Server"
tab looks like this:</p>
+                <br/><br/>
+                <figure src="images/memex-authority-memex-server.PNG" alt="Memex Authority,
Memex Server tab" width="80%"/>
+                <br/><br/>
+                <p>You must supply the name of your Memex server, and the connection
port, along with the Memex credentials for a user that has sufficient permissions to retrieve
Memex user
+                    information.  You must also select the Memex server's character encoding.
 If you do not know the encoding, consult your Memex system administrator.</p>
+                <p>The "User Mapping" tab looks like this:</p>
+                <br/><br/>
+                <figure src="images/memex-authority-user-mapping.PNG" alt="Memex Authority,
User Mapping tab" 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 Memex 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 Memex
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/memex-authority-status.PNG" alt="Memex 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 Memex server has a license
error, which
+                    is leading to an error status message instead of "Connection working".</p>
             </section>
             
             <section id="meridioauthority">



Mime
View raw message