Module Google

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search

<keywords content="Google, Dolibarr, synchro, synchronize, interface, calendar, contacts, address, map, maps, event, addresses, link" />

Informations

Module name Google
Editor / Editeur NLTechno - www.nltechno.com
Download or buy page / Page achat ou téléchargement www.dolistore.com
Status / Statut / Estado Stable
Prerequisites / Prérequis Dolibarr min version 3.4.1+

- Having module openssl extension enabled into your PHP. To check this, go into module Home - Setup - PHP infos and make a search into page of "openssl". If you don't find, openssl module is not installed.

- Having module xml extension enabled into your PHP. To check this, go into module Home - Setup - PHP infos and make a search into page of "xml". If you don't find, xml module is not installed.

- Having module curl extension enabled into your PHP. To check this, go into module Home - Setup - PHP infos and make a search into page of "curl". If you don't find, curl module is not installed.   

Last update date / Date mise à jour fiche / Fecha última actualización 2015-01-17
Note / Nota

Features

This module provides some Google integration into Dolibarr:

  • Synchronize your third parties/contacts or members into Google Contacts.
  • Add into menu a new entry called "Google Agenda" to show contents of your Google Agendas.
  • Synchronize any event created or modified into Dolibarr agenda to Google Agenda.
  • Add a pictogram near all addresses. A click on it show address inside a Google Maps.
  • Add a view of location of all your customers/members into Google Maps.
  • Can add a Google Adsense tag into logon page.
  • Can add a Google Analytics tag into any software pages.
  • Compatible with all standard Google Gmail account and with Google Apps Gmail account (from version 3.4.5 of module)

Install

  • Download the archive file of module (.zip file)
  • Put the file into the root directory of Dolibarr.
  • Uncompress the archive file, for example with command
unzip modulefile.zip
  • Module is then visible into list of available modules (Home->Setup->Modules) and can be activated.

Setup

To use this module, you must first enable it using an administrator account, via the menu option "Home - Setup - Modules".

Choose the tab where the module is listed. Then click on "Activate".

The module is now activated.

If an icon appears at end of the line for the module, click on it to access the setup page specific to the module.

Setup of Google Calendar/agenda features

This module provide 2 different features:

Showing Google calendar tab into Agenda view

First feature is to show the Google calendar view into a tab into Agenda view. For this, go onto Google module setup page, tab "View Google calendar" and:

Choose "Activate this tool" to Yes.

Then for each Google agenda you want to show in menus, you must enter:

  • A label for this Agenda.
  • A color for this Agenda.
  • Google ID of Agenda. It can be found on the Google parameters pages for the agendas like this:
  1. Log to http://calendar.google.com
  2. Click on the "Parameters" link
  3. Click on the name of Agenda to show the Details of agenda.
  4. Search line "URL Address", you will see a text "Agenda ID : theagendaid@gmail.com"

200px

The Agenda ID is value that looks like an email. If you have only one Agenda, it might simply be your Google login.

The last section of configuration (Google Client ID and Google Client secret) is only needed if you want the authentication request to Google is integrated into Dolibarr screens.

Synchronize events from Dolibarr to Google Agenda

The other feature is to write/update an event into Google Calendar, each time an event is added/updated into Dolibarr.

For this, go onto module setup page, tab "Sync to Google Agenda", and set "Create a Google event into Google Calendar when creating a Dolibarr event" to "Yes".

Then, you must setup and enter the API keys provided by Google. This is dones in several step.

1) Find the Google Agenda ID or your calendar. Go into your Google Calendar, then "Parameters" in the wheels, then tab "Agenda", or try this link https://www.google.com/calendar/render#i and then click on name or your Agenda. You Agenda ID is an ID that looks like an email.

Fille this ID found into field "ID Agenda".

2) You must create a service account user/email from page https://code.google.com/apis/console/, menu "API & Authentication" -> "Credentials" . Click on "Create a client ID" and choose "Service Account" then "Create". You will get a new service account with a Service account client ID and a Service account EMail. You need here to enter the Service account EMail.

Note: A popup to download a file (used by next step)

3) Once you have you created your service account user/email (see note on previous fields), you must download your security p12 file (or use the one downloaded at previous step). Return on https://code.google.com/apis/console/ and select "API & Authentication" -> "Credentials". Then Click on "Generate a p12 key" to download the file on your desktop. Then submit it using this form.

4) You must also enable the API for your Google account. For this go on page https://code.google.com/apis/console/, menu "API & Authentication" -> "API". Click to enable API for "Calendar API".

