Installation

Follow these steps to install the Google Connector: These instructions assume that you have an in-house installation of v9.0+ up and running.

Download the Connector

1. Make sure the version of  is compatible with the version of the Google Connector you are installing. View the compatibility matrix to check the versions. If you are not using the correct version of , first upgrade your server software.  

2. Stop .

3. Download the compatible version of the Google Connector from our frevvo Software Download Directory. Extract the .zip file to a temporary location. Copy the google.war to c:\<frevvo-home>\tomcat\webapps. 

4. If you are running  on your local machine, you must set a domain name for your machine - otherwise you can skip this step. 

Set Up a Project in Your Google Account

1. Go to https://console.developers.google.com. Login to the google account that you are going to use with the Google connector. View this Google documentation to help you set up your project: https://developers.google.com/adwords/api/docs/guides/authentication, or follow the steps below. If you have a Location Group/Business Account your Google Domain admin will need to set up the organization and give the frevvo user permission to add projects to it. Please see this google documentation for details. 
   

2. Create a new project.
3. Enable the Google Drive API named Drive API.
4. Enable the Google Sheets API named Sheets API.
5. Select the email address you want to associate with this project on the OAUTH consent screen. Provide a project name. Click Save.
6. Go to Credentials - Create new client ID
1. The Consent screen must contain a product name and email address before continuing.
2. Application Type = Web Application
3. Authorized Javascript Origins = Empty
4. Authorized Redirect URIs = http://<DOMAIN_NAME>/google/credential. Replace <DOMAIN_NAME> with your domain name. If you are using localhost, this name must match the entry in your hosts file and you must provide the port number.
5. Click Create Client ID.
7. Click the Download JSON file. The credentials from this file (client id and client secret) become available to the Google Connector as a property in the frevvo-config.properties file.

Add Credentials to the Connector

There are several options to configure the connector with the credentials you downloaded in Step 7 above.

1. If you do not have a file named frevvo-config.properties in <frevvo-home>\tomcat\conf, you can rename the JSON file to frevvo-config.properties.
   

   1.  Edit the file and append the prefix client.secrets= to the file content.

      client.secrets={"web":{"client_id":"1042723840399-112fedk6nurt8j657rl4etl8441m3evf.apps.googleusercontent.com","project_id":"maryann-domain","auth_uri":"https://accounts.google.com/o/oauth2/auth","token_uri":"https://accounts.google.com/o/oauth2/token","auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs","client_secret":"E1P4VRTudW7mXZ7Pps5hsm5C","redirect_uris":["http://maryann.com/google/credential"]}}

   2. Save the file. Make sure the file type is changed from json to properties.
2. If you already have a file named frevvo-config.properties in <frevvo-home>\tomcat\conf directory, then copy the information from the json file and add it to your existing frevvo-config.properties file.
   

   1.  Append the prefix client.secrets= to the pasted content from the json file

      client.secrets={"web":{"client_id":"1042723840399-112fedk6nurt8j657rl4etl8441m3evf.apps.googleusercontent.com","project_id":"maryann-domain","auth_uri":"https://accounts.google.com/o/oauth2/auth","token_uri":"https://accounts.google.com/o/oauth2/token","auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs","client_secret":"E1P4VRTudW7mXZ7Pps5hsm5C","redirect_uris":["http://maryann.com/google/credential"]}}

   2. Save the file. Make sure the file type is changed from json to properties
3. You can also
   
   1. Rename the JSON file as client_secrets.json
   2. Copy it to tomcat/lib folder
   3. Create/edit the frevvo-config.properties in <frevvo-home>\tomcat\conf directory. Add the client.secrets= property to this file without a value e.g. client.secrets=

   
   

Configure Connector Location

If your  external HTTP port is any port other than Port 8082, you must add the frevvo.google.connector.url property to the frevvo-config.properties file in <frevvo-home>\tomcat\conf directory to set the location of the connector. This property defaults to frevvo.google.connector.url=http://localhost:8082/google. For example, if your external HTTP port is Port 80, add this property:

frevvo.google.connector.url=http://localhost:80/google

Start frevvo

1. Start the Insight server, then start . 
2. Paste this url in your browser: http://<DOMAIN_ NAME>/google/health to check the Google Connector status. Provide your domain name and the port number if you are running locally. You should see a {"status":"UP"} message.

Google Connector Logfile

If you are using the frevvo tomcat bundle, the Google Connector log is located in <frevvo-home>\tomcat\logs. The logfile is named google-connector.YYYY-MM-DD.log. Generating separate logfiles make it much easier to search for errors when troubleshooting connector issues. The connector is designed to use the frevvo-config.properties file.

The Google connector logfile defaults to INFO loglevel. To configure DEBUG level logging for the Google connector log:

1. Stop
2. Create/edit a frevvo-config.properties file in <frevvo-home>\tomcat\conf
3. Add the logging.level.com.frevvo.connectors.google=DEBUG property to the file or add the logging.level.=DEBUG to see DEBUG messages in the frevvo and any connector logs.
   
4. Save the file
5. Restart
   
   

logging.level.com.frevvo.connector.google=DEBUG

Generate the Google Connector log in JSON format

Logging output defaults to text format. To switch to JSON format, add this property to the frevvo-config.properties file.

spring.profiles.include=logging-json