Dolibarr ERP CRM Wiki - User contributions [en]

Installation - Upgrade

2020-07-04T16:29:33Z

Julian: Minor grammatical changes, corrected misspelling of 'package'

[[fr:Installation_-_Mise_à_jour]]
[[es:Instalación_-_Actualización]]
[[zh:安装_-_升级]]


[[Category:Admin_en]]
{{TemplateDocUser}}

The following documentation describes processes to install or upgrade Dolibarr on a Windows, MAC OS or Unix like platform.

=Install Dolibarr=
This chapter describe different available methods to install Dolibarr for the first time (from the most simple to the manual one). See next chapter for upgrades.

==On your dedicated computer/server (installation "On Premise")==
===[[File:Logo_windows.png]] Manualy or with Doliwamp===
- '''Prerequisite''': Windows

- '''Level''': Non experienced users

This process works only for Windows users and is recommended for user with no computer knowledges. If you are experimented with Apache, PHP and Mysql installation, next chapter is better for you.

If you have time and want to learn how to install an Apache, PHP and MariaDB web server, see the [[Manual installation on Windows]] page for step-by-step instructions.

However, if you are a newbie user and running Windows, you can use DoliWamp. DoliWamp is a specialized Dolibarr distribution for Windows. This distribution allows you to make an installation under Windows with all prerequisites (Apache, Mysql, PHP) and with no computer knowledge. This is steps to install DoliWamp:

*Download last Dolibarr version for Windows DoliWamp.

For this, see at {{TemplateURLToDownloadDoliWamp}}

*Run the downloaded .exe and follow instructions.

===[[File:Logo_ubuntu.png]] With DoliDeb (Debian or Ubuntu .deb package)===
- '''Prerequisite''': Linux Ubuntu

- '''Level''': Non experienced users

This process works only for Ubuntu or Debian Linux users and is recommended for user with little computer knowledge. If you are experienced with Apache, PHP and Mysql installation, the chapter 'with standard package' is better for you. However, if you are a newbie user and running Ubuntu, you can use DoliDeb. DoliDeb is a specialized Dolibarr distribution for Debian or Ubuntu. This distribution allows you to make an installation under Ubuntu with all prerequisites (Apache, Mysql, PHP) and with no computer knowledge.

*Steps to install DoliDeb are described into page [[Dolibarr for Ubuntu or Debian]].

===[[File:Logo_rpm.png|42px]] With DoliRpm (Fedora, Redhat, Mandriva, Mageia or OpenSuse .rpm package)===
- '''Prerequisite''': Linux Fedora, Redhat, Mandriva, Mageia or OpenSuse

- '''Level''': Non experienced users

This process works only for Fedora, Redhat, Mandriva, Mageia or OpenSuse Linux users and is recommended for user with no computer knowledges. If you are experimented with Apache, PHP and Mysql installation, next chapter 'with standard package' is better for you. However, if you are a newbie user and running Fedora or Redhat, you can use DoliRpm. DoliRpm is a specialized Dolibarr distribution for Fedora, Redhat or Mandriva. This distribution allows you to make an installation under such OS with all prerequisites (Apache, Mysql, PHP) and with no computer knowledge.

*Steps to install DoliRpm are described into page [[Dolibarr for Redhat or Fedora (rpm package)]] or [[Dolibarr for Mandriva or Mageia (rpm package)]] or [[Dolibarr for OpenSuse (rpm package)]].

===[[File:Gnu.png]] With Dolibarr (standard .zip package or from git)===
- '''Prerequisite''': Apache, PHP and a database server (MySQL or PostgreSQL) are already running correctly and user/pass (of a new database or root server) is known.

- '''Level''': Users with few Web and Database administration knowledges.

This procedure describe manual (and recommended) installation on a GNU/Linux system (Debian, Mandriva, ...), it can be used for other OS with minor changes.
You can follow this tutorial for any Dolibarr version >= 2.0.0

*Check that you have installed Apache, PHP {{PHPMinVersion}} and a database server (MySQL {{MySqlMinVersion}} or PostGreSQL) correctly (check list of installed packaged on your server by using the package manager of your distribution). If not, install them (use last recent version).

*Check that main root or admin user/password couple for the server is known and works correctly. If this root or admin user/password is not known because not yet defined, read following chapter. Otherwise go on next step:

For Linux users, if you have just installed a MySQL server, the admin user is''' root'''. If the root password has never been set yet, you must run the following command to initialize the password:
<source lang="bash">
mysql
</source>
Once in Mysql interface, run the SQL command to modify the root password:
<source lang="sql">
grant all privileges on *.* to root@'localhost' identified by 'newrootpass' with grant option;
</source>
Then enter and \q to quit.

To check that connexion with the new couple user/password works, launch the command
<source lang="bash">
mysql -u root -p
</source>
And type your password ''newrootpass'' then \q to quit if connexion has been successfull.

For Linux users, if you have just installed a PostgreSQL server, you must run the following command to initialize an admin user and password. For this, add the following line in file '''/etc/postgresql/x.x/main/pg_hba.conf''' (replace x.x with your postgres version)
<source lang="ini">
local all dolibarrowner md5
</source>
Also, comment the line
<source lang="ini">
#local all all ident
</source>
This line ensure that system login used to connect to database (it will be login the web server run with), is same than database account (this is never the case).