5) You must also share the agenda (all permissions) with the service account user/email (created at step 2): For this, go into Google calendar, choose "Parameters" then tab "Agendas" (direct access with this link https://www.google.com/calendar/render?tab=mc#i). Click on link "Share parameters" at end of line of the Agenda to synchronize (It must be same Agenda than the one choosed on parameter "ID Agenda" at step 1). Then add the service account user into the email field, choose permission "Edit events" and validate by clicking "Add user".

With Google Apps for work (not required for standard gmail account), permissions may be forced to "Ready only" instead of "Edit". To solve this, go onto https://admin.google.com/AdminHome#AppDetails:service=Calendar&flyout=sharing and check that sharing option of Agenda application allows sharing with external service account.


Once all steps are done, you can use the button to make a synchronization test. Click on it to make a test.


TroubleShooting

Check the step 3 was done.

Warning.png Note: A possible error is that Google denies access, even if login and password are correct, but just because the server that host Dolibarr is located into another country than country you are using google apps usually To check Google has locked your access for this reason, go onto page https://security.google.com/settings/security/activity?hl=fr after failure.

If it appears Google has blocked access attempts from an unusual location, accept this attempt. Then, you must wait 24 hours to try again.

Warning.png Note: Another possible error is that Google denies access even if your login and password are correct, because you turn on Google option 2-step validation. To check if you have actually enabled this option, go to the page: https://security.google.com/settings/security?pli=1

If in the "Validation in two stages," you have "On", the problem is found. You do not have to disable it. You can solve the problem as follows: Click "Edit" next to the title of the "Validation in two steps." Click the link "Manage passwords specific to applications". Enter a name, for example "Google Access for Dolibarr" and confirm. A password will be provided. Return to the configuration page of Google Dolibarr module and enter this password in the configuration page of the module, instead of your regular password, then click Save. Retry the test synchronization.


Note: If you created several agenda from Google calendar web interface, synchronization is done with default one (the first one in view "Calendar Settings").

Setup of Google Contact

This module allows you to synchronize Dolibarr with your Google contact annuary. First, choose all Dolibarr elements you want to synchronize ampong (You can choose several choices):

  • Thirdparties (if module Thirdparty is enabled)
  • Contacts/addresses of thirdparties (if module Thirdparty is enabed)
  • Members (if module foundation members is enabled)

Then enter your Google login and password and Save.

Buttons to make synchronization tests should be available. Click on them to make tests.

TroubleShooting

  • Warning.png Note: A possible error is that Google denies access, even if login and password are correct, but just because the server that host Dolibarr is located into another country than country uou are using google apps usually.

To check Google has locked your access for this reason, go onto page https://security.google.com/settings/security/activity?hl=fr after failure.

If it appears Google has blocked access attempts from an unusual location, accept this attempt. Then, you must wait 24 hours to try again.

  • Warning.png Note: Another possible error is that Google denies access even if your login and password are correct, because you turn on Google option 2-step validation. To check if you have actually enabled this option, go to the page: https://security.google.com/settings/security?pli=1

If in the "Validation in two stages," you have "On", the problem is found. You do not have to disable it. You can solve the problem as follows: Click "Edit" next to the title of the "Validation in two steps." Click the link "Manage passwords specific to applications". Enter a name, for example "Google Access for Dolibarr" and confirm. A password will be provided. Return to the configuration page of Google Dolibarr module and enter this password in the configuration page of the module, instead of your regular password, then click Save. Retry the test synchronization.

Setup of GMaps features

Link to localize a specific address

Choose elements on which you want to see a GMaps picto after addresses, among (you can choose several choices):

  • Thirdparties (if module Thirdparty is enabled)
  • Contacts/addresses of thirdparties (if module Thirdparty is enabed)
  • Members (if module foundation members is enabled)

Then define the zoom level to define scale used by defaut when a map will be output (value from 1 to 10, 10 is the more accurate zoom level). 7 is a recommanded value.

Links to global maps

The other feature provided by module, is to show a global map with all your thirdparties, contact/addresses or members. To see link to thoose maps, go into menu Home -Setup - Boxes. Check that the box "Links to Google Maps" is activated. Return to Dolibarr home page. If boxes does not appears, choose it into the combo list on the left, to add it definitely on you screen.

Setup of Adsense

If you want to enable adsense feature, on Adsense tab, enter:

  • Your adsense customer id (ca-pub-xxxxxx)

Id specific to ad shown (you can find this id into Google adsenses dashboard adsense.google.com) An advert will be added onto demo and logon page.

Setup of Google analytics

If you want to enable analytics feature, on Analytics tab, enter:

  • Your Google analytics id (something like UA-xxxxxxx-y). You can find this id on Google analytics dashboard.

The Google Analytics tag will be then output onto all Dolibarr pages.

Usage

Usage of Google Agendas features

If you enabled feature to show Google agenda

Choose menu Agenda Google, the agenda will be shown. If you have defined several agendas, you can limit view for only one of them using the left menu. The Google agenda is shown in read only mode. To add event into it, you must click on link "+ Google calendar" at bottom of agenda (this is a Google limit).

Google module add.jpg.

For security reasons imposed by Google, the Google calendar view will display correctly only if you are logged in to Google. To facilitate this, it is possible to configure a key to allow the application to offer the Google Logon if you are not connected (See setup of module Google, tab Agenda setup, last section).

If you activate synchronization

Just go onto Google calendar after creating a Dolibarr event. You should see it into Google.


Usage of GMaps feature

Depending on the choice made ​​in configuration, a small pictogram appears on the third page, Contacts / Addresses or members after the address. By clicking above, you will see a map with the address positioned above. It is possible for you to navigate the map without leaving Dolibarr.

Screen shot google 2.png

In addition, from version 3.4, you also have access to a box on the home page with a link to see all of your third party or members on the same map.

Screen shot google 3.png

Usage of Adsense feature

There is no particular things to do. Once setup is done (see previous chapter), a Google Adsense advert will appear on login page.

Note: When Dolibarr is used with the Application Android - DoliDroid, advert will not be active.

Usage of Google Analytics

There is no particular things to do. Once setup is done (see previous chapter), a Google Analytics tag is added onto each Dolibarr page. By using the Google Analytic interface, you can have statistics on your Dolibarr usage, as if it was a public web site.

Note: When Dolibarr is used with the Application Android - DoliDroid, tag will not be active.

Development

Development of this module is not included inside the standard GIT repository of Dolibarr but inside a repository dedicated to modules not supported by the Dolibarr development team but supported by NLTechno on platform Git by Framasoft:

Note this is a private repository, so to contribute and/or get sources, you must create an account on https://git.framasoft.org web site.