27,403
edits
Changes
Jump to navigation
Jump to search
mLine 12:
Line 12: − + Line 29:
Line 29: − + − * 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. − + + + + + + + − + + + − + − + − + Line 58:
Line 59: − + − + − + − + − + − + − + + + + Line 72:
Line 76: − + Line 86:
Line 90: − + − + − + − + + Line 99:
Line 104: − + − + + Line 113:
Line 119: − + + Line 121:
Line 128: − + + + − + − * [[File:Warning.png]] Note: A possible error is that Google denies access, even if your setup is correct, just because the server that host Dolibarr is located into another country or region than the one using google apps usually. − + − + + + + + + + + − == Setup of Google Contact ==+ − This module allows you to synchronize Dolibarr with your Google contact annuary. Synchronisation of contacts can be done toward only one Google account. However, using the Google sharing features (delegate contacts), everybody could see them. Line 144:
Line 158: − + − + − + + Line 154:
Line 169: − + − + − + − + Line 164:
Line 179: − + + − + Line 177:
Line 193: − + − + Line 185:
Line 201: − + − + − + − + + + − + − + − + + + − + − + + + − + − + − + − + − + Line 221:
Line 243: − + Line 234:
Line 256: − + − + − + + − + Line 260:
Line 283: − + Line 266:
Line 289: − + Line 272:
Line 295: − +
→Setup of Google Contact
{{TemplateDocUser}}
{{TemplateDocUser}}
<seo metak="Google, Dolibarr, synchro, synchronize, interface, calendar, contacts, address, map, maps, event, addresses, link" />
<seo metak="Google, Dolibarr, synchro, synchronize, interface, calendar, contacts, address, map, maps, event, addresses, link" />
= Informations =
=Informations=
{{TemplateModuleInfo
{{TemplateModuleInfo
|modulename=Google
|modulename=Google
}}
}}
= Features =
=Features=
This module provides some Google integration into Dolibarr:
This module provides some Google integration into Dolibarr:
* Compatible with all standard Google Gmail account and with Google Apps Gmail account (from version 3.4.5 of module)
*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.
= Install =
*Compatible with all standard Google Gmail account and with Google Apps Gmail account (from version 3.4.5 of module)
=Install=
{{InstallModuleEn}}
{{InstallModuleEn}}
= Setup =
=Setup=
{{ActivationModuleEn}}
{{ActivationModuleEn}}
== Setup of Google Calendar/agenda features ==
==Setup of Google Calendar/agenda features==
This module provide 2 different features:
This module provide 2 different features:
=== Showing Google calendar tab into Agenda view ===
===Showing Google calendar tab into Agenda view===
First feature is to show the Google calendar view into a tab into Agenda view. This feature does not provide any synchronization (see next feature for this) but only a visibility of Google native calendar into a Dolibarr tab. This list of agenda will be the same for every users so this feature is not usefull if you have different agenda that need different visibility according to users (The next feature may be more interesting if you are in this case).
First feature is to show the Google calendar view into a tab into Agenda view. This feature does not provide any synchronization (see next feature for this) but only a visibility of Google native calendar into a Dolibarr tab. This list of agenda will be the same for every users so this feature is not usefull if you have different agenda that need different visibility according to users (The next feature may be more interesting if you are in this case).
Then for each Google agenda you want to show in menus, you must enter:
Then for each Google agenda you want to show in menus, you must enter:
* A label for this Agenda.
* A color for this Agenda.
*A label for this Agenda.
* Google ID of Agenda. It can be found on the Google parameters pages for the agendas like this:
*A color for this Agenda.
# Log to http://calendar.google.com
*Google ID of Agenda. It can be found on the Google parameters pages for the agendas like this:
# Click on the "Parameters" link in the wheels
# Click on the name of Agenda to show the Details of agenda.
#Log to http://calendar.google.com
# Search line "URL Address", you will see a text "Calendar ID: theagendaid@gmail.com" like into the following screenshot (click twice on image to have it enlarged)
#Click on the "Parameters" link in the wheels
#Click on the name of Agenda to show the Details of agenda.
#Search line "URL Address", you will see a text "Calendar ID: theagendaid@gmail.com" like into the following screenshot (click twice on image to have it enlarged)
[[File:Find your Google Calendar or Agenda ID.png|400px]]
[[File:Find your Google Calendar or Agenda ID.png|400px]]
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.
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 ===
===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.
The other feature is to write/update an event into Google Calendar, each time an event is added/updated into Dolibarr.
The event is pushed to a unique Agenda, or if you choose to use one agenda per user, to the agenda of the owner of the event.
The event is pushed to a unique Agenda, or if you choose to use one agenda per user, to the agenda of the owner of the event.
2) Find the Google Agenda ID or your calendar.
2) Find the Google Agenda ID or your calendar.
For this,
For this,
# Log to http://calendar.google.com
# Click on the "Parameters" link in the wheels
#Log to http://calendar.google.com
# Click on the name of Agenda to show the Details of agenda.
#Click on the "Parameters" link in the wheels
# Search line "URL Address", you will see a text "Calendar ID: theagendaid@gmail.com" like into the following screenshot (click twice on image to have it enlarged)
#Click on the name of Agenda to show the Details of agenda.
#Search line "URL Address", you will see a text "Calendar ID: theagendaid@gmail.com" like into the following screenshot (click twice on image to have it enlarged)
[[File:Find your Google Calendar or Agenda ID.png|400px]]
[[File:Find your Google Calendar or Agenda ID.png|400px]]
3) You must create a service account user/email from page {{ModuleGoogleUrlToCreateApiAccount}}, menu "Credentials" . Click on "Create a client ID" and choose "Service Account" then choose "type of file P12" then "Create". You will get:
3) You must create a service account user/email from page {{ModuleGoogleUrlToCreateApiAccount}}, menu "Credentials" . Click on "Create a client ID" and choose "Service Account" then choose "type of file P12" 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.
* A .p12 file was also downloaded.
*A new service account with a Service account client ID and a Service account EMail. You need here to enter the Service account EMail.
*A .p12 file was also downloaded.
If you choose to synchronize to only 1 unique Google agenda target or to one different agenda for each user, you have only to create 1 service account. However, you may need to give permissions to all google account if you set 1 different agenda for each user (see step 5).
If you choose to synchronize to only 1 unique Google agenda target or to one different agenda for each user, you have only to create 1 service account. However, you may need to give permissions to all google account if you set 1 different agenda for each user (see step 5).
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
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
{{GoogleURLToSetupCalendarAppSharing}} and check that sharing option of Agenda application allows sharing with external service account. [[File:Warning.png]] A 24h delay may be required to be able to return and finish step 5.
{{GoogleURLToSetupCalendarAppSharing}}
and check that sharing option of Agenda application allows sharing with external service account. [[File:Warning.png]] A 24h delay may be required to be able to return and finish step 5.
'''TroubleShooting'''
'''TroubleShooting'''
* If you receive error "ERROR Error calling POST https://www.googleapis.com/calendar/v3/calendars/yourcalendarid/events: (404) Not Found": Check the step 5 was done.
*If you receive error "ERROR Error calling POST https://www.googleapis.com/calendar/v3/calendars/yourcalendarid/events: (404) Not Found": Check the step 5 was done.
*If you receive error "ERROR Error calling POST https://www.googleapis.com/calendar/v3/calendars/yourcalendarid/events: (403) Forbidden": Check the step 5 was done and that permission granted was read and write and not read only.
* If you receive error "ERROR Error calling POST https://www.googleapis.com/calendar/v3/calendars/yourcalendarid/events: (403) Forbidden": Check the step 5 was done and that permission granted was read and write and not read only.
*[[File:Warning.png]] Note: A possible error is that Google denies access, even if your setup is correct, just because the server that host Dolibarr is located into another country or region than the one 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.
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.
If it appears Google has blocked access attempts from an unusual location, accept this attempt. Then, you must wait 24 hours to try again.
* [[File: Warning.png]] Note: Another possible error is that Google denies access even if your setup is correct, because you turn on Google option 2-step validation. To check if you have actually enabled this option, go to the page: {{GoogleURLToSetup2StepValidation}}
*[[File: Warning.png]] Note: Another possible error is that Google denies access even if your setup is correct, because you turn on Google option 2-step validation. To check if you have actually enabled this option, go to the page: {{GoogleURLToSetup2StepValidation}}
If in the "Validation in two stages," you have "On", try to disable it. Module should works even with the two step validation on, but errors are easier to diagnose if this option if off.
If in the "Validation in two stages," you have "On", try to disable it. Module should works even with the two step validation on, but errors are easier to diagnose if this option if off.
* [[File: Warning.png]] Note: Another possible error is that Google denies access even if your setup is correct, because the server Dolibarr runs on or your local computer is not on time. Check that date and hour of your computer and server are correct.
*[[File: Warning.png]] Note: Another possible error is that Google denies access even if your setup is correct, because the server Dolibarr runs on or your local computer is not on time. Check that date and hour of your computer and server are correct.
==Setup of Google Contact==
This module allows you to synchronize Dolibarr with your Google contact annuary. The object you can synchronize are:
* Third-Parties
* Addresses
* Members of the module Association / Foundation
Synchronisation can be done toward only 1 Google account. However, using the Google sharing features (delegate contacts), several Google accounts could see them.
2) Then go on the setup page of Google module in Dolibarr, choose all Dolibarr elements you want to synchronize among (You can choose several choices):
2) Then go on the setup page of Google module in Dolibarr, choose all Dolibarr elements you want to synchronize among (You can choose several choices):
* Thirdparties (if module Thirdparty is enabled)
* Contacts/addresses of thirdparties (if module Thirdparty is enabed)
*Thirdparties (if module Thirdparty is enabled)
* Members (if module foundation members is enabled)
*Contacts/addresses of thirdparties (if module Thirdparty is enabed)
*Members (if module foundation members is enabled)
For each type of synchronization activated, enter a label of the Google Group of your choice. This is the group visible into Google to group all records together. Group will be created into Google Contact if not exists. You can also use a label of one of any predefined Google system group like: '''"System Group: My Contacts", "System Group: Friend", "System Group: CoWorker", "System Group: Family"'''
For each type of synchronization activated, enter a label of the Google Group of your choice. This is the group visible into Google to group all records together. Group will be created into Google Contact if not exists. You can also use a label of one of any predefined Google system group like: '''"System Group: My Contacts", "System Group: Friend", "System Group: CoWorker", "System Group: Family"'''
Then enter the following information:
Then enter the following information:
# The Google login account (example myaccount@gmail.com or myname@mycompany.com)
#The Google login account (example myaccount@gmail.com or myname@mycompany.com)
# The Google Client ID and the Google Client Secret. You can create your Google Client ID and Secret from page {{ModuleGoogleUrlToCreateApiAccount}}, menu "API & Authentication" -> "Credentials". Click on "Create a client ID" and choose "Web Application", set "Allowed Javascript origin" to empty and set "Redirect URI" to the value provided into the "Note" on the setup page. It should be something like http://mycompanydomain/.../google/oauth2callback.php
#The Google Client ID and the Google Client Secret. You can create your Google Client ID and Secret from page {{ModuleGoogleUrlToCreateApiAccount}}, menu "API & Authentication" -> "Credentials". Click on "Create a client ID" and choose "Web Application", set "Allowed Javascript origin" to empty and set "Redirect URI" to the value provided into the "Note" on the setup page. It should be something like http://mycompanydomain/.../google/oauth2callback.php
# Then click on button "Create". You will get a new '''Client ID''' and a '''Secret code'''. Save the Google setup page after filling Client ID and Secret Code.
#Then click on button "Create". You will get a new '''Client ID''' and a '''Secret code'''. Save the Google setup page after filling Client ID and Secret Code.
# A warning should say you don't have yet any Google token saved into your Dolibarr database. Click on the link to authenticate, enter your Google credential if requested (same account than the account entered at step 2 and accept any confirmation. You should go back on the Dolibarr setup page, but a value for the token, saved into your Dolibarr database should appears.
#A warning should say you don't have yet any Google token saved into your Dolibarr database. Click on the link to authenticate, enter your Google credential if requested (same account than the account entered at step 2 and accept any confirmation. You should go back on the Dolibarr setup page, but a value for the token, saved into your Dolibarr database should appears.
Buttons to make synchronization tests should be available. Click on them to make tests.
Buttons to make synchronization tests should be available. Click on them to make tests.
'''TroubleShooting'''
'''TroubleShooting'''
* [[File:Warning.png]] Note: A possible error is that Google denies access, even if your setup is correct, just because the server that host Dolibarr is located into another country than country uou are using google apps usually.
*[[File:Warning.png]] Note: A possible error is that Google denies access, even if your setup is correct, 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.
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.
If it appears Google has blocked access attempts from an unusual location, accept this attempt. Then, you must wait 24 hours to try again.
* [[File: Warning.png]] Note: Another possible error is that Google denies access even if your setup is correct, because you turned on Google option 2-step validation. To check if you have actually enabled this option, go to the page: {{GoogleURLToSetup2StepValidation}}
*[[File: Warning.png]] Note: Another possible error is that Google denies access even if your setup is correct, because you turned on Google option 2-step validation. To check if you have actually enabled this option, go to the page: {{GoogleURLToSetup2StepValidation}}
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:
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:
Retry the test synchronization.
Retry the test synchronization.
* [[File: Warning.png]] Note: Another possible error is that Google denies access even if your setup is correct, because the server Dolibarr runs on or your local computer is not on time. Check that date and hour of your computer and server are correct.
*[[File: Warning.png]] Note: Another possible error is that Google denies access even if your setup is correct, because the server Dolibarr runs on or your local computer is not on time. Check that date and hour of your computer and server are correct.
== Setup of GMaps features ==
==Setup of GMaps features==
1) You must first enable the API for your Google account. For this go on page {{ModuleGoogleUrlToCreateApiAccount}}, menu "API & Authentication" -> "Enable API". Click to enable API for "Google Maps Geocoding API" and "Google Maps JavaScript API".
1) You must first enable the API for your Google account. For this go on page {{ModuleGoogleUrlToCreateApiAccount}}, menu "API & Authentication" -> "Enable API". Click to enable API for "Google Maps Geocoding API" and "Google Maps JavaScript API".
2) Create an API key of type "Server" and enter it on the setup page of module Google in Dolibarr, tab GMaps.
2) Create an API key of type "Server" and enter it on the setup page of module Google in Dolibarr, tab GMaps.
=== Link to localize a specific address ===
===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):
Choose elements on which you want to see a GMaps picto after addresses, among (you can choose several choices):
* Third parties (if module Third party is enabled)
* Contacts/addresses of third parties (if module Third party is enabled)
*Third parties (if module Third party is enabled)
* Members (if module foundation members is enabled)
*Contacts/addresses of third parties (if module Third party is enabled)
*Members (if module foundation members is enabled)
Then define the zoom level to define scale used by default when a map will be output (value from 1 to 10, 10 is the more accurate zoom level). 7 is a recommended value.
Then define the zoom level to define scale used by default when a map will be output (value from 1 to 10, 10 is the more accurate zoom level). 7 is a recommended value.
=== Links to global maps ===
===Links to global maps===
The other feature provided by module, is to show a global map with all your third parties, contact/addresses or members. To see link to those maps, go into menu Home -Setup - Boxes/Widgets.
The other feature provided by module, is to show a global map with all your third parties, contact/addresses or members. To see link to those maps, go into menu Home -Setup - Boxes/Widgets.
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.
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==
==Setup of Adsense==
If you want to enable adsense feature, on Adsense tab, enter:
If you want to enable adsense feature, on Adsense tab, enter:
* Your adsense customer id (ca-pub-xxxxxx)
*Your adsense customer id (ca-pub-xxxxxx)
Id specific to ad shown (you can find this id into Google adsenses dashboard adsense.google.com)
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.
An advert will be added onto demo and logon page.
== Setup of Google analytics ==
==Setup of Google analytics==
If you want to enable analytics feature, on Analytics tab, enter:
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.
*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.
The Google Analytics tag will be then output onto all Dolibarr pages.
= Usage =
=Usage=
== Usage of Google Agendas features ==
==Usage of Google Agendas features==
=== If you activate synchronization ===
===If you activate synchronization===
* Dolibarr -> Google: Just go onto Google calendar, after creating or editing a Dolibarr event. You should see it into Google calendar (for example on calendar of your Android smartphone).
*Dolibarr -> Google: Just go onto Google calendar, after creating or editing a Dolibarr event. You should see it into Google calendar (for example on calendar of your Android smartphone).
* Google -> Dolibarr: If you need to synchronize changes done on Google side, go onto the agenda view. You should see a link to force synchronization from Google to Dolibarr. See example here. Link is sentence "'''Click to resfresh agenda database with ...'''"
*Google -> Dolibarr: If you need to synchronize changes done on Google side, go onto the agenda view. You should see a link to force synchronization from Google to Dolibarr. See example here. Link is sentence "'''Click to resfresh agenda database with ...'''"
<div class="divforimgcentpercent">
<div class="divforimgcentpercent">
</div>
</div>
=== If you enabled feature to show Google agenda ===
===If you enabled feature to show Google agenda===
Choose menu Agenda Google, the agenda will be shown.
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.
If you have defined several agendas, you can limit view for only one of them using the left menu.
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).
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).
== Usage of Google Contact feature ==
==Usage of Google Contact feature==
* Dolibarr -> Google: Create or edit a thirdparty, contact or memeber (depending on which sync you enabled). Then go to Google contact. You should see the card created into Google.
* Google -> Dolibarr: Change on this direction is not supported.
*Dolibarr -> Google: Create or edit a thirdparty, contact or memeber (depending on which sync you enabled). Then go to Google contact. You should see the card created into Google.
*Google -> Dolibarr: Change on this direction is not supported.
== Usage of GMaps feature ==
==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.
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.
</div>
</div>
== Usage of Adsense feature ==
==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.
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.
Note: When Dolibarr is used with the [[Application Android - DoliDroid]], advert will not be active.
== Usage of Google Analytics ==
==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.
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.
Note: When Dolibarr is used with the [[Application Android - DoliDroid]], tag will not be active.
= Development =
=Development=
{{TemplateModNLTechnoEn}}
{{TemplateModNLTechnoEn}}