Then launch commands from a root shell
<source lang="bash">
sudo -s -u postgres
createuser dolibarrowner
psql -h localhost -d template1 -c "alter user dolibarrowner with password 'dolibarrownerpass'"
exit
sudo /etc/init.d/postgresql restart
</source>
You can test a connection with this user with command
<source lang="bash">
psql -d postgres -U dolibarrowner -W
</source>
And type your ''dolibarrownerpass'' as password and \q to quit if connection is ok.

*Go into the directory where to install Dolibarr (the web root directory defined for your web server)

#For Debian and Ubuntu families, it is generally: /var/www (newer versions: /var/www/html)
#For Mandriva, RedHat, Fedora: /var/www/html
#For Suse: /srv/www/htdocs

<source lang="bash">
$ cd /var/www
or
$ cd /var/www/html
</source>

*Get the application archive of last stable version

'''from zip file'''
<source lang="bash">
$ wget http://www.dolibarr.org/files/dolibarr.zip
</source>

*Uncompress archive

<source lang="bash">
$ unzip dolibarr.zip
</source>

'''or from git repository'''
<source lang="bash">
$ git clone -b X.Y http://github.com/Dolibarr/dolibarr.git dolibarr
</source>
Replace X.Y with the version you want to get.

*Rename directory dolibarr-x.y.z into dolibarr to have a directory name that does not depends on version (replace x.y.z with source version)

<source lang="bash">
$ mv dolibarr-x.y.z dolibarr
</source>

*Change permission and owner of the 'dolibarr' directory to that of the group under which the web server runs (assumed to be 'www-data' for debian, 'apache' for redhat, mandriva, fedora)

<source lang="bash">
$ chmod -R 755 /var/www/dolibarr
$ chown -R www-data.www-data /var/www/dolibarr
or
$ chmod -R 755 /var/www/html/dolibarr
$ chown -R apache.apache /var/www/html/dolibarr
</source>

*For Fedora, since SELinux is usually enabled, it is also advisable to run the following commands to make the 'dolibarr' directory compliant with the SELinux requirement (else you are likely to get quite a few alerts) :

<source lang="bash">
$ semanage fcontext -a -t httpd_sys_rw_content_t '/var/www/html/dolibarr(/.*)?'
$ restorecon -R -v '/var/www/html/dolibarr'
</source>

*As a root user, create, into directory dolibarr/htdocs/conf, an empty configuration file called conf.php and set, as owner, the web server user (example www-data on Debian, apache on Mandriva, RedHat, Fedora or other distributions ...). This is required because the web server will have to write into this file during install process.

