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/05/31 13:33:50 UTC
svn commit: r1488173 - in
/manifoldcf/branches/CONNECTORS-694/site/src/documentation:
content/xdocs/en_US/ resources/images/en_US/
Author: kwright
Date: Fri May 31 11:33:50 2013
New Revision: 1488173
URL: http://svn.apache.org/r1488173
Log:
Add CONNECTORS-695 documentation patch.
Added:
manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-connection-configuration-save.PNG (with props)
manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-connection-configuration.PNG (with props)
manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-connection-job-googledrive-seed-query.PNG (with props)
manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-1.PNG (with props)
manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-2.PNG (with props)
manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-3.PNG (with props)
manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-4.PNG (with props)
manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-5.PNG (with props)
Modified:
manifoldcf/branches/CONNECTORS-694/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml
Modified: manifoldcf/branches/CONNECTORS-694/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml
URL: http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-694/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml?rev=1488173&r1=1488172&r2=1488173&view=diff
==============================================================================
--- manifoldcf/branches/CONNECTORS-694/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml (original)
+++ manifoldcf/branches/CONNECTORS-694/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml Fri May 31 11:33:50 2013
@@ -1675,8 +1675,64 @@
<figure src="images/en_US/dropbox-repository-connection-job-save.PNG" alt="CMIS Repository Connection, saving job" width="80%"/>
<br/><br/>
</section>
-
- <section id="livelinkrepository">
+
+ <section id="googledriverepository">
+ <title>Google Drive Repository Connection</title>
+ <p>The Google Drive Repository Connection type allows you to index content from <a href="https://drive.google.com">Google Drives</a>.</p>
+ <p>Each Google Drive Connection manages access to a single drive repository. This means that if you have multiple Google Drives (i.e. different users),
+ you need to create a specific connection for each drive repository and provide the associated authentication information.</p>
+ <br/>
+ <p>A Google Drive connection has the following configuration parameters on the repository connection editing screen:</p>
+ <br/><br/>
+ <figure src="images/en_US/googledrive-repository-connection-configuration.PNG" alt="googledrive Repository Connection, configuration parameters" width="80%"/>
+ <br/><br/>
+ <p>As we can see there are 3 pieces of information which are needed to create a succesful connection. The Client ID and Client Secret given by Google Drive
+ when you register your application for a development license. This is typically done through the <a href="https://code.google.com/apis/console/b/0/">Google APIs Console</a>.</p>
+ <br/><br/>
+ <figure src="images/en_US/googledrive-repository-setup-1.PNG" alt="googledrive create project" width="80%"/>
+ <br/><br/>
+ <p>Once having created a project, we must enable the Google Drive API</p>
+ <br/><br/>
+ <figure src="images/en_US/googledrive-repository-setup-2.PNG" alt="googledrive enable drive api" width="80%"/>
+ <br/><br/>
+ <p>Then going to the API Access link on the righthand side, we need to select create an OAutg 2.0 client ID:</p>
+ <br/><br/>
+ <figure src="images/en_US/googledrive-repository-setup-3.PNG" alt="googledrive create oauth client" width="80%"/>
+ <br/><br/>
+
+ <p>After filling in the necessary information, we need to select what type of application we'd like. For our purposes we need to select installed application</p>
+ <br/><br/>
+ <figure src="images/en_US/googledrive-repository-setup-4.PNG" alt="googledrive create client id" width="80%"/>
+ <br/><br/>
+
+ <p>Afterwards we're presented with our Client ID and Client secrets needed for the connector(where the red boxes are):</p>
+ <br/><br/>
+ <figure src="images/en_US/googledrive-repository-setup-5.PNG" alt="googledrive client id and secret" width="80%"/>
+ <br/><br/>
+
+ <p>Now each user must confirm their acceptance of allowing your application to access their google drive. This is done through a run-of-the-mill OAUTH
+ approach, but needs to be done before hand. Once the steps are completed, a long-life refresh token is presented, which is then used by the connector. For completeness, we present the needed steps below since they require some manual work.</p>
+ <br/><br/><p>
+ <ol>
+ <li> Browse to here: https://accounts.google.com/o/oauth2/auth?scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fdrive.readonly&state=%2Fprofile&redirect_uri=https%3A%2F%2Flocalhost&response_type=code&client_id=CLIENT_ID&approval_prompt=force&access_type=offline
+ <li> This returns a link (after acceptance) https://localhost/?state=/profile&code=CODE
+ <li> Perform a POST: https://accounts.google.com/o/oauth2/token with the following as the body: grant_type=authorization_code&redirect_uri=https%3A%2F%2Flocalhost&client_secret=CLIENT_SECRET&client_id=CLIENT_ID&code=CODE
+ <li> The response is then a json response which contains the refresh_token.
+ </ol>
+ </p>
+ <br/><br/>
+ <p>After you click the "Save" button, you will see a connection summary screen, which might look something like this:</p>
+ <br/><br/>
+ <figure src="images/en_US/googledrive-repository-connection-configuration-save.PNG" alt="googledrive Repository Connection, saving configuration" width="80%"/>
+ <br/><br/>
+ <p>When you configure a job to use the Google Drive repository connection an additional tab is presented. This is the "Google Drive Seed Query" tab:</p>
+ <br/><br/>
+ <figure src="images/en_US/googledrive-repository-connection-job-googledrive-seed-query.PNG" alt="googledrive Repository Connection, seed query" width="80%"/>
+ <br/><br/>
+ <p>This tab allows you to specify the query which will be used to seed documents for the indexing process. The query language is specified on the <a href="https://developers.google.com/drive/search-parameters">Drive Search Paramters</a> site. Directories which meet the seed query are fully crawled as the query on applies to seeds. The default query indexes the entire drive. Lastly, native Google documents such as spreadsheets and word documents are exported to PDF and then ingested.</p>
+ </section>
+
+ <section id="livelinkrepository">
<title>OpenText LiveLink Repository Connection</title>
<p>The 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
Added: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-connection-configuration-save.PNG
URL: http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-connection-configuration-save.PNG?rev=1488173&view=auto
==============================================================================
Binary file - no diff available.
Propchange: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-connection-configuration-save.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-connection-configuration.PNG
URL: http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-connection-configuration.PNG?rev=1488173&view=auto
==============================================================================
Binary file - no diff available.
Propchange: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-connection-configuration.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-connection-job-googledrive-seed-query.PNG
URL: http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-connection-job-googledrive-seed-query.PNG?rev=1488173&view=auto
==============================================================================
Binary file - no diff available.
Propchange: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-connection-job-googledrive-seed-query.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-1.PNG
URL: http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-1.PNG?rev=1488173&view=auto
==============================================================================
Binary file - no diff available.
Propchange: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-1.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-2.PNG
URL: http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-2.PNG?rev=1488173&view=auto
==============================================================================
Binary file - no diff available.
Propchange: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-2.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-3.PNG
URL: http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-3.PNG?rev=1488173&view=auto
==============================================================================
Binary file - no diff available.
Propchange: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-3.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-4.PNG
URL: http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-4.PNG?rev=1488173&view=auto
==============================================================================
Binary file - no diff available.
Propchange: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-4.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-5.PNG
URL: http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-5.PNG?rev=1488173&view=auto
==============================================================================
Binary file - no diff available.
Propchange: manifoldcf/branches/CONNECTORS-694/site/src/documentation/resources/images/en_US/googledrive-repository-setup-5.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream