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 2013/03/21 22:37:32 UTC
svn commit: r1459538 [31/32] - in /manifoldcf/site/publish: ./ en_US/ ja_JP/
release/trunk/ release/trunk/api/activedirectory/
release/trunk/api/activedirectory/org/apache/manifoldcf/authorities/authorities/activedirectory/
release/trunk/api/alfresco/ ...
Modified: manifoldcf/site/publish/release/trunk/en_US/end-user-documentation.html
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/end-user-documentation.html?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
--- manifoldcf/site/publish/release/trunk/en_US/end-user-documentation.html (original)
+++ manifoldcf/site/publish/release/trunk/en_US/end-user-documentation.html Thu Mar 21 21:37:09 2013
@@ -642,6 +642,8 @@ document.write("Last Published: " + docu
<li>Start (start the job)</li>
+<li>Start minimal (start the job, but do only the minimal work possible)</li>
+
<li>Abort(abort the job)</li>
<li>Pause (pause the job)</li>
@@ -649,13 +651,18 @@ document.write("Last Published: " + docu
<li>Resume (resume the job)</li>
<li>Restart (equivalent to aborting the job, and starting it all over again)</li>
+
+<li>Restart minimal (equivalent to aborting the job, and starting it all over again, doing only the minimal work possible)</li>
</ul>
<br>
<p>The columns "Documents", "Active", and "Processed" have very specific means as far as documents in the job's queue are concerned. The "Documents" column counts all the documents
that belong to the job. The "Active" column counts all of the documents for that job that are queued up for processing. The "Processed" column counts all documents that are on the
queue for the job that have been processed at least once in the past.</p>
-<a name="N1024F"></a><a name="statusreports"></a>
+<p>Using the "minimal" variant of the listed actions will perform the minimum possible amount of work, given the model that the connection type for the job uses. In some
+ cases, this will mean that additions and modifications are indexed, but deletions are not detected. A complete job run is usually necessary to fully synchronize the target
+ index with the repository contents.</p>
+<a name="N10258"></a><a name="statusreports"></a>
<h3 class="h4">Status Reports</h3>
<p>Every job in ManifoldCF describes a set of documents. A reference to each document in the set is kept in a job-specific queue. It is sometimes valuable for
diagnostic reasons to examine this queue for information. The Framework UI has several canned reports which do just that.</p>
@@ -671,7 +678,7 @@ document.write("Last Published: " + docu
<li>When the document is scheduled to be processed next</li>
</ul>
-<a name="N1026A"></a><a name="documentstatus"></a>
+<a name="N10273"></a><a name="documentstatus"></a>
<h4>Document Status</h4>
<p>A document status report simply lists all matching documents from within the queue, along with their state, status, and planned future activity. You might use this report if you were
trying to figure out (for example) whether a specific document had been processed yet during a job run.</p>
@@ -699,7 +706,7 @@ document.write("Last Published: " + docu
<br>
<p>You may alter the criteria, and click "Go" again, if you so choose. Or, you can alter the number of result rows displayed at a time, and click "Go" to redisplay. Finally, you can page
up and down through the results using the "Prev" and "Next" links.</p>
-<a name="N102A1"></a><a name="queuestatus"></a>
+<a name="N102AA"></a><a name="queuestatus"></a>
<h4>Queue Status</h4>
<p>A queue status report is an aggregate report that counts the number of occurrences of documents in specified classes. The classes are specified as a grouping within a regular
expression, which is matched against all specified document identifiers. The results that are displayed are counts of documents. There will be a column for each combination of
@@ -731,7 +738,7 @@ document.write("Last Published: " + docu
<br>
<p>You may alter the criteria, and click "Go" again, if you so choose. Or, you can alter the number of result rows displayed at a time, and click "Go" to redisplay. Finally, you can page
up and down through the results using the "Prev" and "Next" links.</p>
-<a name="N102DC"></a><a name="historyreports"></a>
+<a name="N102E5"></a><a name="historyreports"></a>
<h3 class="h4">History Reports</h3>
<p>For every repository connection, ManifoldCF keeps a history of what has taken place involving that connection. This history includes both events that the
framework itself logs, as well as events that a repository connection or output connection will log. These individual events are categorized by "activity type". Some of the kinds of
@@ -768,7 +775,7 @@ document.write("Last Published: " + docu
</ul>
<p>The actual reports available are designed to be useful for diagnosing both access issues, and performance issues. See below for a summary of the types available.</p>
-<a name="N10315"></a><a name="simplehistory"></a>
+<a name="N1031E"></a><a name="simplehistory"></a>
<h4>Simple History Reports</h4>
<p>As the name suggests, a simple history report does not attempt to aggregate any data, but instead just lists matching records from the repository connection's history.
These records are initially presented in most-recent-first order, and include columns for the start and end time of the event, the kind of activity represented by the event,
@@ -801,16 +808,16 @@ document.write("Last Published: " + docu
up and down through the results using the "Prev" and "Next" links.</p>
<p>Please bear in mind that the report redisplays whatever matches each time you click "Go". So, if your time interval goes from an hour beforehand to "now", and you have activity
happening, you will see different results each time "Go" is clicked.</p>
-<a name="N10352"></a><a name="maxactivity"></a>
+<a name="N1035B"></a><a name="maxactivity"></a>
<h4>Maximum Activity Reports</h4>
<p>A maximum activity report is an aggregate report used primarily to display the maximum rate that events occur within a specified time interval. MHL</p>
-<a name="N1035C"></a><a name="maxbandwidth"></a>
+<a name="N10365"></a><a name="maxbandwidth"></a>
<h4>Maximum Bandwidth Reports</h4>
<p>A maximum bandwidth report is an aggregate report used primarily to display the maximum byte rate that pertains to events occurring within a specified time interval. MHL</p>
-<a name="N10366"></a><a name="resulthistogram"></a>
+<a name="N1036F"></a><a name="resulthistogram"></a>
<h4>Result Histogram Reports</h4>
<p>A result histogram report is an aggregate report is used to count the occurrences of each kind of matching result for all matching events. MHL</p>
-<a name="N10371"></a><a name="credentials"></a>
+<a name="N1037A"></a><a name="credentials"></a>
<h3 class="h4">A Note About Credentials</h3>
<p>If any of your selected connection types require credentials, you may find it necessary to approach your system administrator to obtain an appropriate set. System administrators
are often reluctant to provide accounts and credentials that have any more power than is utterly necessary, and sometimes not even that. Great care has been taken in the
@@ -820,10 +827,10 @@ document.write("Last Published: " + docu
</div>
-<a name="N1037C"></a><a name="outputconnectiontypes"></a>
+<a name="N10385"></a><a name="outputconnectiontypes"></a>
<h2 class="h3">Output Connection Types</h2>
<div class="section">
-<a name="N10382"></a><a name="solroutputconnector"></a>
+<a name="N1038B"></a><a name="solroutputconnector"></a>
<h3 class="h4">Solr Output Connection</h3>
<p>The Solr output connection type is designed to allow ManifoldCF to submit documents to an appropriate Solr pipeline, via the Solr
HTTP ingestion API. The configuration parameters are set to the default Solr values, which can be changed (since Solr's configuration can be changed).
@@ -892,7 +899,7 @@ document.write("Last Published: " + docu
<br>
<p>Add a new mapping by filling in the "source" with the name of the metadata item from the repository, and "target" as the name of the output field in
Solr, and click the "Add" button. Leaving the "target" field blank will result in all metadata items of that name not being sent to Solr.</p>
-<a name="N103FF"></a><a name="osssoutputconnector"></a>
+<a name="N10408"></a><a name="osssoutputconnector"></a>
<h3 class="h4">OpenSearchServer Output Connection</h3>
<p>The OpenSearchServer Output Connection allow ManifoldCF to submit documents to an OpenSearchServer instance, via the XML over HTTP API. The connector has been designed
to be as easy to use as possible.</p>
@@ -933,7 +940,7 @@ document.write("Last Published: " + docu
<div id="" style="text-align: center;">
<img id="" class="figure" alt="OpenSearchServer, history report" src="images/en_US/opensearchserver-history-report.PNG" width="80%"></div>
<p>You may also refer to the <a href="http://www.open-search-server.com/documentation">OpenSearchServer's user documentation</a>.</p>
-<a name="N1044A"></a><a name="esssoutputconnector"></a>
+<a name="N10453"></a><a name="esssoutputconnector"></a>
<h3 class="h4">ElasticSearch Output Connection</h3>
<p>The ElasticSearch Output Connection allow ManifoldCF to submit documents to an ElasticSearch instance, via the XML over HTTP API. The connector has been designed
to be as easy to use as possible.</p>
@@ -969,7 +976,7 @@ document.write("Last Published: " + docu
<div id="" style="text-align: center;">
<img id="" class="figure" alt="ElasticSearch, history report" src="images/en_US/elasticsearch-history-report.png" width="80%"></div>
<p>You may also refer to <a href="http://www.elasticsearch.org/guide">ElasticSearch's user documentation</a>.</p>
-<a name="N1048E"></a><a name="gtsoutputconnector"></a>
+<a name="N10497"></a><a name="gtsoutputconnector"></a>
<h3 class="h4">MetaCarta GTS Output Connection</h3>
<p>The MetaCarta GTS output connection type is designed to allow ManifoldCF to submit documents to an appropriate MetaCarta GTS search
appliance, via the appliance's HTTP Ingestion API.</p>
@@ -978,7 +985,7 @@ document.write("Last Published: " + docu
<p>When you configure a job to use a GTS-type output connection, two additional tabs will be presented to the user: "Collections" and "Document Templates". These
tabs allow per-job specification of these GTS-specific features.</p>
<p>More here later</p>
-<a name="N104A1"></a><a name="nulloutputconnector"></a>
+<a name="N104AA"></a><a name="nulloutputconnector"></a>
<h3 class="h4">Null Output Connection</h3>
<p>The null output connection type is meant primarily to function as an aid for people writing repository connection types. It is not expected to be useful in practice.</p>
<p>The null output connection type simply logs indexing and deletion requests, and does nothing else. It does not have any special configuration tabs, nor does it
@@ -986,10 +993,10 @@ document.write("Last Published: " + docu
</div>
-<a name="N104AF"></a><a name="authorityconnectiontypes"></a>
+<a name="N104B8"></a><a name="authorityconnectiontypes"></a>
<h2 class="h3">Authority Connection Types</h2>
<div class="section">
-<a name="N104B5"></a><a name="adauthority"></a>
+<a name="N104BE"></a><a name="adauthority"></a>
<h3 class="h4">Active Directory Authority Connection</h3>
<p>An active directory authority connection is essential for enforcing security for documents from Windows shares, Microsoft SharePoint, and IBM FileNet repositories.
This connection type needs to be provided with information about how to log into an appropriate Windows domain controller, with a user that has sufficient privileges to
@@ -1023,7 +1030,7 @@ document.write("Last Published: " + docu
<br>
<br>
<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="N104EE"></a><a name="ldapauthority"></a>
+<a name="N104F7"></a><a name="ldapauthority"></a>
<h3 class="h4">LDAP Authority Connection</h3>
<p>An LDAP authority connection can be used to provide document security in situations where there is no native document security
model in place. Examples include Samba shares, Wiki pages, RSS feeds, etc.</p>
@@ -1051,7 +1058,7 @@ document.write("Last Published: " + docu
<br>
<br>
<p>Note that in this example, the LDAP connection is not responding, which is leading to an error status message instead of "Connection working".</p>
-<a name="N1051D"></a><a name="livelinkauthority"></a>
+<a name="N10526"></a><a name="livelinkauthority"></a>
<h3 class="h4">OpenText LiveLink Authority Connection</h3>
<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
@@ -1090,7 +1097,7 @@ document.write("Last Published: " + docu
<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="N1056F"></a><a name="documentumauthority"></a>
+<a name="N10578"></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.</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.
@@ -1139,7 +1146,7 @@ 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="N105C3"></a><a name="memexauthority"></a>
+<a name="N105CC"></a><a name="memexauthority"></a>
<h3 class="h4">Memex Patriarch Authority Connection</h3>
<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.
@@ -1176,7 +1183,7 @@ document.write("Last Published: " + docu
<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="N10612"></a><a name="meridioauthority"></a>
+<a name="N1061B"></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
@@ -1250,7 +1257,7 @@ document.write("Last Published: " + docu
</ul>
<br>
<p>If you need specific ManifoldCF logging information, contact your system integrator.</p>
-<a name="N10699"></a><a name="cmisauthority"></a>
+<a name="N106A2"></a><a name="cmisauthority"></a>
<h3 class="h4">CMIS Authority Connection</h3>
<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>
@@ -1289,10 +1296,10 @@ document.write("Last Published: " + docu
</div>
-<a name="N106EC"></a><a name="repositoryconnectiontypes"></a>
+<a name="N106F5"></a><a name="repositoryconnectiontypes"></a>
<h2 class="h3">Repository Connection Types</h2>
<div class="section">
-<a name="N106F2"></a><a name="filesystemrepository"></a>
+<a name="N106FB"></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 ManifoldCF is running on. Bear in mind that there is no support in this connection type for any kind of
@@ -1331,7 +1338,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="N1072A"></a><a name="rssrepository"></a>
+<a name="N10733"></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>
@@ -1544,7 +1551,7 @@ document.write("Last Published: " + docu
<br>
<br>
<p>Select the mode you want the connection to operate in.</p>
-<a name="N108AD"></a><a name="webrepository"></a>
+<a name="N108B6"></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>
@@ -1915,7 +1922,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="N10AFF"></a><a name="jcifsrepository"></a>
+<a name="N10B08"></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>
@@ -2047,7 +2054,7 @@ document.write("Last Published: " + docu
<p>Accessing some servers may result in "Couldn't connect to server: Logon failure: unknown user name or bad password" Connection Status, because the default version of NTLM used for
authentication is incompatible. If this is the case, the Windows Share repository connector can be configured to use NTLMv1, rather than the NTLMv2 default. This is done by
setting the property "org.apache.manifoldcf.crawler.connectors.jcifs.usentlmv1" to "true" in properties.xml file.</p>
-<a name="N10BD9"></a><a name="wikirepository"></a>
+<a name="N10BE2"></a><a name="wikirepository"></a>
<h3 class="h4">Wiki Repository Connection</h3>
<p>The Wiki repository connection type allows you to index content from the main space of a Wiki or MediaWiki site. The connection type uses the Wiki API
in order to fetch content. Only publicly visible documents will be indexed, and there is thus no need of an authority for Wiki content.</p>
@@ -2061,7 +2068,7 @@ document.write("Last Published: " + docu
<p>The protocol must be selected in the "Protocol" field. At the moment only the "http" protocol is supported. The server name must be provided in the "Server name" field.
The server port must be provided in the "Port" field. Finally, the path part of the Wiki URL must be provided in the "Path name" field and must start with a "/" character.</p>
<p>When you configure a job to use a repository connection of the Wiki type, no additional tabs are currently presented.</p>
-<a name="N10BF7"></a><a name="jdbcrepository"></a>
+<a name="N10C00"></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>
@@ -2269,10 +2276,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="N10D42"></a><a name="filenetrepository"></a>
+<a name="N10D4B"></a><a name="filenetrepository"></a>
<h3 class="h4">IBM FileNet P8 Repository Connection</h3>
<p>More here later</p>
-<a name="N10D4C"></a><a name="documentumrepository"></a>
+<a name="N10D55"></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>
@@ -2327,7 +2334,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="N10DB2"></a><a name="livelinkrepository"></a>
+<a name="N10DBB"></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>
@@ -2422,7 +2429,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="N10E61"></a><a name="mexexrepository"></a>
+<a name="N10E6A"></a><a name="mexexrepository"></a>
<h3 class="h4">Memex Patriarch Repository Connection</h3>
<p>A Memex Patriarch connection allows you to index documents from a Memex server.</p>
<p>Documents described by Memex connections are typically secured by a Memex authority. If you have not yet created a Memex authority, but would like your
@@ -2456,7 +2463,7 @@ document.write("Last Published: " + docu
<p></p>
<p>Jobs based on Memex connections have the following special tabs: "Record Criteria", "Entities", and "Security".</p>
<p>More here later</p>
-<a name="N10EA6"></a><a name="meridiorepository"></a>
+<a name="N10EAF"></a><a name="meridiorepository"></a>
<h3 class="h4">Autonomy Meridio Repository Connection</h3>
<p>An Autonomy Meridio connection allows you to index documents from a set of Meridio servers. Meridio's architecture allows you to separate services on multiple machines -
e.g. the document services can run on one machine, and the records services can run on another. A Meridio connection type correspondingly is configured to describe each
@@ -2530,7 +2537,7 @@ document.write("Last Published: " + docu
<p></p>
<p>Jobs based on Meridio connections have the following special tabs: "Search Paths", "Content Types", "Categories", "Data Types", "Security", and "Metadata".</p>
<p>More here later</p>
-<a name="N10F2C"></a><a name="sharepointrepository"></a>
+<a name="N10F35"></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
@@ -2725,7 +2732,7 @@ document.write("Last Published: " + docu
<li>We can include all metadata using the checkbox. (without selecting from the pulldown list)</li>
</ul>
-<a name="N11086"></a><a name="cmisrepository"></a>
+<a name="N1108F"></a><a name="cmisrepository"></a>
<h3 class="h4">CMIS Repository Connection</h3>
<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>
@@ -2784,7 +2791,7 @@ document.write("Last Published: " + docu
<img id="" class="figure" alt="CMIS Repository Connection, saving job" src="images/en_US/cmis-repository-connection-job-save.png" width="80%"></div>
<br>
<br>
-<a name="N110FF"></a><a name="alfrescorepository"></a>
+<a name="N11108"></a><a name="alfrescorepository"></a>
<h3 class="h4">Alfresco Repository Connection</h3>
<p>The Alfresco Repository Connection type allows you to index content from an Alfresco repository.</p>
<p>This connector is compatible with any Alfresco version (2.x, 3.x and 4.x).</p>
@@ -2853,6 +2860,17 @@ document.write("Last Published: " + docu
Copyright ©
2009-2013 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
+<div class="copyright">
+ Apache ManifoldCF, ManifoldCF, Apache Forrest, Forrest, Apache Solr, Solr, Apache, the Apache feather logo, the Apache Forrest
+ logo, and the Apache ManifoldCF logo are trademarks of The Apache Software Foundation.
+ Documentum and EMC are a trademarks of EMC Corporation.
+ SharePoint, Windows, and Microsoft are trademarks of Microsoft, Inc.
+ FileNet P8 and IBM are trademarks of IBM, Inc.
+ LiveLink and OpenText are trademarks of OpenText, Inc.
+ QBase, MetaCarta, and GTS are trademarks of QBase, Inc.
+ Meridio and Autonomy are trademarks of Hewlett Packard, Inc.
+ Alfresco is a trademark of Alfresco Software, Inc.
+ </div>
<!--+
|end bottomstrip
+-->
Modified: manifoldcf/site/publish/release/trunk/en_US/end-user-documentation.pdf
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/end-user-documentation.pdf?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
Binary files - no diff available.
Modified: manifoldcf/site/publish/release/trunk/en_US/faq.html
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/faq.html?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
--- manifoldcf/site/publish/release/trunk/en_US/faq.html (original)
+++ manifoldcf/site/publish/release/trunk/en_US/faq.html Thu Mar 21 21:37:09 2013
@@ -208,6 +208,17 @@ document.write("Last Published: " + docu
Copyright ©
2009-2013 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
+<div class="copyright">
+ Apache ManifoldCF, ManifoldCF, Apache Forrest, Forrest, Apache Solr, Solr, Apache, the Apache feather logo, the Apache Forrest
+ logo, and the Apache ManifoldCF logo are trademarks of The Apache Software Foundation.
+ Documentum and EMC are a trademarks of EMC Corporation.
+ SharePoint, Windows, and Microsoft are trademarks of Microsoft, Inc.
+ FileNet P8 and IBM are trademarks of IBM, Inc.
+ LiveLink and OpenText are trademarks of OpenText, Inc.
+ QBase, MetaCarta, and GTS are trademarks of QBase, Inc.
+ Meridio and Autonomy are trademarks of Hewlett Packard, Inc.
+ Alfresco is a trademark of Alfresco Software, Inc.
+ </div>
<!--+
|end bottomstrip
+-->
Modified: manifoldcf/site/publish/release/trunk/en_US/how-to-build-and-deploy.html
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/how-to-build-and-deploy.html?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
--- manifoldcf/site/publish/release/trunk/en_US/how-to-build-and-deploy.html (original)
+++ manifoldcf/site/publish/release/trunk/en_US/how-to-build-and-deploy.html Thu Mar 21 21:37:09 2013
@@ -1639,6 +1639,17 @@ document.write("Last Published: " + docu
Copyright ©
2009-2013 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
+<div class="copyright">
+ Apache ManifoldCF, ManifoldCF, Apache Forrest, Forrest, Apache Solr, Solr, Apache, the Apache feather logo, the Apache Forrest
+ logo, and the Apache ManifoldCF logo are trademarks of The Apache Software Foundation.
+ Documentum and EMC are a trademarks of EMC Corporation.
+ SharePoint, Windows, and Microsoft are trademarks of Microsoft, Inc.
+ FileNet P8 and IBM are trademarks of IBM, Inc.
+ LiveLink and OpenText are trademarks of OpenText, Inc.
+ QBase, MetaCarta, and GTS are trademarks of QBase, Inc.
+ Meridio and Autonomy are trademarks of Hewlett Packard, Inc.
+ Alfresco is a trademark of Alfresco Software, Inc.
+ </div>
<!--+
|end bottomstrip
+-->
Modified: manifoldcf/site/publish/release/trunk/en_US/images/en_US/job-status.PNG
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/images/en_US/job-status.PNG?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
Binary files - no diff available.
Modified: manifoldcf/site/publish/release/trunk/en_US/included-connectors.html
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/included-connectors.html?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
--- manifoldcf/site/publish/release/trunk/en_US/included-connectors.html (original)
+++ manifoldcf/site/publish/release/trunk/en_US/included-connectors.html Thu Mar 21 21:37:09 2013
@@ -269,6 +269,17 @@ document.write("Last Published: " + docu
Copyright ©
2009-2013 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
+<div class="copyright">
+ Apache ManifoldCF, ManifoldCF, Apache Forrest, Forrest, Apache Solr, Solr, Apache, the Apache feather logo, the Apache Forrest
+ logo, and the Apache ManifoldCF logo are trademarks of The Apache Software Foundation.
+ Documentum and EMC are a trademarks of EMC Corporation.
+ SharePoint, Windows, and Microsoft are trademarks of Microsoft, Inc.
+ FileNet P8 and IBM are trademarks of IBM, Inc.
+ LiveLink and OpenText are trademarks of OpenText, Inc.
+ QBase, MetaCarta, and GTS are trademarks of QBase, Inc.
+ Meridio and Autonomy are trademarks of Hewlett Packard, Inc.
+ Alfresco is a trademark of Alfresco Software, Inc.
+ </div>
<!--+
|end bottomstrip
+-->
Modified: manifoldcf/site/publish/release/trunk/en_US/index.html
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/index.html?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
--- manifoldcf/site/publish/release/trunk/en_US/index.html (original)
+++ manifoldcf/site/publish/release/trunk/en_US/index.html Thu Mar 21 21:37:09 2013
@@ -217,6 +217,17 @@ document.write("Last Published: " + docu
Copyright ©
2009-2013 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
+<div class="copyright">
+ Apache ManifoldCF, ManifoldCF, Apache Forrest, Forrest, Apache Solr, Solr, Apache, the Apache feather logo, the Apache Forrest
+ logo, and the Apache ManifoldCF logo are trademarks of The Apache Software Foundation.
+ Documentum and EMC are a trademarks of EMC Corporation.
+ SharePoint, Windows, and Microsoft are trademarks of Microsoft, Inc.
+ FileNet P8 and IBM are trademarks of IBM, Inc.
+ LiveLink and OpenText are trademarks of OpenText, Inc.
+ QBase, MetaCarta, and GTS are trademarks of QBase, Inc.
+ Meridio and Autonomy are trademarks of Hewlett Packard, Inc.
+ Alfresco is a trademark of Alfresco Software, Inc.
+ </div>
<div id="logos"></div>
<!--+
|end bottomstrip
Modified: manifoldcf/site/publish/release/trunk/en_US/javadoc.html
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/javadoc.html?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
--- manifoldcf/site/publish/release/trunk/en_US/javadoc.html (original)
+++ manifoldcf/site/publish/release/trunk/en_US/javadoc.html Thu Mar 21 21:37:09 2013
@@ -259,6 +259,17 @@ document.write("Last Published: " + docu
Copyright ©
2009-2013 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
+<div class="copyright">
+ Apache ManifoldCF, ManifoldCF, Apache Forrest, Forrest, Apache Solr, Solr, Apache, the Apache feather logo, the Apache Forrest
+ logo, and the Apache ManifoldCF logo are trademarks of The Apache Software Foundation.
+ Documentum and EMC are a trademarks of EMC Corporation.
+ SharePoint, Windows, and Microsoft are trademarks of Microsoft, Inc.
+ FileNet P8 and IBM are trademarks of IBM, Inc.
+ LiveLink and OpenText are trademarks of OpenText, Inc.
+ QBase, MetaCarta, and GTS are trademarks of QBase, Inc.
+ Meridio and Autonomy are trademarks of Hewlett Packard, Inc.
+ Alfresco is a trademark of Alfresco Software, Inc.
+ </div>
<!--+
|end bottomstrip
+-->
Modified: manifoldcf/site/publish/release/trunk/en_US/performance-tuning.html
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/performance-tuning.html?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
--- manifoldcf/site/publish/release/trunk/en_US/performance-tuning.html (original)
+++ manifoldcf/site/publish/release/trunk/en_US/performance-tuning.html Thu Mar 21 21:37:09 2013
@@ -393,6 +393,17 @@ document.write("Last Published: " + docu
Copyright ©
2009-2013 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
+<div class="copyright">
+ Apache ManifoldCF, ManifoldCF, Apache Forrest, Forrest, Apache Solr, Solr, Apache, the Apache feather logo, the Apache Forrest
+ logo, and the Apache ManifoldCF logo are trademarks of The Apache Software Foundation.
+ Documentum and EMC are a trademarks of EMC Corporation.
+ SharePoint, Windows, and Microsoft are trademarks of Microsoft, Inc.
+ FileNet P8 and IBM are trademarks of IBM, Inc.
+ LiveLink and OpenText are trademarks of OpenText, Inc.
+ QBase, MetaCarta, and GTS are trademarks of QBase, Inc.
+ Meridio and Autonomy are trademarks of Hewlett Packard, Inc.
+ Alfresco is a trademark of Alfresco Software, Inc.
+ </div>
<!--+
|end bottomstrip
+-->
Modified: manifoldcf/site/publish/release/trunk/en_US/programmatic-operation.html
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/programmatic-operation.html?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
--- manifoldcf/site/publish/release/trunk/en_US/programmatic-operation.html (original)
+++ manifoldcf/site/publish/release/trunk/en_US/programmatic-operation.html Thu Mar 21 21:37:09 2013
@@ -180,6 +180,12 @@ document.write("Last Published: " + docu
<a href="#Resources+and+commands">Resources and commands</a>
</li>
<li>
+<a href="#History+query+parameters">History query parameters</a>
+</li>
+<li>
+<a href="#Queue+query+parameters">Queue query parameters</a>
+</li>
+<li>
<a href="#Output+connector+objects">Output connector objects</a>
</li>
<li>
@@ -229,7 +235,9 @@ document.write("Last Published: " + docu
<h2 class="h3">Programmatic Operation</h2>
<div class="section">
<p></p>
-<p>A certain subset of ManifoldCF users want to think of ManifoldCF as an engine that they can poke from whatever other system they are developing. While ManifoldCF is not precisely a document indexing engine per se, it can certainly be controlled programmatically. Right now, there are three principle ways of achieving this control.</p>
+<p>A certain subset of ManifoldCF users want to think of ManifoldCF as an engine that they can poke from whatever other system they are developing. While
+ ManifoldCF is not precisely a document indexing engine per se, it can certainly be controlled programmatically. Right now, there are three principle ways of
+ achieving this control.</p>
<p></p>
<a name="N1001B"></a><a name="Control+by+Servlet+API"></a>
<h3 class="h4">Control by Servlet API</h3>
@@ -246,16 +254,16 @@ document.write("Last Published: " + docu
</p>
<p></p>
<p>The servlet ignores request data, except when the PUT or POST verb is used. In that case, the request data is presumed to be a JSON object. The servlet
- responds either with an error response code (either 400 or 500) with an appropriate explanatory message, or with a 200 (OK), 201 (CREATED), or 404 (NOT FOUND)
- response code along with a response JSON object.</p>
+ responds either with an error response code (either 400 or 500) with an appropriate explanatory message, or with a 200 (OK), 201 (CREATED), or
+ 404 (NOT FOUND) response code along with a response JSON object.</p>
<p></p>
<a name="N10047"></a><a name="JSON+equivalents+for+ManifoldCF"></a>
<h4>JSON equivalents for ManifoldCF</h4>
<p></p>
-<p>ManifoldCF treats certain JSON forms as equivalent, for the purposes of readability. For example, the array form <strong>"foo" : [ { ... } ]</strong> is treated equivalently to
- <strong>"foo" : { }</strong>, whenever there is only one array element. This gives a coder some flexibility as to how s/he encodes JSON in requests. Please also be aware that
- similar compressions will occur in the JSON responses from the API servlet, and your code must be able to deal with this possibility. The following table
- describes some of the equivalences:</p>
+<p>ManifoldCF treats certain JSON forms as equivalent, for the purposes of readability. For example, the array form <strong>"foo" : [ { ... } ]</strong> is
+ treated equivalently to <strong>"foo" : { }</strong>, whenever there is only one array element. This gives a coder some flexibility as to how s/he encodes
+ JSON in requests. Please also be aware that similar compressions will occur in the JSON responses from the API servlet, and your code must be able to deal
+ with this possibility. The following table describes some of the equivalences:</p>
<p></p>
<p></p>
<p></p>
@@ -289,7 +297,7 @@ document.write("Last Published: " + docu
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
-<th colspan="1" rowspan="1">Resource</th><th colspan="1" rowspan="1">Verb</th><th colspan="1" rowspan="1">What it does</th><th colspan="1" rowspan="1">Input format</th><th colspan="1" rowspan="1">Output format</th>
+<th colspan="1" rowspan="1">Resource</th><th colspan="1" rowspan="1">Verb</th><th colspan="1" rowspan="1">What it does</th><th colspan="1" rowspan="1">Input format/query args</th><th colspan="1" rowspan="1">Output format</th>
</tr>
<tr>
@@ -413,6 +421,10 @@ document.write("Last Published: " + docu
</tr>
<tr>
+<td colspan="1" rowspan="1">startminimal/<em><job_id></em></td><td colspan="1" rowspan="1">PUT</td><td colspan="1" rowspan="1">Start a specified job manually, minimal run requested</td><td colspan="1" rowspan="1">N/A</td><td colspan="1" rowspan="1">{ } <strong>OR</strong> {"error":<em><error_text></em>}</td>
+</tr>
+
+<tr>
<td colspan="1" rowspan="1">abort/<em><job_id></em></td><td colspan="1" rowspan="1">PUT</td><td colspan="1" rowspan="1">Abort a specified job</td><td colspan="1" rowspan="1">N/A</td><td colspan="1" rowspan="1">{ } <strong>OR</strong> {"error":<em><error_text></em>}</td>
</tr>
@@ -421,18 +433,220 @@ document.write("Last Published: " + docu
</tr>
<tr>
+<td colspan="1" rowspan="1">restartminimal/<em><job_id></em></td><td colspan="1" rowspan="1">PUT</td><td colspan="1" rowspan="1">Stop and start a specified job, minimal run requested</td><td colspan="1" rowspan="1">N/A</td><td colspan="1" rowspan="1">{ } <strong>OR</strong> {"error":<em><error_text></em>}</td>
+</tr>
+
+<tr>
<td colspan="1" rowspan="1">pause/<em><job_id></em></td><td colspan="1" rowspan="1">PUT</td><td colspan="1" rowspan="1">Pause a specified job</td><td colspan="1" rowspan="1">N/A</td><td colspan="1" rowspan="1">{ } <strong>OR</strong> {"error":<em><error_text></em>}</td>
</tr>
<tr>
<td colspan="1" rowspan="1">resume/<em><job_id></em></td><td colspan="1" rowspan="1">PUT</td><td colspan="1" rowspan="1">Resume a specified job</td><td colspan="1" rowspan="1">N/A</td><td colspan="1" rowspan="1">{ } <strong>OR</strong> {"error":<em><error_text></em>}</td>
</tr>
+
+
+<tr>
+<td colspan="1" rowspan="1">repositoryconnectionhistory/<em><encoded_connection_name></em></td><td colspan="1" rowspan="1">GET</td><td colspan="1" rowspan="1">Get a history report</td><td colspan="1" rowspan="1"><em><history_query_parameters></em></td><td colspan="1" rowspan="1">{"row":[{"column":[{"name":<em><col_name></em>,"value":<em><col_value></em>}, ...]}, ...]} <strong>OR</strong> {"error":<em><error_text></em>}</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">repositoryconnectionquery/<em><encoded_connection_name></em></td><td colspan="1" rowspan="1">GET</td><td colspan="1" rowspan="1">Get a queue report</td><td colspan="1" rowspan="1"><em><queue_query_parameters></em></td><td colspan="1" rowspan="1">{"row":[{"column":[{"name":<em><col_name></em>,"value":<em><col_value></em>}, ...]}, ...]} <strong>OR</strong> {"error":<em><error_text></em>}</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">repositoryconnectionactivities/<em><encoded_connection_name></em></td><td colspan="1" rowspan="1">GET</td><td colspan="1" rowspan="1">Get a list of legal activities for a connection</td><td colspan="1" rowspan="1">N/A</td><td colspan="1" rowspan="1">{"activity":[<em><activity_name></em>, ...]} <strong>OR</strong> {"error":<em><error_text></em>}</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">repositoryconnectionjobs/<em><encoded_connection_name></em></td><td colspan="1" rowspan="1">GET</td><td colspan="1" rowspan="1">Get a list of jobs for a connection</td><td colspan="1" rowspan="1">N/A</td><td colspan="1" rowspan="1">{"job":[<em><list_of_job_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td>
+</tr>
+
+
+</table>
+<p></p>
+<a name="N105D8"></a><a name="History+query+parameters"></a>
+<h4>History query parameters</h4>
+<p></p>
+<p>The history query parameters and their meanings are as follows:</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+<th colspan="1" rowspan="1">Parameter</th><th colspan="1" rowspan="1">Report type</th><th colspan="1" rowspan="1">Multivalued?</th><th colspan="1" rowspan="1">Meaning</th>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">report</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">The kind of history report desired; legal values are "simple", "maxactivity", "maxbandwidth", and "result"; defaults to "simple"</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">starttime</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Starting time in ms since epoch; defaults to "0"</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">endtime</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Ending time in ms since epoch; defaults to now</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">activity</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Which activities you want to see</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">entitymatch</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Regular expression matching entity identifier; defaults to ""</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">entitymatch_insensitive</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Case insensitive version of entitymatch</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">resultcodematch</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Regular expression match result code; defaults to ""</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">resultcodematch_insensitive</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Case insensitive version of resultcodematch</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">sortcolumn</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Result column to sort the result by</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">sortcolumn_direction</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Direction to sort the corresponding column ("ascending" or "descending")</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">startrow</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Starting row in resultset to return; defaults to 0</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">rowcount</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Maximum number of rows to return; defaults to 20</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">idbucket</td><td colspan="1" rowspan="1">maxactivity, maxbandwidth, result</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Regular expression selecting which part of the entity identifier to use as an aggregation key; defaults to "()"</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">idbucket_insensitive</td><td colspan="1" rowspan="1">maxactivity, maxbandwidth, result</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Case insensitive version of idbucket</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">resultcodebucket</td><td colspan="1" rowspan="1">result</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Regular expression selecting which part of the result code to use as an aggregation key; defaults to "(.*)"</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">resultcodebucket_insensitive</td><td colspan="1" rowspan="1">result</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Case insensitive version of resultcodebucket</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">interval</td><td colspan="1" rowspan="1">maxactivity, maxbandwidth</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Size of window in milliseconds for assessing rate; defaults to 300000</td>
+</tr>
</table>
<p></p>
-<p>Other resources having to do with reports have been planned, but not yet been implemented.</p>
+<p>Each report type has different return columns, as listed below:</p>
<p></p>
-<a name="N10515"></a><a name="Output+connector+objects"></a>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+<th colspan="1" rowspan="1">Report type</th><th colspan="1" rowspan="1">Return columns</th>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">simple</td><td colspan="1" rowspan="1">starttime, resultcode, resultdesc, identifier, activity, bytes, elapsedtime</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">maxactivity</td><td colspan="1" rowspan="1">starttime, endtime, activitycount, idbucket</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">maxbandwidth</td><td colspan="1" rowspan="1">starttime, endtime, bytecount, idbucket</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">result</td><td colspan="1" rowspan="1">idbucket, resultcodebucket, eventcount</td>
+</tr>
+
+</table>
+<a name="N10767"></a><a name="Queue+query+parameters"></a>
+<h4>Queue query parameters</h4>
+<p></p>
+<p>The queue query parameters and their meanings are as follows:</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+<th colspan="1" rowspan="1">Parameter</th><th colspan="1" rowspan="1">Report type</th><th colspan="1" rowspan="1">Multivalued?</th><th colspan="1" rowspan="1">Meaning</th>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">report</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">The kind of queue report desired; legal values are "document" or "status"; defaults to "document"</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">now</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">The time in milliseconds since epoch to perform the queue assessment relative to; defaults to current time</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">idmatch</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Regular expression matching document identifier; defaults to ""</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">idmatch_insensitive</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Case insensitive version of idmatch</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">statematch</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">State to match; valid values are "neverprocessed", "previouslyprocessed", "outofscope"</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">statusmatch</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Status to match; valid values are "inactive", "processing", "expiring", "deleting", "readyforprocessing", "readyforexpiration", "waitingforprocessing", "waitingforexpiration", "waitingforever", and "hopcountexceeded"</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">sortcolumn</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Result column to sort the result by</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">sortcolumn_direction</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">Yes</td><td colspan="1" rowspan="1">Direction to sort the corresponding column ("ascending" or "descending")</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">startrow</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Starting row in resultset to return; defaults to 0</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">rowcount</td><td colspan="1" rowspan="1">All</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Maximum number of rows to return; defaults to 20</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">idbucket</td><td colspan="1" rowspan="1">status</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Regular expression selecting which part of the document identifier to use as an aggregation key; defaults to "()"</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">idbucket_insensitive</td><td colspan="1" rowspan="1">status</td><td colspan="1" rowspan="1">No</td><td colspan="1" rowspan="1">Case insensitive version of idbucket</td>
+</tr>
+
+</table>
+<p></p>
+<p>Each report type has different return columns, as listed below:</p>
+<p></p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+<th colspan="1" rowspan="1">Report type</th><th colspan="1" rowspan="1">Return columns</th>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">document</td><td colspan="1" rowspan="1">identifier, job, state, status, scheduled, action, retrycount, retrylimit</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">status</td><td colspan="1" rowspan="1">idbucket, inactive, processing, expiring, deleting, processready, expireready, processwaiting, expirewaiting, waitingforever, hopcountexceeded</td>
+</tr>
+
+</table>
+<a name="N10888"></a><a name="Output+connector+objects"></a>
<h4>Output connector objects</h4>
<p></p>
<p>The JSON fields an output connector object has are as follows:</p>
@@ -453,7 +667,7 @@ document.write("Last Published: " + docu
</table>
<p></p>
-<a name="N10546"></a><a name="Authority+connector+objects"></a>
+<a name="N108B9"></a><a name="Authority+connector+objects"></a>
<h4>Authority connector objects</h4>
<p></p>
<p>The JSON fields an authority connector object has are as follows:</p>
@@ -474,7 +688,7 @@ document.write("Last Published: " + docu
</table>
<p></p>
-<a name="N10577"></a><a name="Repository+connector+objects"></a>
+<a name="N108EA"></a><a name="Repository+connector+objects"></a>
<h4>Repository connector objects</h4>
<p></p>
<p>The JSON fields a repository connector object has are as follows:</p>
@@ -495,7 +709,7 @@ document.write("Last Published: " + docu
</table>
<p></p>
-<a name="N105A8"></a><a name="Output+connection+objects"></a>
+<a name="N1091B"></a><a name="Output+connection+objects"></a>
<h4>Output connection objects</h4>
<p></p>
<p>Output connection names, when they are part of a URL, should be encoded as follows:</p>
@@ -540,7 +754,7 @@ document.write("Last Published: " + docu
</table>
<p></p>
-<a name="N1060A"></a><a name="Authority+connection+objects"></a>
+<a name="N1097D"></a><a name="Authority+connection+objects"></a>
<h4>Authority connection objects</h4>
<p></p>
<p>Authority connection names, when they are part of a URL, should be encoded as follows:</p>
@@ -585,7 +799,7 @@ document.write("Last Published: " + docu
</table>
<p></p>
-<a name="N1066C"></a><a name="Repository+connection+objects"></a>
+<a name="N109DF"></a><a name="Repository+connection+objects"></a>
<h4>Repository connection objects</h4>
<p></p>
<p>Repository connection names, when they are part of a URL, should be encoded as follows:</p>
@@ -660,7 +874,7 @@ document.write("Last Published: " + docu
</table>
<p></p>
-<a name="N10714"></a><a name="Job+objects"></a>
+<a name="N10A87"></a><a name="Job+objects"></a>
<h4>Job objects</h4>
<p></p>
<p>The JSON fields for a job are is as follows:</p>
@@ -790,6 +1004,10 @@ document.write("Last Published: " + docu
<tr>
<td colspan="1" rowspan="1">"minutesofhour"</td><td colspan="1" rowspan="1">The optional minutes-of-the-hour enumeration object</td>
</tr>
+
+<tr>
+<td colspan="1" rowspan="1">"requestminimum"</td><td colspan="1" rowspan="1">Optional flag indicating whether the job run will be minimal or not ("true" means minimal)</td>
+</tr>
</table>
<p></p>
@@ -799,7 +1017,7 @@ document.write("Last Published: " + docu
<p></p>
<p>Each integer is a zero-based index describing which entity is being specified. For example, for "dayofweek", 0 corresponds to Sunday, etc., and thus "dayofweek":{"value":[0,6]} would describe Saturdays and Sundays.</p>
<p></p>
-<a name="N10865"></a><a name="Job+status+objects"></a>
+<a name="N10BE2"></a><a name="Job+status+objects"></a>
<h4>Job status objects</h4>
<p></p>
<p>The JSON fields of a job status object are as follows:</p>
@@ -844,14 +1062,14 @@ document.write("Last Published: " + docu
</table>
<p></p>
-<a name="N108D2"></a><a name="Connection-type-specific+objects"></a>
+<a name="N10C4F"></a><a name="Connection-type-specific+objects"></a>
<h4>Connection-type-specific objects</h4>
<p></p>
<p>As you may note when trying to use the above JSON API methods, you cannot get very far in defining connections or jobs without knowing the JSON format of a connection's configuration information, or a job's connection-specific document specification and output specification information. The form of these objects is controlled by the Java implementation of the underlying connector, and is translated directly into JSON, so if you write your own connector you should be able to figure out what it will be in the API. For connectors already part of ManifoldCF, it remains an ongoing task to document these connector-specific objects. This task is not yet underway.</p>
<p></p>
<p>Luckily, it is pretty easy to learn a lot about the objects in question by simply creating connections and jobs in the ManifoldCF crawler UI, and then inspecting the resulting JSON objects through the API. In this way, it should be possible to do a decent job of coding most API-based integrations. The one place where difficulties will certainly occur will be if you try to completely replace the ManifoldCF crawler UI with one of your own. This is because most connectors have methods that communicate with their respective back-ends in order to allow the user to select appropriate values. For example, the path drill-down that is presented by the LiveLink connector requires that the connector interrogate the appropriate LiveLink repository in order to populate its path selection pull-downs. There is, at this time, only one sanctioned way to accomplish the same job using the API, which is to use the appropriate "<em>connection_type</em>/execute/<em>type-specific_command</
em>" command to perform the necessary functions. Some set of useful functions has been coded for every appropriate connector, but the exact commands for every connector, and their JSON syntax, remains undocumented for now.</p>
<p></p>
-<a name="N108EB"></a><a name="File+system+connector"></a>
+<a name="N10C68"></a><a name="File+system+connector"></a>
<h4>File system connector</h4>
<p></p>
<p>The file system connector has no configuration information, and no connector-specific commands. However, it does have document specification information. The information looks something like this:</p>
@@ -861,7 +1079,7 @@ document.write("Last Published: " + docu
<p>As you can see, multiple starting paths are possible, and the inclusion and exclusion rules also can be one or multiple.</p>
<p></p>
<p></p>
-<a name="N10906"></a><a name="Control+via+Commands"></a>
+<a name="N10C83"></a><a name="Control+via+Commands"></a>
<h3 class="h4">Control via Commands</h3>
<p></p>
<p>For script writers, there currently exist a number of ManifoldCF execution commands. These commands are primarily rich in the area of definition of connections and jobs, controlling jobs, and running reports. The following table lists the current suite.</p>
@@ -998,18 +1216,23 @@ document.write("Last Published: " + docu
</table>
<p></p>
-<a name="N10A59"></a><a name="Control+by+direct+code"></a>
+<a name="N10DD6"></a><a name="Control+by+direct+code"></a>
<h3 class="h4">Control by direct code</h3>
<p></p>
-<p>Control by direct java code is quite a reasonable thing to do. The sources of the above commands should give a pretty clear idea how to proceed, if that's what you want to do.</p>
+<p>Control by direct java code is quite a reasonable thing to do. The sources of the above commands should give a pretty clear idea how to proceed, if that's what you
+ want to do.</p>
<p></p>
<p></p>
-<a name="N10A69"></a><a name="Caveats"></a>
+<a name="N10DE6"></a><a name="Caveats"></a>
<h3 class="h4">Caveats</h3>
<p></p>
-<p>The above commands know nothing about the differences between connection types. Instead, they deal with configuration and specification information in the form of XML documents. Normally, these XML documents are hidden from a system integrator, unless they happen to look into the database with a tool such as psql. But the API commands above often will require such XML documents to be included as part of the command execution.</p>
-<p></p>
-<p>This has one major consequence. Any application that would manipulate connections and jobs directly cannot be connection-type independent - these applications must know the proper form of XML to submit to the command. So, it is not possible to use these command APIs to write one's own UI wrapper, without sacrificing some of the repository independence that ManifoldCF by itself maintains.</p>
+<p>The above commands know nothing about the differences between connection types. Instead, they deal with configuration and specification information in the
+ form of XML documents. Normally, these XML documents are hidden from a system integrator, unless they happen to look into the database with a tool such as
+ psql. But the API commands above often will require such XML documents to be included as part of the command execution.</p>
+<p></p>
+<p>This has one major consequence. Any application that would manipulate connections and jobs directly cannot be connection-type independent - these
+ applications must know the proper form of XML to submit to the command. So, it is not possible to use these command APIs to write one's own UI wrapper,
+ without sacrificing some of the repository independence that ManifoldCF by itself maintains.</p>
</div>
</div>
@@ -1031,6 +1254,17 @@ document.write("Last Published: " + docu
Copyright ©
2009-2013 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
+<div class="copyright">
+ Apache ManifoldCF, ManifoldCF, Apache Forrest, Forrest, Apache Solr, Solr, Apache, the Apache feather logo, the Apache Forrest
+ logo, and the Apache ManifoldCF logo are trademarks of The Apache Software Foundation.
+ Documentum and EMC are a trademarks of EMC Corporation.
+ SharePoint, Windows, and Microsoft are trademarks of Microsoft, Inc.
+ FileNet P8 and IBM are trademarks of IBM, Inc.
+ LiveLink and OpenText are trademarks of OpenText, Inc.
+ QBase, MetaCarta, and GTS are trademarks of QBase, Inc.
+ Meridio and Autonomy are trademarks of Hewlett Packard, Inc.
+ Alfresco is a trademark of Alfresco Software, Inc.
+ </div>
<!--+
|end bottomstrip
+-->
Modified: manifoldcf/site/publish/release/trunk/en_US/script.html
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/script.html?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
--- manifoldcf/site/publish/release/trunk/en_US/script.html (original)
+++ manifoldcf/site/publish/release/trunk/en_US/script.html Thu Mar 21 21:37:09 2013
@@ -215,6 +215,9 @@ document.write("Last Published: " + docu
<a href="#URLs">URLs</a>
</li>
<li>
+<a href="#Query+Arguments">Query Arguments</a>
+</li>
+<li>
<a href="#Connection+names">Connection names</a>
</li>
<li>
@@ -358,6 +361,11 @@ expression:
newexpression:
--> 'url' expression
--> 'connectionname' expression
+--> 'configuration'
+--> 'configurationnode' expression
+--> 'array'
+--> 'dictionary'
+--> 'queryarg' expression ['=' expression]
</pre>
</div>
@@ -773,13 +781,40 @@ print "3".__int__+7;
</tr>
<tr>
-<td colspan="1" rowspan="1">binary +</td><td colspan="1" rowspan="1">Append and encode another path element, yielding a URL</td><td colspan="1" rowspan="1">url1 + "repositoryconnections"</td>
+<td colspan="1" rowspan="1">binary +</td><td colspan="1" rowspan="1">Append and encode another path or query argument element, yielding a URL</td><td colspan="1" rowspan="1">url1 + "repositoryconnections"</td>
</tr>
</table>
<p>In addition, the standard attributes <em>__script__</em> and <em>__string__</em> are supported
by URL variable types.</p>
-<a name="N105D6"></a><a name="Connection+names"></a>
+<a name="N105D6"></a><a name="Query+Arguments"></a>
+<h3 class="h4">Query Arguments</h3>
+<p>Query Argument variable types exist to take care of the details of URL encoding while assembling the query arguments of a REST URL for ManifoldCF's REST API. A Query Argument variable
+ type can be created using a 'new' operation of the form <strong>new</strong> <strong>queryarg</strong> <em>expression</em> [<strong>=</strong> <em>expression</em>], where the first expression is the
+ query argument name, and the second optional expression is the query argument value. For example, the script code 'new queryarg "report" = "simple"'
+ would create a Query Argument variable type representing the query argument "report=simple". To add query arguments to a URL, simply add them using the '+' operator,
+ for example "urlvar = urlvar + new queryarg 'report' = 'simple';" .</p>
+<p>The operations supported for this variable type, and their meanings are listed in the table below:</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<caption>Query Argument operations</caption>
+
+<tr>
+<th colspan="1" rowspan="1">Operation</th><th colspan="1" rowspan="1">Meaning</th><th colspan="1" rowspan="1">Example</th>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">binary ==</td><td colspan="1" rowspan="1">Equals comparison, yielding a boolean</td><td colspan="1" rowspan="1">arg1 == arg2</td>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">binary !=</td><td colspan="1" rowspan="1">Non-equals comparison, yielding a boolean</td><td colspan="1" rowspan="1">arg1 != arg2</td>
+</tr>
+
+</table>
+<p>In addition, the standard attributes <em>__script__</em> and <em>__string__</em> are supported
+ by Query Argument variable types.</p>
+<a name="N1062B"></a><a name="Connection+names"></a>
<h3 class="h4">Connection names</h3>
<p>Connection name variable types exist to perform the extra URL encoding needed for ManifoldCF's REST API. Connection names must be specially encoded so that they do not
contain slash characters ('/'). Connection name variable types take care of this encoding.</p>
@@ -805,7 +840,7 @@ print "3".__int__+7;
</table>
<p>In addition, the standard attributes <em>__script__</em> and <em>__string__</em> are supported
by connection name variable types.</p>
-<a name="N10628"></a><a name="Results"></a>
+<a name="N1067D"></a><a name="Results"></a>
<h3 class="h4">Results</h3>
<p>Result variable types capture the result of a GET, PUT, POST, or DELETE statement. They consist of two parts:</p>
<ul>
@@ -820,7 +855,7 @@ print "3".__int__+7;
</div>
-<a name="N10651"></a><a name="Statements"></a>
+<a name="N106A6"></a><a name="Statements"></a>
<h2 class="h3">Statements</h2>
<div class="section">
<p>The statements available to a ManifoldCF script programmer are designed to support interaction with the ManifoldCF API. Thus, there is support for
@@ -907,6 +942,17 @@ document.write("Last Published: " + docu
Copyright ©
2009-2013 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
+<div class="copyright">
+ Apache ManifoldCF, ManifoldCF, Apache Forrest, Forrest, Apache Solr, Solr, Apache, the Apache feather logo, the Apache Forrest
+ logo, and the Apache ManifoldCF logo are trademarks of The Apache Software Foundation.
+ Documentum and EMC are a trademarks of EMC Corporation.
+ SharePoint, Windows, and Microsoft are trademarks of Microsoft, Inc.
+ FileNet P8 and IBM are trademarks of IBM, Inc.
+ LiveLink and OpenText are trademarks of OpenText, Inc.
+ QBase, MetaCarta, and GTS are trademarks of QBase, Inc.
+ Meridio and Autonomy are trademarks of Hewlett Packard, Inc.
+ Alfresco is a trademark of Alfresco Software, Inc.
+ </div>
<!--+
|end bottomstrip
+-->
Modified: manifoldcf/site/publish/release/trunk/en_US/technical-resources.html
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/technical-resources.html?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
--- manifoldcf/site/publish/release/trunk/en_US/technical-resources.html (original)
+++ manifoldcf/site/publish/release/trunk/en_US/technical-resources.html Thu Mar 21 21:37:09 2013
@@ -252,6 +252,17 @@ document.write("Last Published: " + docu
Copyright ©
2009-2013 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
+<div class="copyright">
+ Apache ManifoldCF, ManifoldCF, Apache Forrest, Forrest, Apache Solr, Solr, Apache, the Apache feather logo, the Apache Forrest
+ logo, and the Apache ManifoldCF logo are trademarks of The Apache Software Foundation.
+ Documentum and EMC are a trademarks of EMC Corporation.
+ SharePoint, Windows, and Microsoft are trademarks of Microsoft, Inc.
+ FileNet P8 and IBM are trademarks of IBM, Inc.
+ LiveLink and OpenText are trademarks of OpenText, Inc.
+ QBase, MetaCarta, and GTS are trademarks of QBase, Inc.
+ Meridio and Autonomy are trademarks of Hewlett Packard, Inc.
+ Alfresco is a trademark of Alfresco Software, Inc.
+ </div>
<!--+
|end bottomstrip
+-->
Modified: manifoldcf/site/publish/release/trunk/en_US/writing-authority-connectors.html
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/writing-authority-connectors.html?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
--- manifoldcf/site/publish/release/trunk/en_US/writing-authority-connectors.html (original)
+++ manifoldcf/site/publish/release/trunk/en_US/writing-authority-connectors.html Thu Mar 21 21:37:09 2013
@@ -420,6 +420,17 @@ document.write("Last Published: " + docu
Copyright ©
2009-2013 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
+<div class="copyright">
+ Apache ManifoldCF, ManifoldCF, Apache Forrest, Forrest, Apache Solr, Solr, Apache, the Apache feather logo, the Apache Forrest
+ logo, and the Apache ManifoldCF logo are trademarks of The Apache Software Foundation.
+ Documentum and EMC are a trademarks of EMC Corporation.
+ SharePoint, Windows, and Microsoft are trademarks of Microsoft, Inc.
+ FileNet P8 and IBM are trademarks of IBM, Inc.
+ LiveLink and OpenText are trademarks of OpenText, Inc.
+ QBase, MetaCarta, and GTS are trademarks of QBase, Inc.
+ Meridio and Autonomy are trademarks of Hewlett Packard, Inc.
+ Alfresco is a trademark of Alfresco Software, Inc.
+ </div>
<!--+
|end bottomstrip
+-->
Modified: manifoldcf/site/publish/release/trunk/en_US/writing-output-connectors.html
URL: http://svn.apache.org/viewvc/manifoldcf/site/publish/release/trunk/en_US/writing-output-connectors.html?rev=1459538&r1=1459537&r2=1459538&view=diff
==============================================================================
--- manifoldcf/site/publish/release/trunk/en_US/writing-output-connectors.html (original)
+++ manifoldcf/site/publish/release/trunk/en_US/writing-output-connectors.html Thu Mar 21 21:37:09 2013
@@ -440,6 +440,17 @@ document.write("Last Published: " + docu
Copyright ©
2009-2013 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
+<div class="copyright">
+ Apache ManifoldCF, ManifoldCF, Apache Forrest, Forrest, Apache Solr, Solr, Apache, the Apache feather logo, the Apache Forrest
+ logo, and the Apache ManifoldCF logo are trademarks of The Apache Software Foundation.
+ Documentum and EMC are a trademarks of EMC Corporation.
+ SharePoint, Windows, and Microsoft are trademarks of Microsoft, Inc.
+ FileNet P8 and IBM are trademarks of IBM, Inc.
+ LiveLink and OpenText are trademarks of OpenText, Inc.
+ QBase, MetaCarta, and GTS are trademarks of QBase, Inc.
+ Meridio and Autonomy are trademarks of Hewlett Packard, Inc.
+ Alfresco is a trademark of Alfresco Software, Inc.
+ </div>
<!--+
|end bottomstrip
+-->