<source lang="bash">
$ cd dolibarr ; touch htdocs/conf/conf.php ; chown www-data htdocs/conf/conf.php
</source>
Note: For Ubuntu no need of htdocs, you just have to make dolibarr root by placing all files and folders of htdocs in /var/www/dolibarr then from browser do <MyIP>/dolibarr/index.php (see this discussion as reference to this addendum [http://askubuntu.com/questions/874456/php-code-displays-in-browser?noredirect=1#comment1357943_874456])

*As a root user, create a directory that will be used to save all files generated and stocked by Dolibarr (PDf invoices, uploaded images, ...), and attribute to this directory a owner that must be the web server (example www-data on Debian, apache on Mandriva, RedHat, Fedora...). The web server must have write permission into this directory. It is recommanded to use a directory outside of your directory of web pages, for example - "/var/lib/dolibarr/documents"

<source lang="bash">
$ mkdir -p /var/lib/dolibarr/documents ; chown www-data /var/lib/dolibarr/documents
</source>

*Now call your browser to point to the main page

<source lang="ini">
http://127.0.0.1/dolibarr/htdocs/
</source>
or if you didn't create the htdocs directory
<source lang="ini">
http://127.0.0.1/dolibarr/
</source>

*Follow instructions of setup steps until end of install process.

*For security reason, we recommend, once setup is finished, to create a file install.lock into Dolibarr document directory that only root user can delete. This will lock the call of the install process again (you will have to remove this file for upgrades).

If this is not done, Dolibarr will show you a warning once logged by an administrator user.
<source lang="bash">
$ touch /var/lib/dolibarr/documents/install.lock; chmod go-w /var/lib/dolibarr/documents;
</source>

==On a mutualized Web Hosting Provider (without terminal/SSH access)==
It is not possible to provide a generic documentation to install Dolibarr on a particular Web hosting provider as this depends on provider.
In most cases, using the following process should works for most providers:

- '''Prerequisite''': Apache web server, PHP and a database server (MySQL or PostgreSQL) are already running correctly and user/pass (of a new database or root server) is known.

- '''Level''': Users with few Web and Database administration knowledges. Knowledge to use a tool (FTP, SFTP) to upload files on the server.

*Check that you have an Apache web server, PHP and a database server (MySQL or PostGreSQL) that works correctly.

[[File:warning.png]] Warning, check that code page of PHP server and database server are same (utf8 recommended).

*Check that main root or admin user/password couple for the server is known and works correctly. Ask them to your Web Hosting Provider if unknown.

*Get the application archive of last stable version and uncompress it locally.

*Upload all content of htdocs directory to your web root directory, for example using FTP in binary mode.

*Create a directory called "documents" into Dolibarr directory that will serve to save all documents generated and stocked by Dolibarr (PDF invoices, uploaded images, ...). The web server must have write permission into this directory. You can set permissions with your FTP client.

*Now call your browser to point to the main page index.php

*Follow instructions of setup steps until end of install process.

*For security reason, we recommend, once setup is finished, to create a file install.lock into Dolibarr installed directory. This will lock the call of the install process again (you will have to remove it for upgrades). If this is not done, Dolibarr will show you a warning once logged as an administrator user.

==On a SaaS or Cloud web hosting provider==
Dolibarr is also available on a lot of "ready to use" SaaS or Cloud platforms/services that provides preinstalled versions.

See page [[Cloud Solutions]].

Dolibarr can also be installed manually on all Cloud platforms that support PHP and Mysql.

See page [[Cloud Solutions]].

=Setup=

==First setup==
See page [[First setup|Setup]].

==Setup a LDAP connexion==
If you want to use a LDAP: See [[Install and configure OpenLDAP]].

=Import external data=
For this operation, read page [[Mass imports]].

=Upgrade Dolibarr=
This chapter describe process to upgrade an existing installation of Dolibarr from an old version to a new one. Process is same whatever is version you are coming fro and version you are going to, but will differ according to the distribution/operating system you used for your first installation. You should use the same for upgrade.

==[[File:Logo_windows.png]] With DoliWamp (Windows .exe package)==

*First make a backup of your current installation
*Download new .exe package of DoliWamp.
*Run downloaded .exe file and follow steps without changing any default values. This will upgrades all your files.
*At the end of the execution, your browser is launched with a page to ask you to run upgrade of your database. Choose the upgrade according to your case.

If there is more than one version late, the page in your browser will loop to start again the upgrade wizard as often as required to run upgrade process, version by version, until your reach the new installed version.

==[[File:Logo_ubuntu.png]] With DoliDeb (Debian or Ubuntu .deb package)==

*First make a backup of your current installation
*Process to upgrade using Debian/Ubuntu package is same way than install process (see previous chapters), so it is as easy as installing a package.

You can also read page [[Dolibarr for Ubuntu or Debian]].

==[[File:Logo_rpm.png|40px]] With DoliRpm (Fedora, Redhat, Mandriva, Mageia or OpenSuse .rpm package)==

*First make a backup of your current installation
*Process to upgrade using rpm package is same way than install process, so it is as easy as installing a package (see previous chapters).

==[[File:Gnu.png]] With Dolibarr (standard .zip package)==
This is tutorial to use when using standard distribution for a manual upgrade.

*First make a backup of your current installation

*Go into the directory where you installed Dolibarr (it might be the root directory of your web, for example /var/www under Debian)

<source lang="bash">
$ cd /var/www
</source>

*Get archive of last version

<source lang="bash">
$ wget https://www.dolibarr.org/files/dolibarr.zip
</source>

*Uncompress the archive

<source lang="bash">
$ unzip dolibarr.zip
</source>

*Copy all new extracted files (the one uncompressed into directory dolibarr-x.y.z) to the directory where you put your old Dolibarr version. This will overwrite old files with new ones without removing files specifics to your installation (like conf.php file or complementary non official installed modules).

<source lang="bash">
$ cp -r dolibarr-x.y.z/* dolibarr
</source>

*If no error, you can now remove the directory of source files

<source lang="bash">
$ rm -fr dolibarr-x.y.z
</source>

*Now open your Dolibarr in your browser. It should open automatically the install/

and choose ''Update'' in suggested menu.

Note:

If you want to script the database upgrade process (to avoid the upgrade process from web browser), you can run the 3 upgrade processes from command line:
<source lang="bash">
$ cd htdocs/install
$ php upgrade.php oldx.oldy.oldz x.y.z > output.html
$ php upgrade2.php oldx.oldy.oldz x.y.z > output2.html
$ php step5.php oldx.oldy.oldz x.y.z > output3.html
</source>
Note: z must be "0" because only major versions have a migration script to run.

Return code will be 0 if success, 1 if error (if this happens, see file output.html or output2.html).

Note: If you have a message that tell the install process is locked by a file, remove the file install.lock stored in Dolibarr root directory.

*For security reason, once setup is finished, you should create a file install.lock into Dolibarr documents directory. This will lock the call of the install process again (you will have to remove this file for future upgrades). If this is not done, Dolibarr will show you a warning once logged with an administrator user.

<source lang="bash">
$ echo > documents/install.lock
$ chmod 444 documents/install.lock
</source>

Triggers system

2020-06-12T14:10:46Z

Julian: A few minor grammatical changes

[[fr:Système de Triggers]]
[[es:Triggers-acciones]]


{{TemplateDocDevEn}}

=Execute your own code on a Dolibarr business event=
To execute personalized code after a Dolibarr event (create/modify/remove a third party/invoice/product or other), Dolibarr offers a mechanism of business triggers. This mechanism allows you to personalize a work-flow to have Dolibarr business events being synchronized into another application for example.
You can also use triggers to modify the behavior of Dolibarr itself: for example, to create a contract automatically when an invoice is validated.

Note that triggers is a feature for developers that is limited to business CRUD events (Create | Read | Update | Delete). There is another feature for developers to inject custom code in the application called the [[Hooks system]].

So, to add your own code that will be triggered by a Dolibarr trigger, this is the process:

1) Copy the trigger file '''htdocs/core/triggers/interface_90_all_Demo.class.php-NORUN''' under the new name: 

*'''interface_99_all_''Xxx''.class.php'''

or

*'''interface_99_mod''MyModule_Xxx''.class.php'''

where ''Xxx'' is a string of your choice starting with uppercase character, ''99'' is the priority number for the execution of your trigger (1 being the top priority) and ''MyModule'' is the name of a module if you want that trigger is activated only if module MyModule is activated. If you want the trigger to be always active, use ''all'' instead of modMyModule.
This new file must be saved inside same directory.

Note: Value you can use for mod MyModule are values found in directory
''htdocs/includes/modules''.

'''WARNING''': '''All''' those parameters are necessary for the trigger to be detected and executed! Eg: if you forget the priority number, your trigger won't be detected!

For example, you can name your new trigger file:
''htdocs/includes/triggers/interface_99_modFacture_Myworkflow.class.php''

By creating such a file with a name like the example, your new trigger file will be executed each time a Dolibarr business event occurs but only if the module Facture is enabled.

'''Note''': With Dolibarr 3.2+, you can also place the triggers in your own module's subdirectly. Eg: if your module resides in htdocs/mymodule/, then you can place your triggers inside htdocs/mymodule/core/triggers/. But for this, you must declare the trigger into your module descriptor file (eg: '''/mymodule/core/modules/modMyModule.class.php'''). For this, add into this file triggers->1 into module_parts array:
<source lang="php">
// Defined all module parts (triggers, login, substitutions, menus, etc...) (0=disable,1=enable)
$this->module_parts = array('triggers' => 1);
//$this->module_parts = array('triggers' => 1,
// 'login' => 0,
// 'substitutions' => 0,
// 'menus' => 0);
</source>
Then disable and reenable your module. This will add a record into [[Table llx_const]] to tell Dolibarr that a trigger file must be searched in the module directory '''htdocs/mymodule/core/triggers/'''

2) Edit the file ''interface_99_modMyModule_Myworkflow.class.php'' to rename class ''InterfaceDemo'' by ''InterfaceMyworkflow''

Then go on page Home -> Admin Tools -> About Dolibarr ->Triggers.
Your new trigger file must appears in the list without any error message. This means preceding actions have been done successfully.

3) Return now to edition of file to add your own code inside function ''run_trigger''.
This function is called at each Dolibarr business event. Put your code according to events on which you want to run. Each event is identified by a code (see following chapter to get full list of codes). So you can react or no after an event by doing just a test on variable '''$action''':

<source lang="php">
function run_trigger($action,$object,$user,$langs,$conf)
{
// Put here code to execute after an action
// The type of Dolibarr business event is stored into $action
// Data of action are stored into object $object
// Setup, user and language are saved into $conf, $user and $lang
if ($action == 'COMPANY_CREATE')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_MODIFY')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_DELETE')
...
}
</source>

You can do what you want into this coding part, if you check that function run_trigger returns a return code according to following rule:

<0 if KO, 0 if nothing is done, >0 if OK

You can also use, inside this function, the following preinitialized variables:

*'''$object''' is the object on which action is done (see next chapter)
*'''$user''' is the object containing all information of Dolibarr user that realizes the business event.
*'''$langs''' is the object that contains the user language and translations strings
*'''$conf''' is the object that contains all the Dolibarr configuration.

4) Once your trigger file has been developed, last action is to test by using Dolibarr to execute the business event that should trigger your code. Warning, call of function '''run_trigger''' is encapsulated into a transaction. If your code return a KO code, the calling function may rollback the transaction (this depends on calling function).
Add log information inside your function '''run_trigger''' to know if your code is correctly triggered and runs correctly. For this, you can use the function
dol_syslog("my log message", LOG_DEBUG);

=List of known triggers actions=

Here is a quick view of the events that cause triggers to be searched and executed. An event is characterized by the value of the code ''$action'', with the type of the object received in ''$object''.

Note: The [[Module Agenda En|Module Agenda]] and [[Module Notification]] use the table [[Table llx c action trigger]] as a list of known triggers. This avoid scanning the disk for this information, but this table is just a very limited list.

In general, the trigger action code begins with the name of the module followed by the character _.

{{TemplateListOfTriggers}}
This list may be not complete.

=Manage and create a new trigger's action=

To manage events other than those above, you must modify the Dolibarr code to add the following sequence in the business methods of the classes of the objects handled:

<source lang="php">
// Call trigger
//$this->context = array('paramX'=>$valueX);
$result = $this->call_trigger('XXXXX_YYYYY', $user);
if ($result <0) $error++;
// End call triggers
</source>

It will then be possible to add in the run_trigger method of any trigger file, an if which allows you to manage this code. The run_trigger method would then be of the form:

<source lang="php">
function run_trigger($action,$object,$user,$lang,$conf)
{
// Put here code to execute after an action
// The type of Dolibarr business event is stored into $action
// Data of action are stored into object $object
// Setup, user and language are saved into $conf, $user and $lang
if ($action == 'XXXXX_YYYYY')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_CREATE')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_MODIFY')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_DELETE')
...
}
</source>

=Conclusion=
You can in few minutes, add an interface from Dolibarr towards another system (or why not towards Dolibarr itself), with no risk since you don't touch anything to Dolibarr files. You only "added" a new trigger file inside the trigger directory.
If this new interface can serve a lot of other users, you can package it into a tgz file (see page [[Module_development#Create_a_package_to_distribute_and_install_your_module]]) and submit it on the download area in section external contributions on official Dolibarr web site.

=See also=

*[[Hooks system]]
*[[Interfaces Dolibarr toward foreign systems]]
*[[Interfaces from foreign systems toward Dolibarr]]

Import data with LibreOffice

2020-06-12T13:25:23Z

Julian: moved content to interlang

=Pre-requisites=
First make sure you have everything you need, OpenOffice, Java Runtime Environment, and the JDBC connector for MySql. Generally, you can follow this tutorial on the OpenOffice site to set up the connector.

If your base is not local, check that port 3306 of the Mysql server is accessible from the internet and that the user of the base has access rights from the IP address where you make the requests. (different from localhost)

'''We will take the example of importing Customers / Suppliers.'''

=Create the customer table=
First you need to prepare a summary table of the data to import.

Here is a blank database to fill in to list your third parties: Llx_societe.ods

Here's another blank base for your physical third party contacts: Llx_socpeople.ods

The principle is simple, whatever the table to import (see the complete list), just put the fields of this table in the first line. Then fill in the other lines with your data. Save your file (it's more careful), but leave it open.

=Create an OpenOffice link to the Dolibarr database=
Then create a new OOo database, File> New> Database

Check "Connect to an existing database" Select MySQL from the drop-down list.

Click on ''Next''

Select Connection using JDBC and do Next

Fill in the fields as below (make the name of your Dolibarr database and the address of the MySQL server)

To enter your MySQL username, check Password required (if it is, but I hope so)

There, nothing to change, do Finish

Save your base according to the name that suits you.

You will be asked for the Root password when connecting to the base.

You are now directly connected to your Dolibarr database on MySQL.

'''Please note: everything you do in OpenOffice Base will also be done on your MySQL database, OpenOffice Base serving here as an interface only.'''

=Import of the customer table in the Dolibarr database=
Go back to the data table (under Calc), select all your columns and rows, and make a Copy (CRTL + C)

Return to Base and now select the llx.societe table (just click on it, no need to open it)

Just make a Paste (CRTL + V)

A window appears, do not change anything and click on Next

New window, make sure that the fields correspond well and click on Create

Depending on the size of your Calc table you will have to be a little patient, for 1500 entries you have to wait 2-3 minutes. So be patient.

=Conclusion=
This tutorial works for other tables (products for example), you must always be sure to fill in the 'vital' fields. You can also modify the data by double-clicking on the table of your choice, it's faster than with the Dolibarr interface, but be careful, we modify the data in the database directly, don't forget.

It also works whether it is under Linux (tested under Ubuntu, but I don't see why it won't work under other distributions) or under Windows.

[[Special:Categories|Category]]:

*[[:Category:Imports|Imports]]

Available in french : [[Importer_des_données_avec_OpenOffice]]
or in spanish : [[Importacion con OpenOffice]]

[[fr:Importer_des_données_avec_OpenOffice]]

[[es:Importacion_con_OpenOffice]]


{{ToTranslate}}

Import data with LibreOffice

2020-06-12T13:19:32Z

Julian: Added TODO for this page

[[fr:Importer_des_données_avec_OpenOffice]]
[[es:Importacion_con_OpenOffice]]


{{ToTranslate}} 

=Pre-requisites=
First make sure you have everything you need, OpenOffice, Java Runtime Environment, and the JDBC connector for MySql. Generally, you can follow this tutorial on the OpenOffice site to set up the connector.

If your base is not local, check that port 3306 of the Mysql server is accessible from the internet and that the user of the base has access rights from the IP address where you make the requests. (different from localhost)

'''We will take the example of importing Customers / Suppliers.'''

=Create the customer table=
First you need to prepare a summary table of the data to import.

Here is a blank database to fill in to list your third parties: Llx_societe.ods

Here's another blank base for your physical third party contacts: Llx_socpeople.ods

The principle is simple, whatever the table to import (see the complete list), just put the fields of this table in the first line. Then fill in the other lines with your data. Save your file (it's more careful), but leave it open.

=Create an OpenOffice link to the Dolibarr database=
Then create a new OOo database, File> New> Database

Check "Connect to an existing database" Select MySQL from the drop-down list.

Click on ''Next''

Select Connection using JDBC and do Next

Fill in the fields as below (make the name of your Dolibarr database and the address of the MySQL server)

To enter your MySQL username, check Password required (if it is, but I hope so)

There, nothing to change, do Finish

Save your base according to the name that suits you.

You will be asked for the Root password when connecting to the base.

You are now directly connected to your Dolibarr database on MySQL.

'''Please note: everything you do in OpenOffice Base will also be done on your MySQL database, OpenOffice Base serving here as an interface only.'''

=Import of the customer table in the Dolibarr database=
Go back to the data table (under Calc), select all your columns and rows, and make a Copy (CRTL + C)

Return to Base and now select the llx.societe table (just click on it, no need to open it)

Just make a Paste (CRTL + V)

A window appears, do not change anything and click on Next

New window, make sure that the fields correspond well and click on Create

Depending on the size of your Calc table you will have to be a little patient, for 1500 entries you have to wait 2-3 minutes. So be patient.

=Conclusion=
This tutorial works for other tables (products for example), you must always be sure to fill in the 'vital' fields. You can also modify the data by double-clicking on the table of your choice, it's faster than with the Dolibarr interface, but be careful, we modify the data in the database directly, don't forget.

It also works whether it is under Linux (tested under Ubuntu, but I don't see why it won't work under other distributions) or under Windows.

[[Special:Categories|Category]]:

*[[:Category:Imports|Imports]]

Available in french : [[Importer_des_données_avec_OpenOffice]]
or in spanish : [[Importacion con OpenOffice]]

Import data with LibreOffice

2020-06-12T13:16:36Z

Julian: Initial page creation - still needs formatting and screenshots in English

[[fr:Importer_des_données_avec_OpenOffice]]
[[es:Importacion_con_OpenOffice]]


{{ToTranslate}} 

= Pre-requisites =
First make sure you have everything you need, OpenOffice, Java Runtime Environment, and the JDBC connector for MySql. Generally, you can follow this tutorial on the OpenOffice site to set up the connector.

If your base is not local, check that port 3306 of the Mysql server is accessible from the internet and that the user of the base has access rights from the IP address where you make the requests. (different from localhost)

'''We will take the example of importing Customers / Suppliers.'''

= Create the customer table =
First you need to prepare a summary table of the data to import.

Here is a blank database to fill in to list your third parties: Llx_societe.ods

Here's another blank base for your physical third party contacts: Llx_socpeople.ods

The principle is simple, whatever the table to import (see the complete list), just put the fields of this table in the first line. Then fill in the other lines with your data. Save your file (it's more careful), but leave it open.

= Create an OpenOffice link to the Dolibarr database =
Then create a new OOo database, File> New> Database

Check "Connect to an existing database" Select MySQL from the drop-down list.

Click on ''Next''

Select Connection using JDBC and do Next

Fill in the fields as below (make the name of your Dolibarr database and the address of the MySQL server)

To enter your MySQL username, check Password required (if it is, but I hope so)

There, nothing to change, do Finish

Save your base according to the name that suits you.

You will be asked for the Root password when connecting to the base.

You are now directly connected to your Dolibarr database on MySQL.

'''Please note: everything you do in OpenOffice Base will also be done on your MySQL database, OpenOffice Base serving here as an interface only.'''

= Import of the customer table in the Dolibarr database =
Go back to the data table (under Calc), select all your columns and rows, and make a Copy (CRTL + C)

Return to Base and now select the llx.societe table (just click on it, no need to open it)

Just make a Paste (CRTL + V)

A window appears, do not change anything and click on Next

New window, make sure that the fields correspond well and click on Create

Depending on the size of your Calc table you will have to be a little patient, for 1500 entries you have to wait 2-3 minutes. So be patient.

= Conclusion =
This tutorial works for other tables (products for example), you must always be sure to fill in the 'vital' fields. You can also modify the data by double-clicking on the table of your choice, it's faster than with the Dolibarr interface, but be careful, we modify the data in the database directly, don't forget.

It also works whether it is under Linux (tested under Ubuntu, but I don't see why it won't work under other distributions) or under Windows.

[[Special:Categories|Category]]:

* [[:Category:Imports|Imports]]

Available in french : [[Importer_des_données_avec_OpenOffice]]
or in spanish : [[Importacion con OpenOffice]]

Triggers system

2020-06-11T19:49:32Z

Julian: Corrected typo, added a space

[[fr:Système de Triggers]]
[[es:Triggers-acciones]]


{{TemplateDocDevEn}}

=Execute your own code on a Dolibarr business event=
To execute personalized code after a Dolibarr event (create/modify/remove a third party/invoice/product or other), Dolibarr offers a mechanism of business triggers. This mechanism allows you to personalize a work-flow to have Dolibarr business events being synchronized into another application for example.
You can also use triggers to modify the behavior of Dolibarr itself: for example, to create automatically a contract when an invoice is validated.

Note that triggers is a feature for developers that is limited to business CRUD events (Create | Read | Update | Delete). There is another features for developers to inject custom code in application called the [[Hooks system]].

So, to add your own code that will be triggered by a Dolibarr trigger, this is the way to process:

1) Copy the trigger file '''htdocs/core/triggers/interface_90_all_Demo.class.php-NORUN''' under the new name:

*'''interface_99_all_''Xxx''.class.php'''

or

*'''interface_99_mod''MyModule_Xxx''.class.php'''

where ''Xxx'' is a string of your choice starting with uppercase character, ''99'' is the priority number for the execution of your trigger (1 being the top priority) and ''MyModule'' is the name of a module if you want that trigger is activated only if module MyModule is activated. If you want the trigger to be always active, use ''all'' instead of modMyModule.
This new file must be saved inside same directory.

Note: Value you can use for mod MyModule are values found in directory
''htdocs/includes/modules''.

'''WARNING''': '''All''' those parameters are necessary for the trigger to be detected and executed! Eg: if you forget the priority number, your trigger won't be detected!

For example, you can name your new trigger file:
''htdocs/includes/triggers/interface_99_modFacture_Myworkflow.class.php''

By creating such a file with name as in the example, your new trigger file will be executed each time a Dolibarr business event occurs but only if the module Facture is enabled.

'''Note''': With Dolibarr 3.2+, you can also place the triggers in your own module's subdirectly. Eg: if your module resides in htdocs/mymodule/, then you can place your triggers inside htdocs/mymodule/core/triggers/. But for this, you must declare the trigger into your module descriptor file (eg: '''/mymodule/core/modules/modMyModule.class.php'''). For this, add into this file triggers->1 into module_parts array:
<source lang="php">
// Defined all module parts (triggers, login, substitutions, menus, etc...) (0=disable,1=enable)
$this->module_parts = array('triggers' => 1);
//$this->module_parts = array('triggers' => 1,
// 'login' => 0,
// 'substitutions' => 0,
// 'menus' => 0);
</source>
Then disable and reenable your module. This will add a record into [[Table llx_const]] to tell Dolibarr that a trigger file must be searched in the module directory '''htdocs/mymodule/core/triggers/'''

2) Edit the file ''interface_99_modMyModule_Myworkflow.class.php'' to rename class ''InterfaceDemo'' by ''InterfaceMyworkflow''

Then go on page Home -> Admin Tools -> About Dolibarr ->Triggers.
Your new trigger file must appears in the list without any error message. This means preceding actions have been done successfully.

3) Return now to edition of file to add your own code inside function ''run_trigger''.
This function is called at each Dolibarr business event. Put your code according to events on which you want to run. Each event is identified by a code (see following chapter to get full list of codes). So you can react or no after an event by doing just a test on variable '''$action''':

<source lang="php">
function run_trigger($action,$object,$user,$langs,$conf)
{
// Put here code to execute after an action
// The type of Dolibarr business event is stored into $action
// Data of action are stored into object $object
// Setup, user and language are saved into $conf, $user and $lang
if ($action == 'COMPANY_CREATE')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_MODIFY')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_DELETE')
...
}
</source>

You can do what you want into this coding part, if you check that function run_trigger returns a return code according to following rule:

<0 if KO, 0 if nothing is done, >0 if OK

You can also use, inside this function, the following preinitialized variables:

*'''$object''' is the object on which action is done (see next chapter)
*'''$user''' is the object containing all information of Dolibarr user that realizes the business event.
*'''$langs''' is the object that contains the user language and translations strings
*'''$conf''' is the object that contains all the Dolibarr configuration.

4) Once your trigger file has been developed, last action is to test by using Dolibarr to execute the business event that should trigger your code. Warning, call of function '''run_trigger''' is encapsulated into a transaction. If your code return a KO code, the calling function may rollback the transaction (this depends on calling function).
Add log information inside your function '''run_trigger''' to know if your code is correctly triggered and runs correctly. For this, you can use the function
dol_syslog("my log message", LOG_DEBUG);

=List of known triggers actions=

Here is a quick view of the events that cause triggers to be searched and executed. An event is characterized by the value of the code ''$action'', with the type of the object received in ''$object''.

Note: The [[Module Agenda En|Module Agenda]] and [[Module Notification]] use the table [[Table llx c action trigger]] as a list of known triggers. This avoid scanning the disk for this information, but this table is just a very limited list.

In general, the trigger action code begins with the name of the module followed by the character _.

{{TemplateListOfTriggers}}
This list may be not complete.

=Manage and create a new trigger's action=

To manage events other than those above, you must modify the Dolibarr code to add the following sequence in the business methods of the classes of the objects handled:

<source lang="php">
// Call trigger
//$this->context = array('paramX'=>$valueX);
$result = $this->call_trigger('XXXXX_YYYYY', $user);
if ($result <0) $error++;
// End call triggers
</source>

It will then be possible to add in the run_trigger method of any trigger file, an if which allows you to manage this code. The run_trigger method would then be of the form:

<source lang="php">
function run_trigger($action,$object,$user,$lang,$conf)
{
// Put here code to execute after an action
// The type of Dolibarr business event is stored into $action
// Data of action are stored into object $object
// Setup, user and language are saved into $conf, $user and $lang
if ($action == 'XXXXX_YYYYY')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_CREATE')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_MODIFY')
{
dol_syslog("Trigger for action '$action' launched. id=".$object->id);
}
elseif ($action == 'COMPANY_DELETE')
...
}
</source>

=Conclusion=
You can in few minutes, add an interface from Dolibarr towards another system (or why not towards Dolibarr itself), with no risk since you don't touch anything to Dolibarr files. You only "added" a new trigger file inside the trigger directory.
If this new interface can serve a lot of other users, you can package it into a tgz file (see page [[Module_development#Create_a_package_to_distribute_and_install_your_module]]) and submit it on the download area in section external contributions on official Dolibarr web site.

=See also=

*[[Hooks system]]
*[[Interfaces Dolibarr toward foreign systems]]
*[[Interfaces from foreign systems toward Dolibarr]]

Module Suppliers (developer)

2020-06-10T21:28:26Z

Julian: Minor grammatical edit

[[fr:Module_Fournisseurs_(développeur)]]
[[es:Módulo_Proveedores_(desarrollador)]]


[[Category:Supplier]]
{{TemplateDocDevEn}}
{{TemplateModEN Developer}}
{{BasculeDevUserEn|
name=Supplier|
num=40|
devdoc=This page|
userdoc=[[Module Suppliers Orders]],
[[Module Suppliers Invoices]]|}}

=Feature=
This module manage the following entities:

*Suppliers orders
*Lines of suppliers orders
*Suppliers invoices
*Lines of suppliers invoices

=Entity Supplier orders=
{{TemplateDocDevEntityEn|
class=htdocs/fourn/class/fournisseur.commande.class.php}}

==Business rules==
See [[Module Suppliers Orders]].

==Permissions==

*->fournisseur->commande->lire
*->fournisseur->commande->creer
*->fournisseur->commande->valider
*->fournisseur->commande->approuver
*->fournisseur->commande->approve2 (if option SUPPLIER_ORDER_DOUBLE_APPROVAL is set)
*->fournisseur->commande->commander
*->fournisseur->commande->cloturer

==Different Status==
Number is value of field fk_statut in [[Table llx_commande_fournisseur]].

*0 : draft
*1 : validated (no more a draft)
*2 : appoved (someone approved your request. If option SUPPLIER_ORDER_DOUBLE_APPROVAL is set, a second user with permission approve2 has also approved)
*3 : sent to supplier
*4 : received partially
*5 : received completely or closed
*9 : refused (Your manager disagrees with your request)

=Entity Supplier invoices=
{{TemplateDocDevEntityEn|
class=htdocs/fourn/class/fournisseur.facture.class.php}}

==Business rules==
See [[Module Suppliers Invoices]].

==Life cycle==

==Permissions==

*->fournisseur->facture->lire
*->fournisseur->facture->creer
*->fournisseur->facture->valider
*->fournisseur->facture->supprimer
*->fournisseur->facture->export

=Tables SQL=

*[[Table llx_commande_fournisseur|llx_commande_fournisseur]] contient les commandes fournisseurs
*[[Table_llx_commande_fournisseur_log|llx_commande_fournisseur_log]] contient l'historique des changements d'états d'une commande fournisseur
*[[Table_llx_commande_fournisseurdet|llx_commande_fournisseurdet]] contient les lignes de détails d'une commande fournisseur
*[[Table llx_facture_fourn|llx_facture_fourn]] contient les factures fournisseurs
*[[Table llx_facture_fourn_det|llx_facture_fourn_det]] contient les lignes de détails des factures fournisseurs
*[[Table llx_element_element|llx_element_element]] contient les liens commandes fournisseurs - factures fournisseurs

User documentation

2020-06-10T20:32:48Z

Julian: Changed subject/verb order on "What Dolibar is/is not" links

[[es:Documentación_usuarios]]
[[fr:Documentation_utilisateur]]
[[de:Benutzerdokumentation]]
[[zh:用户手册]]


<seo metak="user, documentation, guide, doc, tutorial, usage, help" />
This page is the main index of documents relating to user documentation. For developer documentation, [[Developer documentation|see here]].

=Quick overview of Features=

*[[What Dolibarr Do|What Dolibarr is, What Dolibarr can do]]
*[[What Dolibarr can't do|What Dolibarr is not, What Dolibarr can't do]]

=Installation | Upgrade | Setup=

*[[Prerequisite|Prerequisites]]
*[[Installation - Upgrade]]
*[[First setup|Setup]]

=Administration=

*Migration: [[Mass_imports|Mass imports]] / [[ExportsEn|Exports]]
*[[Backups]] / [[Restores]]
*[[About_pages|About pages]]
*[[Upgrade]]
*[[Purge]]
*[[Audit]]
*[[Users_Sessions|Users Sessions]]
*[[Global_VAT_Update|Global VAT Update]]
*[[Scheduled_jobs|Scheduled jobs]]
*[[Direct_Printing_jobs|Direct Printing jobs]]
*[[Mass_barcode_init|Mass barcode init]]

=Usage (by modules / applications)=
Knowing how to use Dolibarr is knowing how to use its modules, menus, and features.
First, once the installation step is complete (see previous chapters), let's have a look at general information on usage:

*[[General information on usage]] (First steps).

Once general usage is understood, you can have a look at the documentation about all standard business modules. Choose the module you are interested in to see its documentation. Standard modules are modules available by default in all common installation. This is a list of main modules (also available on page [[:Category:List of Modules|List of Modules]]):
{{#dpl:
|category=List of Modules
|ordermethod=title
|order=ascending
|format = <ul type="disc">,<li>[[%PAGE%]],</li>,</ul>
|columns=3
|rowcolformat=width=100%
}}

External modules are modules you can get on other sources than official sources. They are provided by third parties. Most of them can be found in the marketplace https://www.dolistore.com. List of external modules is defined on the page [[:Category:Complementary modules|Complementary modules]].

=Glossary=
See page [[Glossary]]

=FAQ=
All FAQ are available through the index page [[:Category:FAQ EN|FAQ EN]]
[[Category:Proofreading done]]

Module Purchase Orders

2020-06-10T20:29:10Z

Julian: Translation of everything from 'Create a supplier order' to the end of the page.

[[fr:Module_Fournisseurs_Commandes]]
[[es:Módulo_Pedidos_a_proveedores]]


[[Category:Supplier]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Suppliers|
num=40|
devdoc=[[Module Supplier (developer)]]|
userdoc=This page|}}

=Introduction=
The module '''Purchase Orders''', also called '''Supplier Order''' is currently hosted by the module *Supplier*.
You can type in orders you make to your customers, with lines of details, send them to him and received products in stock if you use the [[Module Stocks En]].

=Installation=
{{NoInstallModuleEn}}

=Configuration=
{{ActivationModuleEn}}

=Life cycle / Business rules=
A supplier order follows the following life cycle:
<pre>
Draft (0) --> Validated (1) --> Approved (2) --> Process running (3) --------------------------------/---> Received completely (5)
\ \ \--> Received partially (4) ---/ \
\ \ \--> Canceled (7) \
\ \ \ \
\ \-----------------------\-----------------------------------------\----> Creation of invoice (if module invoice on) or "Classify billed"
\ \
\ \- Canceled (6)
\
\- Refused (9)
</pre>

=Create a supplier order=
The creation of a supplier order is done from the supplier file in the third party or suppliers section of the application, supplier tab. The button allowing it is found in the action bar of the supplier file.

The order is then created in the draft state.

You must then select products sold by the supplier from the given list. If you want to add a new product, it is necessary to go through the interface of the products / services, to create a product then to use the supplier tab of the product sheet and to indicate the minimum price and quantity for this supplier. The product is then available in the list of products from this supplier and can be added to the order line.

=Close a supplier order=
Once the products or services of an order have been received, you must return to the order form to enter the receipt. The status of the order then passes to partially received or completely received depending on the information entered.

=Delete a supplier order=
To delete an order, you need to open its file. An order can only be deleted if it is in draft form. Once validated, it can only be canceled. The deletion of an order erases all the data relating to it.

'''A deleted order cannot be recovered.'''

=Modify a supplier order=
To modify an order, you must open its file. An order can only be modified if it is in draft form.

=Use cases=

{{ExamplesCaseEn
|name=UCSOR01: Supplier Order
|situation=
|actions=
}}