Google Drive Integration Project Instructions

This how-to article will help Administrators to configure an integration with Google Drive using the TDAdmin interface. The user must an Administrator to configure this integration.

Target Audience

Do I have a vanity URL?

1. help.abuniversity.edu
   Type: Vanity URL
   Reason: This is a vanity URL because this is a domain your organization owns.
2. abuniversity.teamdynamix.com
   Type: Standard URL
   Reason: This is not a vanity URL because this is a domain TeamDynamix owns.

Does this guide apply to me

• SaaS (Cloud-Hosted):
  • Vanity URL: Yes
  • Standard URL: No
• On-Premise (Self-Hosted): Yes

What do I need to do?

• SaaS (Cloud-Hosted):
  • Vanity URL: 
    Complete the integration setup outlined in this article, then provide the specified information to your TeamDynamix consultant (or support if after implementation).
  • Standard URL: 
    Alert your TeamDynamix consultant (or support if after implementation) to enable your organizational URL for integration usage before you enable this integration in TDAdmin
• On-Premise (Self-Hosted): 
  Complete the integration setup outlined in this article. Pay special attention to the extra on-premise-only steps.

Overview

On-premise (self-hosted) and SaaS vanity URL clients must set up their own Google Drive integration projects to use Google Drive file hosting with TeamDynamix. Use the instructions below to properly configure a Google Drive integration project.

Setting Up Google Drive Integration

1. To begin, ensure that your organization has a central Google account for administration.
2. Create an application in Google by visiting https://console.developers.google.com/cloud-resource-manager, sign in if necessary and click + Create Project.
3. Enter Project name (cannot contain the text google or ssl), Project ID (if desired), Location (if desired), and then click Create.
4. Click the  navigation menu settings icon in the top left of the page and choose APIs & Services > Dashboard.
5. Be sure that the previously created project is selected in the dropdown in the top left of the screen (near the Google APIs link).
6. Ensure that you are on the Dashboard tab in the left navigation menu and then click + Enable APIs and Services.
7. Search for Google Picker API, click the single result box and then click Enable. You will be directed back to the APIs & Services page for the project.
8. Enter OAuth Consent Screen Information
   1. In the left navigation menu of the APIs & Services page, click the OAuth Consent screen tab.
   2. Enter a meaningful Application name. This can be similar to the overall project name you created above if you desire. Google tends to be very particular about OAuth consent screen information though, so a suggested application name might be:
      YourSchoolName Google Drive Integration for TeamDynamix Apps Usage.
   3. Choose an Application logo if you desire.
   4. Enter a valid Support email for the integration.
   5. In the Scopes for Google APIs section, click Add scope. In the modal that opens, click the manually paste your scopes link and paste the following into the textbox that appears:
      https://www.googleapis.com/auth/drive.readonly
      When complete, click the Add button.
   6. In the Authorized domains section, enter your base or root domain(s) (ex: mydomain.edu).
   7. Enter an Application Homepage link, Application Privacy Policy link and Application Terms of Service link if desired.
   8. Ensure that the OAuth grant limits is set to 1d.
   9. Click Save. You will need to come back later and submit your application for verification, but first some other configurations need to be set up.
9. Create an API Key
   10. In the left navigation menu of the APIs & Services page, click the Credentials tab.
   11. In the Credentials page, click Create credentials dropdown and choose API key. Close the creation dialog and click the new key name in the API keys list. It should be the only item in the list at this point.
   12. Rename the key to Browser Key.
   13. Choose HTTP referers (web site) in the Application restrictions section.
   14. In the Website restrictions section that now appears, enter both localhost and a wildcard for your base or root domain (ex: *.mydomain.edu).
   15. Choose Don't restrict key in the API Restrictions section.
   16. Click Save, taking you back to the main Credentials list page.
10. Create an OAuth Client ID
    1. In the left navigation of the APIs & Services page, click the Credentials tab.
    2. On the Credentials page, click the Create credentials dropdown and choose OAuth client ID.
    3. Set Application type to Web application.
    4. Set the Name to Web Client.
    5. Enter http://localhost and any other domains you wish to use this app in the Authorized Javascript origins section. You should have at least one other domain for your school's domain that you use with TeamDynamix. An example might be https://td.myschool.edu.
    6. Enter http://localhost/oauth2callback and any other domain variations you wish to use in the Authorized redirect URIs section. You should have at least one other domain for your school's domain that you use with TeamDynamix. An example might be https://td.myschool.edu/oauth2callback.
    7. When you are satisfied that all is correct here, click Create.

11. Submit your application for verification.
    This is technically an optional step but Google will display a very large security warning about using an unverified application if you do not verify your application. Google may at some point not support or allow unverified applications as well. 
    1. In the left navigation menu of the APIs & Services page, click the OAuth Consent screen tab and click Submit for verification. For the Scopes justification section, enter the following:
       These scopes will be used as authorized origins and redirect URIs for a Google File Picker integration in an external web application named TeamDynamix. This integration allows users to view and save links to Google Drive / G-Suite files in the external application only.
       Enter any additional comments you desire, a contact email address and then click Submit. You will now have to wait for Google to contact you and go through a verification process with them. This may involve verifying your domain in Google Search Console (formerly Google Web Master Tools) and/or making a YouTube video of the intended integration usage.
12. In the left navigation menu of the APIs & Services page, click the Credentials tab, click into the Browser Key API key you created above and copy the API Key value.
13. In the left navigation menu of the APIs & Services page, click the Credentials tab, click into the Web Client OAuth client ID you created above and copy the Client ID value.
14. In the TeamDynamix TDAdmin application, navigate to the TDAdmin > Organization Settings > Briefcase/Attachment Integrations page, check the Allow users to add Google Drive files option, and then click Save.
15. If you are a SaaS customer
    1. Pass the values API Key and Client ID values to your TeamDynamix contact (likely your implementation consultant or a TeamDynamix support ticket contact) and they will complete the process to enable this for you.

Additional Steps for On-Prem Customers

16. If you are an on-premise (self-hosted) customer, follow the additional steps below in order complete your Google Driveintegration.
    1. Sign into the TDAdmin application as the system administrator user. One of your main TeamDynamix administrators should have access to this credential for changing system-level settings like file integration keys.
    2. Select Organizational Settings > Briefcase/Attachment Integration
    3. Scroll to the Google Drive area of the Custom Integration Keys section. Put the values created above into their respective Google Drive fields for API Key and Client ID.
    4. Click Save.

YouTube Integration Usage Videos

If Google asks you to submit a YouTube video of the intended usage of this integration, do the following after completing the setup guide above. If these instructions are out of date, please alert TeamDynamix so that we may update them.

Create a screen recording of someone taking the following actions in their browser. Be sure all of the page URLs are visible in the video and make all screens full screen if they pop up. When the video is complete, upload it to YouTube and send the link to the video to Google.

1. Sign into TDNext in a browser with no previous sessions for TeamDynamix or Google applications of any sort. You want to specifically see sign-ins to everything.
2. Go to an existing project briefcase folder, project issue or testing ticket.
3. Choose to Add a File or Attachment from Google Drive.
4. When you see the security warning about an unverified application, click through it with the Advanced link.
5. At the Google sign in and OAuth consent screens, sign in and let the application have the access it requests permission for.
6. Choose a Google Drive file to link into TeamDynamix.
7. Refresh the Briefcase folder/issue/ticket to show the linked Google Drive file.
8. Open the file in Google Drive from the appropriate download link in the folder/issue/ticket.