Enabling Google Drive™ Access
Many people store documents on the Internet in Google Drive, which is a document storing and editing service provided by Google™.
For more details about Google Drive, please see Google's web site:
This document describes how you, a domain administrator, enable Google Drive integration with BrainHoney so that students, graders, and course authors
can easily access Google Drive documents (Google docs) as they participate in a course.
To enable Google Drive access from within BrainHoney, you must first perform some steps on the Google web site to notify Google
that BrainHoney will access Google Drive on behalf of your domain's end-users. After successfully configuring Google, you copy
some settings information from the Google web site to your BrainHoney domain settings, and then verify that the integration
works as expected.
1. Creating a Google Account
You must have a Google account to accept Google's terms of service for accessing Google Drive from within BrainHoney.
As part of the standard Google security and authentication process, Google provides this account's e-mail address
to each end-user before they attempt to access Google Drive in BrainHoney.
To create the account:
- Go to accounts.google.com and click the Sign Up button.
- Provide all required information, clicking through the Google screens to complete account setup.
- Remember the account e-mail and password, which you must provide in the next step.
2. Creating a Google API Project
Google has a console that allows you to configure any application, such as BrainHoney, to access Google services
through their Application Programming Interfaces (APIs). BrainHoney contains code that accesses Google Drive services,
but you must enable that code to run in your BrainHoney domain by agreeing to Google's terms of service and setting up
a link between BrainHoney and Google by creating a Google API Project.
Follow these steps to configure a Google API Project:
- Open the Google APIs console by going to code.google.com/apis/console.
- Enter the Google account email and password that you created in section 1.
- Click the [Create project] button.
- On the Services tab, scroll down the list of APIs to Drive API and click the [Off] button to turn on the API.
- Google responds by displaying its Terms of Service. Review and (if you agree) agree to both the Google APIs
and Drive API Terms of Service.
- The Drive API slider now should be set to "On" and moved to the top of the list of APIs. Click the Gear icon to edit the settings for the API.
- Click the API Access tab and then click [Create an OAuth 2.0 client ID...].
- Enter values for Product name, logo, and home page URL. For example, if your BrainHoney domain login prefix is abc, we suggest values like:
BrainHoney - ABC School, http://abc.brainhoney.com/images/bee.png, and https://abc.brainhoney.com, respectively.
- Click [Next] to see the Client ID Settings, and then click the "more options" link.
- Ensure Web application is selected, clear the Authorized Redirect URIs box, and in the
For example, if your domain login prefix is "abc", enter https://abc.brainhoney.com.
If you administer multiple BrainHoney URLs, you must enter each one in this box on a separate line.
then you'll see an "Origin mismatch" error when you attempt to connect to
Google Drive from BrainHoney.
- Click [Create client ID]
- The API Access tab now shows a Client ID for web applications section containing
a client ID. Make note of it, or select it and copy it to the clipboard (Ctl-C), as you'll be entering this ID
in BrainHoney in a few moments.
3. Configuring a BrainHoney Domain
Once you have obtained a Google client ID, you need to save it in your BrainHoney domain's customization settings.
(For general information about domain customization settings, see Customizing a Domain.)
- Sign into BrainHoney with your System Administrator account.
- Click Administration, and then Edit to open the Edit Domain popup.
- Click Customization, and create an XML entry at the bottom of the existing entries (whatever they
may be) as follows:
<googledrive clientid="replace_this_text" />
replacing replace_this_text with the Google client ID you obtained in the previous steps.
- Click [OK] to save your changes.
Verifying Google Drive Access
To verify you have correctly configured both Google and BrainHoney for Google Drive integration:
- Sign out of BrainHoney and then sign back in (this ensures BrainHoney recognizes your new domain customization).
- Open any of the BrainHoney screens that allow Google doc attachment, such as the Course Syllabus.
- Add a new assignment.
- Click Add Attachment.
- One of the choices should be Google Document, which you should click. If that link does not appear, then
follow the steps in section 3 to correctly enter a googledrive customization in your domain.
- After clicking it, Google pops up a window prompting for access to Google Drive. Ensure you allow the Google popup,
and then answer all Google prompts, including entering your Google username and password,
and allowing BrainHoney to access your Google Drive.
If everything is configured correctly, the resulting window shows the list of your Google Drive documents and you are done! If Google reports
a configuration or access error, ensure you have followed all steps in Section 2 and that you are are using the same URLs
to access BrainHoney that you configured in the Google API console.
Google and the Google logo are registered trademarks of Google Inc., used with permission.