Dolibarr ERP CRM Wiki - User contributions [en]

Module development

2017-12-29T06:00:51Z

Aikhan: /* Generate the PHP DAO class */

[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :
* Add new tables in database
* Add your own menu entries
* Add new screens to edit new tables
* Add or remove tabs on object view (invoice, product, order, event, ...)
* Add predefined exports for the internal export tool
* Add new information boxes in the home page
* Add new substitutions variables
* Define new permissions
* Execute code automatically triggered by a particular Dolibarr action
* Insert your code inside Dolibarr hooks positions
* Add your numbering module
* Add a new document template
* Add a new skin
etc...
All those operations are possible with version 3.2 or more of Dolibarr.

Following chapters presents how to do all of this manually with an easy way. For experienced developers, a method to do this using MDA generation is also on the work. See last chapter for this.

=Example of Template External Module=
A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]

=Create your module =
== Create a Module descriptor for your Module (required) ==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin).

'''Since Dolibarr 6.0, you should use the ModuleBuilder module provided as standard module'''

=== Create your module descriptor ===
The first step is to create a file descriptor for the module.
* Create directory '''/htdocs/''mymodule''/core/modules'''. Then copy the file modMyModule.class.php from the directory dev/skeletons into this directory '''htdocs/''mymodule''/core/modules'''. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').
Next modify the contents of this file as follows:
* Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
* Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of modules id]].
* Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).
Your file descriptor for your module is ready. See next step to activate it.

=== Test your descriptor ===

Launch Dolibarr and go to page '''Setup->module'''?
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.

== Tree of path for new module files (required) ==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only second line is mandatory.

{{TemplateModuleTreeSimple}}

== Create your SQL tables and the PHP DAO class (optional) ==
'''When''': If your module needs to manage data of its own

=== Create your .sql file ===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and load data for your own module must be placed in a directory: Create a subdirectory called "sql" into directory of your module (eg htdocs/mymodule/sql) to put the sql scripts that you will create.

Then check into your descriptor file, into function '''init''' that the line

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

is not commented.

''Rules to follow:''
* Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table, with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).

* To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.

Example of content of a file data.sql
<source lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</source>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

=== Test your .sql files ===

Once the files ready, you can return to Dolibarr to disable the module, drop those tables in database and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

=== Generate the PHP DAO class ===
Once you have created your tables into the database, move to the dev/skeletons directory and run the script

<source lang="bash">php build_class_from_table.php tablename modulename</source>
Note: If the command does not work, try to use php-cli php instead.

This will generate a file '''out.tablename.class.php''' that contains the class to manage table tablename.
In this class, you can find the CRUD methods (Create / Read / Update / Delete) already working to do an insert, a fetch (select), an update, a delete of a row in table.
Remove just the "out" from the file name and put the file in a subdirectory of '''htdocs''' specific to your module (in htdocs/mymodule for example).

A file '''out.tablename_script.php''' has been generated and contains a sample code to use the class for each of the 4 CRUD methods.

'''Since Dolibarr 6.0, the file dev/skeletons/build_class_from_table.php is no more provided. To build a class from a table you should use the ModuleBuilder modules provided as standard module.'''

== The tab management (optional) ==

=== Add or remove your own tabs on object sheets ===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"
* Part 1: The element type (objecttype) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}
* Part 2: A code to identify tab to add (start with +) or to remove (start with -)
* Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
* Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
* Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
* Part 6: The url of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

=== Show tabs navigation into your own pages ===
'''When''': To show all standard tabs of an object (produit, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<source lang="php">require_once($url_fichier) ;</source>

This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :
* Object thirdparty (thirdparty) :
** DOL_DOCUMENT_ROOT/societe/class/societe.class.php
** DOL_DOCUMENT_ROOT/core/lib/company.lib.php
* Object product (product) :
** DOL_DOCUMENT_ROOT/product/class/product.class.php
** DOL_DOCUMENT_ROOT/core/lib/product.lib.php
* Object invoice (invoice) :
** DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php
** DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php
...

'''2. Create and load the object to show into your tab'''

Create instance of object of the correct class and load object from database by using the fetch method of object en providing to this method the id you get from url (ie : /mytab.php?id=1).

''Example :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</source>

'''3. Get list of all tabs to show for your object type'''

Use fonction XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. Parameter to put into this method is the instance of object you want tabs.

The resulting array has the following structure
<source lang="php">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</source>

''Example :''
<source lang="php">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</source>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</source>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

== Create or modify PHP screens (optional) ==
'''When''': If the purpose of your module is to add features that require new or modified screens.

=== Create a new PHP screen ===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''dev/skeletons''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''skeletons_page.php''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.
The modules developed for all version of Dolibarr after the 3.2 should be able to be moved in a different folder than "htdocs", like "htdocs/custom", without having to modify the source code of the module, that's why we make several includes, so this rule must be applied by all modules.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

* $user Objet that contains the characteristics of the user + his permissions.
* $conf Objet that contains Dolibarr configuration.
* $db Objet that contains an opened connection handler to the database.
* $langs Objet that contains the user's language.

Then enter your code to display the page.

* To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):
''Example :''
<source lang="php">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</source>

* To include classes provided with Dolibarr, use the following syntax:
''Example :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== Add some fields into existing forms ===
You may want to provide a module that add more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means disable the "New element" menu entry and adding yours, and disable tab that show element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerfull since you can change everything you want into page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...
* First thing is to add a table, owned by your module, to store value of new fields. This table will have only one column called "rowid" (will contains same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
* Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.
If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

=== Replace parts of screen that are templated (version 3.3+) ===
Some parts of Dolibarr screen are isolated into native PHP template files.
You can develop a module to overwrite such templates with yours.
{{ToComplete}}

=== Add/replace part of fields supported by hooks ===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

=== Database access ===
If you need to edit some data in database inside you own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<source lang="php">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</source>

To read:

<source lang="php">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== Define style of your pages ===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

* class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
* class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
* class="'''flat'''" on all input fields (''input, select, textarea''...).
* class="'''button'''" on HTML fields with type ''input type="submit"''.

=== Use the Dolibarr date picker ===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== Add your own setup page (optional) ==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

=== Create your page to edit parameters ===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

=== Modify the descriptor file of your module ===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php");
</source>
If the page is in the directory '''mymodule/admin/''', then like this:
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</source>

=== Test your page ===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

== Define your entries in menu (optional) ==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

=== Define your menu entries ===
For this, you must define into the module descriptor, the array this->menu that declare all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

To show menu or not depending on a permission, modify property '''perms''' in array. See chapter on permissions later to see how to add permissions.

=== Test your menu entries ===
Disable and reenable your module under Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

== Add your own permissions (optional) ==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<source lang="php">
$this->rights_class = 'mymodule'
</source>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</source>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any new created user.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''').
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<source lang="php">
if ($user->rights->mymodule->action->subaction) ...
</source>

== Define you own box (optional) ==
'''When''': If your module need to provide one or several new boxes to show on home page.

=== Define your box ===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<source lang="php">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</source>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

=== Test if your box is detected by Dolibarr ===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activated. Activate the box and go on home page to see if the box is showing correctly.

== Define your own export (optional) ==
'''When''': If your module provide new predefined database export profiles (for its own tables or for already existing tables of another module).

=== Define export ===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

=== Test your export ===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

== Define your CSS styles (optional) ==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).

=== Create and declare your style sheet ===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have only one CSS file per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS file only if you need absolutely to add not already existing styles.

Once your style sheet is ready, declare it into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be a relative URL to your CSS file.
For example
<source lang="php">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php'));
</source>

=== Test your style sheet ===
Disable and enable your module.

Go on home page (index.php). Show the HTML source of the page.

You should see into the HTML header, a line that declare your style sheet.

== Add your Javascript functions (optional) ==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

== Run your own code on any Dolibarr event (optional) ==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

== Insert your code inside Dolibarr hooks positions (optional) ==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See previous chapter for adding code during a business event).

See page [[Hooks_system]].

== Add your own numbering rules ==
'''When''': When you need a new rule for generated ref of elements that is not covered by existing rules.

See page [[Create numbering module]].

== Add your document template (optional) ==
'''When''': When you want to personalized your own generated PDF or ODT documents.

Note: To add this feature you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

== Add your skin (optional) ==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions =
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Using MDA =
A method to generate a functional module from a UML model has been developed. More information on the page [[UML2Dolibarr - Build a module using MDA]].

=Create a package to distribute and install your module =
This process must be used to generate a package to submit it on the http://www.dolistore.com market place.
But you can use it to have a package easy to distribute on your on network.

* Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

* Run the script via Perl (need the Perl version 5.0 or later):
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

* The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:
<source lang="bash">
tar -xvf mymodule.zip
</source>

* If you want your module to be public, you can submit it (the zip file) on Dolibarr market place web site: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").
** If your module was build correctly, file will be validated later.
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).

= Enabling/activation condition of external module on DoliStore =

See [[Module_Dolistore_Validation_Rules|Validation Rules]]

Module Sales Orders (developer)

2017-05-17T04:12:40Z

Aikhan: /* Feature */

[[Category:Orders]]
{{TemplateDocDevEn}}
{{TemplateModEN Developer}}
{{BasculeDevUserEn|
name=Order|
num=25|
devdoc=This page|
userdoc=[[Module Customers Orders]]|}}

= Feature =
{{ToTranslate}}

Customer orders module allows you to manage the following entities in Dolibarr:
* Customer orders
* Lines of customer order
Supplier orders are managed by the '''[[Module Suppliers (developer)]]''' module.

= Entity Order =
{{TemplateDocDevEntityEn|
class=htdocs/commande/class/commande.class.php}}

'''Business rules''':
* A command/order has several command/order lines
* It is possible to attach 1 to n contacts for an order
* To complete...

'''Life Cycle''':

* An order can be created in draft mode (Causes trigger ORDER_CREATE)
* An order can be changed (Causes trigger ORDER_UPDATE)
* An order can be validated (Causes trigger ORDER_VALIDATE)

= Permissions =
*->commande->lire
*->commande->creer
*->commande->valider
*->commande->envoyer
*->commande->cloturer
*->commande->annuler
*->commande->supprimer
*->commande->export

= Tables SQL =
* [[Table llx commande|llx_commande]] table principales des commandes clients
* [[Table llx commandedet|llx_commandedet]] détails des commandes clients

Module Sales Orders (developer)

2017-05-17T04:11:07Z

Aikhan: /* Feature */

[[Category:Orders]]
{{TemplateDocDevEn}}
{{TemplateModEN Developer}}
{{BasculeDevUserEn|
name=Order|
num=25|
devdoc=This page|
userdoc=[[Module Customers Orders]]|}}

= Feature =
{{ToTranslate}}

Customer orders module allows you to manage the following entities in Dolibarr:
* Customer orders
* Lines of customer order
Supplier orders are managed by the '''[[Media:Module Suppliers (developer)]]''' module.

= Entity Order =
{{TemplateDocDevEntityEn|
class=htdocs/commande/class/commande.class.php}}

'''Business rules''':
* A command/order has several command/order lines
* It is possible to attach 1 to n contacts for an order
* To complete...

'''Life Cycle''':

* An order can be created in draft mode (Causes trigger ORDER_CREATE)
* An order can be changed (Causes trigger ORDER_UPDATE)
* An order can be validated (Causes trigger ORDER_VALIDATE)

= Permissions =
*->commande->lire
*->commande->creer
*->commande->valider
*->commande->envoyer
*->commande->cloturer
*->commande->annuler
*->commande->supprimer
*->commande->export

= Tables SQL =
* [[Table llx commande|llx_commande]] table principales des commandes clients
* [[Table llx commandedet|llx_commandedet]] détails des commandes clients

Module Sales Orders (developer)

2017-05-17T04:02:22Z

Aikhan: /* Feature */

[[Category:Orders]]
{{TemplateDocDevEn}}
{{TemplateModEN Developer}}
{{BasculeDevUserEn|
name=Order|
num=25|
devdoc=This page|
userdoc=[[Module Customers Orders]]|}}

= Feature =
{{ToTranslate}}

Customer orders module allows you to manage the following entities in Dolibarr:
* Customer orders
* order lines
Supplier orders are managed by the '''supplier''' module.

= Entity Order =
{{TemplateDocDevEntityEn|
class=htdocs/commande/class/commande.class.php}}

'''Business rules''':
* A command/order has several command/order lines
* It is possible to attach 1 to n contacts for an order
* To complete...

'''Life Cycle''':

* An order can be created in draft mode (Causes trigger ORDER_CREATE)
* An order can be changed (Causes trigger ORDER_UPDATE)
* An order can be validated (Causes trigger ORDER_VALIDATE)

= Permissions =
*->commande->lire
*->commande->creer
*->commande->valider
*->commande->envoyer
*->commande->cloturer
*->commande->annuler
*->commande->supprimer
*->commande->export

= Tables SQL =
* [[Table llx commande|llx_commande]] table principales des commandes clients
* [[Table llx commandedet|llx_commandedet]] détails des commandes clients

General information on usage

2017-03-04T07:12:24Z

Aikhan: /* Objects */

{{TemplateDocUser}}
= Starting the application: =
To begin, launch the application, either by clicking on the icon installed on your desktop by the installation package or by typing appropriate URL in your web browser (The URL can be of the form http://localhost/dolibarr/ for local installation but can be different in the case of a manual installation, in that case it will depend on the configuration of your Web server).

After launching application, you should see the login page with at least 2 fields:

* '''Login''': the login of user to connect. If this is a first usage, it is the user entered at last step of the installation (eg admin)
* '''Password''': the password of user to connect. If this is a first usage, it is the password entered at last step of the installation (eg changeme)
[[File: identification.jpg | 360px |center]]

= Homepage =
Once logged in, you see the home page. It contains menu bars (one horizontal bar and one vertical bar) and more informations in the center:

*A box reminding your login account and the date of last access.
*A box of statistics related to all activated modules.
*A box showing 'tasks' table (table containing informations of tasks to be done and tasks behind schedule). A weather sums it up.
*In the lower part, there may be other information boxes. The list depends upon boxes activated via the menu '''Home->Setup->Boxes'''.

= Using the menus =
Each menu in the horizontal bar is related to one module. When a module is activated its associated menu appears in the horizontal menu bar. The menu entry of a module does not appear in the menus until the module has been activated. To activate a module, see page [[First_setup]].

To use a module, click the menu associated with the module, a menu appears in the vertical bar to perform various tasks related to that module.

For example, to list the products in stock (function provided by the Products and Stock modules), click on the menu Products / Services:

[[File:liste_produits.jpg|600px]]

Once a top menu has been selected a left menu appears with various tasks related to the activated module.

For example, menu you can see once top menu Products / Services has been selected:

[[File:menuproduits.jpg|200px]]

Note that the organization of the menus depends on the choice of menu manager configured in '''Home->Setup->Menus'''.

= Objects =
Objects are the generic terms to speak about records managed by the application. It can be for example: a customer, a supplier, an invoice, an order, a proposal, an agenda event, a user, ...

Each object is managed by a Dolibarr module. Depending on the module you enabled or not, some objects may or may not appear in the application.
Dolibarr policy is to use a common way of working for each managed modules or objects.
So, for each object, you will find a menu entry to Create (menu is called "New Object") and a menu entry to list all objects (menu is called "List").
Then clicking on an object found in a list, you can read all properties of the object arranged in several tabs. A button "Modify" is visible to the allowed user to edit the object.

For example, this is a view of left menu to manage third-parties, and card of a selected third-party (click to enlarge):

[[Image:Screenshot thirdparty.png|480px]]

Also, in the list view (clicking menu "List" in the vertical menus), a status symbol/signage will appear in the last column of list of objects. The symbol/signage varies according to object's status within the workflow.
Symbol/signage of status depends on object and its options defined in the module setup dedicated to object management.
Current definition and symbol/signage of status are (with default theme "eldy") :
* [[Image:statut0.png]] Draft Status - Object is not yet validated (White color, no action can be taken on object)
* [[Image:statut1.png]] Validated Status - Object is validated and some actions are now expected on the object (Yellow color).
* [[Image:statut3.png]] More advanced status than Validated - Some actions have been taken on the object, but still some action(s) are expected on it (Color is partially yellow)
* [[Image:statut4.png]] Processed, Active or Enabled Status - No particular action is expected for the object any more, although some event may still occur (Green color, means everything is ok currently)
* [[Image:statut5.png]] Cancelled Status - No specific action can occur for this object (White color with Cross, white means "no action can be taken" and the cross means "anymore")
* [[Image:statut8.png]] Error Status - This status means that there is a critical problem to fix for the object (red color means error)
Note that with other themes, meaning of status will not differ, but color code may change (for example a theme may decide that good color for cancel symbol is "orange" and not "white crossed".

= Features =
Each feature is provided by a module. All modules are documented in the module documentation. For a complete list of modules and their documentation, see the following pages:

*The list of standard modules is defined in page [[:Category:List_of_Modules]]
*The list of external modules (add-ons not provided by default) is set in the complementary modules page [[:Category:Complementary_modules]]

General information on usage

2017-03-04T07:04:27Z

Aikhan: /* Objects */

{{TemplateDocUser}}
= Starting the application: =
To begin, launch the application, either by clicking on the icon installed on your desktop by the installation package or by typing appropriate URL in your web browser (The URL can be of the form http://localhost/dolibarr/ for local installation but can be different in the case of a manual installation, in that case it will depend on the configuration of your Web server).

After launching application, you should see the login page with at least 2 fields:

* '''Login''': the login of user to connect. If this is a first usage, it is the user entered at last step of the installation (eg admin)
* '''Password''': the password of user to connect. If this is a first usage, it is the password entered at last step of the installation (eg changeme)
[[File: identification.jpg | 360px |center]]

= Homepage =
Once logged in, you see the home page. It contains menu bars (one horizontal bar and one vertical bar) and more informations in the center:

*A box reminding your login account and the date of last access.
*A box of statistics related to all activated modules.
*A box showing 'tasks' table (table containing informations of tasks to be done and tasks behind schedule). A weather sums it up.
*In the lower part, there may be other information boxes. The list depends upon boxes activated via the menu '''Home->Setup->Boxes'''.

= Using the menus =
Each menu in the horizontal bar is related to one module. When a module is activated its associated menu appears in the horizontal menu bar. The menu entry of a module does not appear in the menus until the module has been activated. To activate a module, see page [[First_setup]].

To use a module, click the menu associated with the module, a menu appears in the vertical bar to perform various tasks related to that module.

For example, to list the products in stock (function provided by the Products and Stock modules), click on the menu Products / Services:

[[File:liste_produits.jpg|600px]]

Once a top menu has been selected a left menu appears with various tasks related to the activated module.

For example, menu you can see once top menu Products / Services has been selected:

[[File:menuproduits.jpg|200px]]

Note that the organization of the menus depends on the choice of menu manager configured in '''Home->Setup->Menus'''.

= Objects =
Objects are the generic terms to speak about records managed by the application. It can be for example: a customer, a supplier, an invoice, an order, a proposal, an agenda event, a user, ...

Each object is managed by a Dolibarr module. Depending on the module you enabled or not, some objects may or may not appear in the application.
Dolibarr policy is to use a common way of working for each managed modules or objects.
So, for each object, you will find a menu entry to Create (menu is called "New Object") and a menu entry to list all objects (menu is called "List").
Then clicking on an object found in a list, you can read all properties of the object arranged in several tabs. A button "Modify" is visible to the allowed user to edit the object.

For example, this is a view of left menu to manage third-parties, and card of a selected third-party (click to enlarge):

[[Image:Screenshot thirdparty.png|480px]]

Also, in the list view (clicking menu "List" in the vertical menus), a status symbol/signage will appear in the last column of list of objects. The symbol/signage varies according to object's status within the workflow.
Symbol/signage of status depends on object and its options defined in the module setup dedicated to object management.
Current definition and symbol/signage of status are (with default theme "eldy") :
* [[Image:statut0.png]] Draft Status - Object is not yet validated (White color, no action can be taken on object)
* [[Image:statut1.png]] Validated Status - Some actions are now expected on the object (Yellow color).
* [[Image:statut3.png]] More advanced status than Validated - Some actions have been taken on the object, but still some action(s) are expected on it (Color is partially yellow)
* [[Image:statut4.png]] Processed, Active or Enabled - No particular action is expected for the object any more, although some event may still occur (Green color, means everything is ok currently)
* [[Image:statut5.png]] Cancelled Status - No more action is expected on the object. No specific event can occur for this object (White color with Cross, white means "no action can be taken" and the cross means "anymore")
* [[Image:statut8.png]] Error - There is a problem. This status means that there is a critical problem to fix for the object (red color means error)
Note that with other themes, meaning of status will not differ, but color code may change (for example a theme may decide that good color for cancel symbol is "orange" and not "white crossed".

= Features =
Each feature is provided by a module. All modules are documented in the module documentation. For a complete list of modules and their documentation, see the following pages:

*The list of standard modules is defined in page [[:Category:List_of_Modules]]
*The list of external modules (add-ons not provided by default) is set in the complementary modules page [[:Category:Complementary_modules]]

General information on usage

2017-03-04T06:41:38Z

Aikhan: /* Objects */

{{TemplateDocUser}}
= Starting the application: =
To begin, launch the application, either by clicking on the icon installed on your desktop by the installation package or by typing appropriate URL in your web browser (The URL can be of the form http://localhost/dolibarr/ for local installation but can be different in the case of a manual installation, in that case it will depend on the configuration of your Web server).

After launching application, you should see the login page with at least 2 fields:

* '''Login''': the login of user to connect. If this is a first usage, it is the user entered at last step of the installation (eg admin)
* '''Password''': the password of user to connect. If this is a first usage, it is the password entered at last step of the installation (eg changeme)
[[File: identification.jpg | 360px |center]]

= Homepage =
Once logged in, you see the home page. It contains menu bars (one horizontal bar and one vertical bar) and more informations in the center:

*A box reminding your login account and the date of last access.
*A box of statistics related to all activated modules.
*A box showing 'tasks' table (table containing informations of tasks to be done and tasks behind schedule). A weather sums it up.
*In the lower part, there may be other information boxes. The list depends upon boxes activated via the menu '''Home->Setup->Boxes'''.

= Using the menus =
Each menu in the horizontal bar is related to one module. When a module is activated its associated menu appears in the horizontal menu bar. The menu entry of a module does not appear in the menus until the module has been activated. To activate a module, see page [[First_setup]].

To use a module, click the menu associated with the module, a menu appears in the vertical bar to perform various tasks related to that module.

For example, to list the products in stock (function provided by the Products and Stock modules), click on the menu Products / Services:

[[File:liste_produits.jpg|600px]]

Once a top menu has been selected a left menu appears with various tasks related to the activated module.

For example, menu you can see once top menu Products / Services has been selected:

[[File:menuproduits.jpg|200px]]

Note that the organization of the menus depends on the choice of menu manager configured in '''Home->Setup->Menus'''.

= Objects =
Objects are the generic terms to speak about records managed by the application. It can be for example: a customer, a supplier, an invoice, an order, a proposal, an agenda event, a user, ...

Each object is managed by a Dolibarr module. Depending on the module you enabled or not, some objects may or may not appear in the application.
Dolibarr policy is to use a common way of working for each managed modules or objects.
So, for each object, you will find a menu entry to Create (menu is called "New Object") and a menu entry to list all objects (menu is called "List").
Then clicking on an object found in a list, you can read all properties of the object arranged in several tabs. A button "Modify" is visible to the allowed user to edit the object.

For example, this is a view of left menu to manage third-parties, and card of a selected third-party (click to enlarge):

[[Image:Screenshot thirdparty.png|480px]]

Also, in the list view (clicking menu "List" in the vertical menus), a status symbol/signage will appear in the last column of list of objects. The symbol/signage varies according to object's status within the workflow.
Symbol/signage of status depends on object and its options defined in the module setup dedicated to object management.
Current definition and symbol/signage of status are (with default theme "eldy") :
* [[Image:statut0.png]] Draft - Status when object is not yet validated (white color means "don't take care of me" yet)
* [[Image:statut1.png]] Validated - Some actions are expected for the object (that's why color is yellow).
* [[Image:statut3.png]] It is a more advanced status than Validated, some actions have been taken on the object, but some action(s) are still expected on it (that's why color is partially yellow)
* [[Image:statut4.png]] Processed or Active or Enabled - No particular action is expected for the object anymore, even if some event may still occur (green color means everything is ok currently)
* [[Image:statut5.png]] Cancelled - No more action is expected on the object. No specific event can occur for this object (white color means "don't take care of me" and the cross means "anymore")
* [[Image:statut8.png]] Error - There is a problem. This status means that there is a critical problem to fix for the object (red color means error)
Note that with other themes, meaning of status will not differ, but color code may change (for example a theme may decide that good color for cancel symbol is "orange" and not "white crossed".

= Features =
Each feature is provided by a module. All modules are documented in the module documentation. For a complete list of modules and their documentation, see the following pages:

*The list of standard modules is defined in page [[:Category:List_of_Modules]]
*The list of external modules (add-ons not provided by default) is set in the complementary modules page [[:Category:Complementary_modules]]

General information on usage

2017-03-04T06:39:52Z

Aikhan: /* Objects */

{{TemplateDocUser}}
= Starting the application: =
To begin, launch the application, either by clicking on the icon installed on your desktop by the installation package or by typing appropriate URL in your web browser (The URL can be of the form http://localhost/dolibarr/ for local installation but can be different in the case of a manual installation, in that case it will depend on the configuration of your Web server).

After launching application, you should see the login page with at least 2 fields:

* '''Login''': the login of user to connect. If this is a first usage, it is the user entered at last step of the installation (eg admin)
* '''Password''': the password of user to connect. If this is a first usage, it is the password entered at last step of the installation (eg changeme)
[[File: identification.jpg | 360px |center]]

= Homepage =
Once logged in, you see the home page. It contains menu bars (one horizontal bar and one vertical bar) and more informations in the center:

*A box reminding your login account and the date of last access.
*A box of statistics related to all activated modules.
*A box showing 'tasks' table (table containing informations of tasks to be done and tasks behind schedule). A weather sums it up.
*In the lower part, there may be other information boxes. The list depends upon boxes activated via the menu '''Home->Setup->Boxes'''.

= Using the menus =
Each menu in the horizontal bar is related to one module. When a module is activated its associated menu appears in the horizontal menu bar. The menu entry of a module does not appear in the menus until the module has been activated. To activate a module, see page [[First_setup]].

To use a module, click the menu associated with the module, a menu appears in the vertical bar to perform various tasks related to that module.

For example, to list the products in stock (function provided by the Products and Stock modules), click on the menu Products / Services:

[[File:liste_produits.jpg|600px]]

Once a top menu has been selected a left menu appears with various tasks related to the activated module.

For example, menu you can see once top menu Products / Services has been selected:

[[File:menuproduits.jpg|200px]]

Note that the organization of the menus depends on the choice of menu manager configured in '''Home->Setup->Menus'''.

= Objects =
Objects are the generic terms to speak about records managed by the application. It can be for example: a customer, a supplier, an invoice, an order, a proposal, an agenda event, a user, ...

Each object is managed by a Dolibarr module. Depending on the module you enabled or not, some objects may or may not appear in the application.
Dolibarr policy is to use a common way of working for each managed modules or objects.
So, for each object, you will find a menu entry to Create (menu is called "New Object") and a menu entry to list all objects (menu is called "List").
Then clicking on an object found in a list, you can read all properties of the object arranged in several tabs. A button "Modify" is visible to the allowed user to edit the object.

For example, this is a view of left menu to manage third-parties, and card of a selected third-party (click to enlarge):

[[Image:Screenshot thirdparty.png|480px]]

Also, in the list view (clicking menu "List" in the vertical menus), a status symbol/signage will appear in the last column of list of objects. The symbol/signage varies according to object's status within the workflow.
Symbol/signage of status depends on object and its options defined in the module setup dedicated to object management.
Current definition and symbol/signage of status are (with default theme "eldy") :
* [[Image:statut0.png]] Draft - Status when object is not yet validated (white color means "don't take care of me" yet)
* [[Image:statut1.png]] Validated - Some actions are expected for the object (that's why color is yellow).
* [[Image:statut3.png]] It is a more advanced status than Validated, some actions have been taken on the object, but some action(s) are still expected on it (that's why color is partially yellow)
* [[Image:statut4.png]] Processed or Active or Enabled - No particular action is expected for the object anymore, even if some event may still occur (green color means everything is ok currently)
* [[Image:statut5.png]] Cancelled - No more action is expected on the object. No specific event can occur for this object (white color means "don't take care of me" and the cross means "anymore")
* [[Image:statut8.png]] Error - There is a problem. This status means that there is a critical problem to fix for the object (red color means error)
Note that with other themes, meaning of status will not differ, but color code may be change (for example a theme may decide that good color for cancel symbol is "orange" and not "white crossed".

= Features =
Each feature is provided by a module. All modules are documented in the module documentation. For a complete list of modules and their documentation, see the following pages:

*The list of standard modules is defined in page [[:Category:List_of_Modules]]
*The list of external modules (add-ons not provided by default) is set in the complementary modules page [[:Category:Complementary_modules]]

General information on usage

2017-03-04T06:38:04Z

Aikhan: /* Objects */

{{TemplateDocUser}}
= Starting the application: =
To begin, launch the application, either by clicking on the icon installed on your desktop by the installation package or by typing appropriate URL in your web browser (The URL can be of the form http://localhost/dolibarr/ for local installation but can be different in the case of a manual installation, in that case it will depend on the configuration of your Web server).

After launching application, you should see the login page with at least 2 fields:

* '''Login''': the login of user to connect. If this is a first usage, it is the user entered at last step of the installation (eg admin)
* '''Password''': the password of user to connect. If this is a first usage, it is the password entered at last step of the installation (eg changeme)
[[File: identification.jpg | 360px |center]]

= Homepage =
Once logged in, you see the home page. It contains menu bars (one horizontal bar and one vertical bar) and more informations in the center:

*A box reminding your login account and the date of last access.
*A box of statistics related to all activated modules.
*A box showing 'tasks' table (table containing informations of tasks to be done and tasks behind schedule). A weather sums it up.
*In the lower part, there may be other information boxes. The list depends upon boxes activated via the menu '''Home->Setup->Boxes'''.

= Using the menus =
Each menu in the horizontal bar is related to one module. When a module is activated its associated menu appears in the horizontal menu bar. The menu entry of a module does not appear in the menus until the module has been activated. To activate a module, see page [[First_setup]].

To use a module, click the menu associated with the module, a menu appears in the vertical bar to perform various tasks related to that module.

For example, to list the products in stock (function provided by the Products and Stock modules), click on the menu Products / Services:

[[File:liste_produits.jpg|600px]]

Once a top menu has been selected a left menu appears with various tasks related to the activated module.

For example, menu you can see once top menu Products / Services has been selected:

[[File:menuproduits.jpg|200px]]

Note that the organization of the menus depends on the choice of menu manager configured in '''Home->Setup->Menus'''.

= Objects =
Objects are the generic terms to speak about records managed by the application. It can be for example: a customer, a supplier, an invoice, an order, a proposal, an agenda event, a user, ...

Each object is managed by a Dolibarr module. Depending on the module you enabled or not, some objects may or may not appear in the application.
Dolibarr policy is to use a common way of working for each managed modules or objects.
So, for each object, you will find a menu entry to Create (menu is called "New Object") and a menu entry to list all objects (menu is called "List").
Then clicking on an object found in a list, you can read all properties of the object arranged in several tabs. A button "Modify" is visible to the allowed user to edit the object.

For example, this is a view of left menu to manage third-parties, and card of a selected third-party (click to enlarge):

[[Image:Screenshot thirdparty.png|480px]]

Also, in the list view (clicking menu "List" in the vertical menus), a status symbol/signage will appear in the last column of list of objects. The symbol/signage varies according to object's status within the workflow.
Symbol/signage of status depends on object and its options defined in the module setup dedicated to object management.
Current definition and symbol/signage of status are (with default theme "eldy") :
* [[Image:statut0.png]] Draft - Status when object is not yet validated (white color means "don't take care of me" yet)
* [[Image:statut1.png]] Validated - Some actions are expected for the object (that's why color is yellow).
* [[Image:statut3.png]] It is a more advanced status than Validated, some actions have been taken on the object, but some action(s) still is expected for it (that's why color is partially yellow)
* [[Image:statut4.png]] Processed or Active or Enabled - No particular action is expected for the object anymore, even if some event may still occur (green color means everything is ok currently)
* [[Image:statut5.png]] Cancelled - No more action is expected on the object. No specific event can occur for this object (white color means "don't take care of me" and the cross means "anymore")
* [[Image:statut8.png]] Error - There is a problem. This status means that there is a critical problem to fix for the object (red color means error)
Note that with other themes, meaning of status will not differ, but color code may be change (for example a theme may decide that good color for cancel symbol is "orange" and not "white crossed".

= Features =
Each feature is provided by a module. All modules are documented in the module documentation. For a complete list of modules and their documentation, see the following pages:

*The list of standard modules is defined in page [[:Category:List_of_Modules]]
*The list of external modules (add-ons not provided by default) is set in the complementary modules page [[:Category:Complementary_modules]]

General information on usage

2017-03-04T06:34:39Z

Aikhan: /* Objects */

{{TemplateDocUser}}
= Starting the application: =
To begin, launch the application, either by clicking on the icon installed on your desktop by the installation package or by typing appropriate URL in your web browser (The URL can be of the form http://localhost/dolibarr/ for local installation but can be different in the case of a manual installation, in that case it will depend on the configuration of your Web server).

After launching application, you should see the login page with at least 2 fields:

* '''Login''': the login of user to connect. If this is a first usage, it is the user entered at last step of the installation (eg admin)
* '''Password''': the password of user to connect. If this is a first usage, it is the password entered at last step of the installation (eg changeme)
[[File: identification.jpg | 360px |center]]

= Homepage =
Once logged in, you see the home page. It contains menu bars (one horizontal bar and one vertical bar) and more informations in the center:

*A box reminding your login account and the date of last access.
*A box of statistics related to all activated modules.
*A box showing 'tasks' table (table containing informations of tasks to be done and tasks behind schedule). A weather sums it up.
*In the lower part, there may be other information boxes. The list depends upon boxes activated via the menu '''Home->Setup->Boxes'''.

= Using the menus =
Each menu in the horizontal bar is related to one module. When a module is activated its associated menu appears in the horizontal menu bar. The menu entry of a module does not appear in the menus until the module has been activated. To activate a module, see page [[First_setup]].

To use a module, click the menu associated with the module, a menu appears in the vertical bar to perform various tasks related to that module.

For example, to list the products in stock (function provided by the Products and Stock modules), click on the menu Products / Services:

[[File:liste_produits.jpg|600px]]

Once a top menu has been selected a left menu appears with various tasks related to the activated module.

For example, menu you can see once top menu Products / Services has been selected:

[[File:menuproduits.jpg|200px]]

Note that the organization of the menus depends on the choice of menu manager configured in '''Home->Setup->Menus'''.

= Objects =
Objects are the generic terms to speak about records managed by the application. It can be for example: a customer, a supplier, an invoice, an order, a proposal, an agenda event, a user, ...

Each object is managed by a Dolibarr module. Depending on the module you enabled or not, some objects may or may not appear in the application.
Dolibarr policy is to use a common way of working for each managed modules or objects.
So, for each object, you will find a menu entry to Create (menu is called "New Object") and a menu entry to list all objects (menu is called "List").
Then clicking on an object found in a list, you can read all properties of the object arranged in several tabs. A button "Modify" is visible to the allowed user to edit the object.

For example, this is a view of left menu to manage third-parties, and card of a selected third-party (click to enlarge):

[[Image:Screenshot thirdparty.png|480px]]

Also, in the list view (clicking menu "List" in the vertical menus), a status symbol/signage will appear in the last column of list of objects. The symbol/signage varies according to object's status within the workflow.
Symbol/signage of status depends on object and its options defined in the module setup dedicated to object management.
Current definition and symbol/signage of status are (with default theme "eldy") :
* [[Image:statut0.png]] Draft - Status when object is not yet validated (white color means "don't take care of me" yet)
* [[Image:statut1.png]] Validated - Some actions are expected for the object (that's why color is yellow).
* [[Image:statut3.png]] It is a more advanced status than Validated, but action still is expected for object (that's why color is partially yellow)
* [[Image:statut4.png]] Processed or Active or Enabled - No particular action is expected for the object anymore, even if some event may still occur (green color means everything is ok currently)
* [[Image:statut5.png]] Cancelled - No more action is expected on the object. No specific event can occur for this object (white color means "don't take care of me" and the cross means "anymore")
* [[Image:statut8.png]] Error - There is a problem. This status means that there is a critical problem to fix for the object (red color means error)
Note that with other themes, meaning of status will not differ, but color code may be change (for example a theme may decide that good color for cancel symbol is "orange" and not "white crossed".

= Features =
Each feature is provided by a module. All modules are documented in the module documentation. For a complete list of modules and their documentation, see the following pages:

*The list of standard modules is defined in page [[:Category:List_of_Modules]]
*The list of external modules (add-ons not provided by default) is set in the complementary modules page [[:Category:Complementary_modules]]

General information on usage

2017-03-04T06:29:15Z

Aikhan: /* Objects */

{{TemplateDocUser}}
= Starting the application: =
To begin, launch the application, either by clicking on the icon installed on your desktop by the installation package or by typing appropriate URL in your web browser (The URL can be of the form http://localhost/dolibarr/ for local installation but can be different in the case of a manual installation, in that case it will depend on the configuration of your Web server).

After launching application, you should see the login page with at least 2 fields:

* '''Login''': the login of user to connect. If this is a first usage, it is the user entered at last step of the installation (eg admin)
* '''Password''': the password of user to connect. If this is a first usage, it is the password entered at last step of the installation (eg changeme)
[[File: identification.jpg | 360px |center]]

= Homepage =
Once logged in, you see the home page. It contains menu bars (one horizontal bar and one vertical bar) and more informations in the center:

*A box reminding your login account and the date of last access.
*A box of statistics related to all activated modules.
*A box showing 'tasks' table (table containing informations of tasks to be done and tasks behind schedule). A weather sums it up.
*In the lower part, there may be other information boxes. The list depends upon boxes activated via the menu '''Home->Setup->Boxes'''.

= Using the menus =
Each menu in the horizontal bar is related to one module. When a module is activated its associated menu appears in the horizontal menu bar. The menu entry of a module does not appear in the menus until the module has been activated. To activate a module, see page [[First_setup]].

To use a module, click the menu associated with the module, a menu appears in the vertical bar to perform various tasks related to that module.

For example, to list the products in stock (function provided by the Products and Stock modules), click on the menu Products / Services:

[[File:liste_produits.jpg|600px]]

Once a top menu has been selected a left menu appears with various tasks related to the activated module.

For example, menu you can see once top menu Products / Services has been selected:

[[File:menuproduits.jpg|200px]]

Note that the organization of the menus depends on the choice of menu manager configured in '''Home->Setup->Menus'''.

= Objects =
Objects are the generic terms to speak about records managed by the application. It can be for example: a customer, a supplier, an invoice, an order, a proposal, an agenda event, a user, ...

Each object is managed by a Dolibarr module. Depending on the module you enabled or not, some objects may or may not appear in the application.
Dolibarr policy is to use a common way of working for each managed modules or objects.
So, for each object, you will find a menu entry to Create (menu is called "New Object") and a menu entry to list all objects (menu is called "List").
Then clicking on an object found in a list, you can read all properties of the object arranged in several tabs. A button "Modify" is visible to the allowed user to edit the object.

For example, this is a view of left menu to manage third-parties, and card of a selected third-party (click to enlarge):

[[Image:Screenshot thirdparty.png|480px]]

Also, in the list view (clicking menu "List" in the vertical menus), a status symbol/signage will appear in the last column of list of objects. The symbol/signage varies according to object's status within the workflow.
Symbol/signage of status depends on object and its options defined in the module setup dedicated to object management.
Current definition and symbol/signage of status are (with default theme "eldy") :
* [[Image:statut0.png]] Draft - Status when object is not yet validated (white color means "don't take care of me" yet)
* [[Image:statut1.png]] Validated - Some actions are expected for the object (that's why color is yellow).
* [[Image:statut3.png]] It is a more advanced status than Validated, but object still needs action to be done on it (that's why color is partially yellow)
* [[Image:statut4.png]] Processed or Active or Enabled - No particular action is expected for the object, even if some event can still occur (green color means everything is ok currently)
* [[Image:statut5.png]] Cancelled - No more action is expected on the object. No specific event can occur for this object (white color means "don't take care of me" and the cross means "anymore")
* [[Image:statut8.png]] Error - There is a problem. This status means that there is a critical problem to fix for the object (red color means error)
Note that with other themes, meaning of status will not differ, but color code may be change (for example a theme may decide that good color for cancel symbol is "orange" and not "white crossed".

= Features =
Each feature is provided by a module. All modules are documented in the module documentation. For a complete list of modules and their documentation, see the following pages:

*The list of standard modules is defined in page [[:Category:List_of_Modules]]
*The list of external modules (add-ons not provided by default) is set in the complementary modules page [[:Category:Complementary_modules]]

General information on usage

2017-03-04T06:25:13Z

Aikhan: /* Objects */

{{TemplateDocUser}}
= Starting the application: =
To begin, launch the application, either by clicking on the icon installed on your desktop by the installation package or by typing appropriate URL in your web browser (The URL can be of the form http://localhost/dolibarr/ for local installation but can be different in the case of a manual installation, in that case it will depend on the configuration of your Web server).

After launching application, you should see the login page with at least 2 fields:

* '''Login''': the login of user to connect. If this is a first usage, it is the user entered at last step of the installation (eg admin)
* '''Password''': the password of user to connect. If this is a first usage, it is the password entered at last step of the installation (eg changeme)
[[File: identification.jpg | 360px |center]]

= Homepage =
Once logged in, you see the home page. It contains menu bars (one horizontal bar and one vertical bar) and more informations in the center:

*A box reminding your login account and the date of last access.
*A box of statistics related to all activated modules.
*A box showing 'tasks' table (table containing informations of tasks to be done and tasks behind schedule). A weather sums it up.
*In the lower part, there may be other information boxes. The list depends upon boxes activated via the menu '''Home->Setup->Boxes'''.

= Using the menus =
Each menu in the horizontal bar is related to one module. When a module is activated its associated menu appears in the horizontal menu bar. The menu entry of a module does not appear in the menus until the module has been activated. To activate a module, see page [[First_setup]].

To use a module, click the menu associated with the module, a menu appears in the vertical bar to perform various tasks related to that module.

For example, to list the products in stock (function provided by the Products and Stock modules), click on the menu Products / Services:

[[File:liste_produits.jpg|600px]]

Once a top menu has been selected a left menu appears with various tasks related to the activated module.

For example, menu you can see once top menu Products / Services has been selected:

[[File:menuproduits.jpg|200px]]

Note that the organization of the menus depends on the choice of menu manager configured in '''Home->Setup->Menus'''.

= Objects =
Objects are the generic terms to speak about records managed by the application. It can be for example: a customer, a supplier, an invoice, an order, a proposal, an agenda event, a user, ...

Each object is managed by a Dolibarr module. Depending on the module you enabled or not, some objects may or may not appear in the application.
Dolibarr policy is to use a common way of working for each managed modules or objects.
So, for each object, you will find a menu entry to Create (menu is called "New Object") and a menu entry to list all objects (menu is called "List").
Then clicking on an object found in a list, you can read all properties of the object arranged in several tabs. A button "Modify" is visible to the allowed user to edit the object.

For example, this is a view of left menu to manage third-parties, and card of a selected third-party (click to enlarge):

[[Image:Screenshot thirdparty.png|480px]]

Also, in the list view (clicking menu "List" in the vertical menus), a status symbol/signage will appear in the last column of list of objects. The symbol/signage varies according to object's status within the workflow.
Symbol/signage of status depends on the object and its options defined in the module setup dedicated to object management.
Current definition and symbol/signage of status are (with default theme "eldy") :
* [[Image:statut0.png]] Draft - Status when object is not yet validated (white color means "don't take care of me" yet)
* [[Image:statut1.png]] Validated - Some actions are expected for the object (that's why color is yellow).
* [[Image:statut3.png]] It is a more advanced status than Validated, but object still needs action to be done on it (that's why color is partially yellow)
* [[Image:statut4.png]] Processed or Active or Enabled - No particular action is expected for the object, even if some event can still occur (green color means everything is ok currently)
* [[Image:statut5.png]] Cancelled - No more action is expected on the object. No specific event can occur for this object (white color means "don't take care of me" and the cross means "anymore")
* [[Image:statut8.png]] Error - There is a problem. This status means that there is a critical problem to fix for the object (red color means error)
Note that with other themes, meaning of status will not differ, but color code may be change (for example a theme may decide that good color for cancel symbol is "orange" and not "white crossed".

= Features =
Each feature is provided by a module. All modules are documented in the module documentation. For a complete list of modules and their documentation, see the following pages:

*The list of standard modules is defined in page [[:Category:List_of_Modules]]
*The list of external modules (add-ons not provided by default) is set in the complementary modules page [[:Category:Complementary_modules]]

General information on usage

2017-03-04T06:22:40Z

Aikhan: /* Objects */

{{TemplateDocUser}}
= Starting the application: =
To begin, launch the application, either by clicking on the icon installed on your desktop by the installation package or by typing appropriate URL in your web browser (The URL can be of the form http://localhost/dolibarr/ for local installation but can be different in the case of a manual installation, in that case it will depend on the configuration of your Web server).

After launching application, you should see the login page with at least 2 fields:

* '''Login''': the login of user to connect. If this is a first usage, it is the user entered at last step of the installation (eg admin)
* '''Password''': the password of user to connect. If this is a first usage, it is the password entered at last step of the installation (eg changeme)
[[File: identification.jpg | 360px |center]]

= Homepage =
Once logged in, you see the home page. It contains menu bars (one horizontal bar and one vertical bar) and more informations in the center:

*A box reminding your login account and the date of last access.
*A box of statistics related to all activated modules.
*A box showing 'tasks' table (table containing informations of tasks to be done and tasks behind schedule). A weather sums it up.
*In the lower part, there may be other information boxes. The list depends upon boxes activated via the menu '''Home->Setup->Boxes'''.

= Using the menus =
Each menu in the horizontal bar is related to one module. When a module is activated its associated menu appears in the horizontal menu bar. The menu entry of a module does not appear in the menus until the module has been activated. To activate a module, see page [[First_setup]].

To use a module, click the menu associated with the module, a menu appears in the vertical bar to perform various tasks related to that module.

For example, to list the products in stock (function provided by the Products and Stock modules), click on the menu Products / Services:

[[File:liste_produits.jpg|600px]]

Once a top menu has been selected a left menu appears with various tasks related to the activated module.

For example, menu you can see once top menu Products / Services has been selected:

[[File:menuproduits.jpg|200px]]

Note that the organization of the menus depends on the choice of menu manager configured in '''Home->Setup->Menus'''.

= Objects =
Objects are the generic terms to speak about records managed by the application. It can be for example: a customer, a supplier, an invoice, an order, a proposal, an agenda event, a user, ...

Each object is managed by a Dolibarr module. Depending on the module you enabled or not, some objects may or may not appear in the application.
Dolibarr policy is to use a common way of working for each managed modules or objects.
So, for each object, you will find a menu entry to Create (menu is called "New Object") and a menu entry to list all objects (menu is called "List").
Then clicking on an object found in a list, you can read all properties of the object arranged in several tabs. A button "Modify" is visible to the allowed user to edit the object.

For example, this is a view of left menu to manage third-parties, and card of a selected third-party (click to enlarge):

[[Image:Screenshot thirdparty.png|480px]]

Also, in the list view (clicking menu "List" in the vertical menus), a status symbol/signage will appear in the last column of the list of objects. The symbol/signage varies according to object's status within it's workflow.
Symbol/signage of status depends on the object and its options defined in the module setup dedicated to object management.
Current definition and symbol/signage of status are (with default theme "eldy") :
* [[Image:statut0.png]] Draft - Status when object is not yet validated (white color means "don't take care of me" yet)
* [[Image:statut1.png]] Validated - Some actions are expected for the object (that's why color is yellow).
* [[Image:statut3.png]] It is a more advanced status than Validated, but object still needs action to be done on it (that's why color is partially yellow)
* [[Image:statut4.png]] Processed or Active or Enabled - No particular action is expected for the object, even if some event can still occur (green color means everything is ok currently)
* [[Image:statut5.png]] Cancelled - No more action is expected on the object. No specific event can occur for this object (white color means "don't take care of me" and the cross means "anymore")
* [[Image:statut8.png]] Error - There is a problem. This status means that there is a critical problem to fix for the object (red color means error)
Note that with other themes, meaning of status will not differ, but color code may be change (for example a theme may decide that good color for cancel symbol is "orange" and not "white crossed".

= Features =
Each feature is provided by a module. All modules are documented in the module documentation. For a complete list of modules and their documentation, see the following pages:

*The list of standard modules is defined in page [[:Category:List_of_Modules]]
*The list of external modules (add-ons not provided by default) is set in the complementary modules page [[:Category:Complementary_modules]]

General information on usage

2017-03-04T06:17:13Z

Aikhan: /* Objects */

{{TemplateDocUser}}
= Starting the application: =
To begin, launch the application, either by clicking on the icon installed on your desktop by the installation package or by typing appropriate URL in your web browser (The URL can be of the form http://localhost/dolibarr/ for local installation but can be different in the case of a manual installation, in that case it will depend on the configuration of your Web server).

After launching application, you should see the login page with at least 2 fields:

* '''Login''': the login of user to connect. If this is a first usage, it is the user entered at last step of the installation (eg admin)
* '''Password''': the password of user to connect. If this is a first usage, it is the password entered at last step of the installation (eg changeme)
[[File: identification.jpg | 360px |center]]

= Homepage =
Once logged in, you see the home page. It contains menu bars (one horizontal bar and one vertical bar) and more informations in the center:

*A box reminding your login account and the date of last access.
*A box of statistics related to all activated modules.
*A box showing 'tasks' table (table containing informations of tasks to be done and tasks behind schedule). A weather sums it up.
*In the lower part, there may be other information boxes. The list depends upon boxes activated via the menu '''Home->Setup->Boxes'''.

= Using the menus =
Each menu in the horizontal bar is related to one module. When a module is activated its associated menu appears in the horizontal menu bar. The menu entry of a module does not appear in the menus until the module has been activated. To activate a module, see page [[First_setup]].

To use a module, click the menu associated with the module, a menu appears in the vertical bar to perform various tasks related to that module.

For example, to list the products in stock (function provided by the Products and Stock modules), click on the menu Products / Services:

[[File:liste_produits.jpg|600px]]

Once a top menu has been selected a left menu appears with various tasks related to the activated module.

For example, menu you can see once top menu Products / Services has been selected:

[[File:menuproduits.jpg|200px]]

Note that the organization of the menus depends on the choice of menu manager configured in '''Home->Setup->Menus'''.

= Objects =
Objects are the generic terms to speak about records managed by the application. It can be for example: a customer, a supplier, an invoice, an order, a proposal, an agenda event, a user, ...

Each object is managed by a Dolibarr module. Depending on the module you enabled or not, some objects may or may not appear in the application.
Dolibarr policy is to use a common way of working for each managed modules or objects.
So, for each object, you will find a menu entry to Create (menu is called "New Object") and a menu entry to list all objects (menu is called "List").
Then clicking on an object found in a list, you can read all properties of the object arranged in several tabs. A button "Modify" is visible to the allowed user to edit the object.

For example, this is a view of left menu to manage third-parties, and card of a selected third-party (click to enlarge):

[[Image:Screenshot thirdparty.png|480px]]

Also, in the list view (clicking menu "List" in the vertical menus), a status symbol/signage will appear in the last column of the list of objects. The symbol/signage varies according to object's status within it's workflow.
Symbol/signage of status depends on the object and its options defined in the module setup dedicated to object management.
Current definition and symbol/signage of status are (with default theme "eldy") :
* [[Image:statut0.png]] Draft - Status when object is not yet validated (white color means "don't take care of me" yet)
* [[Image:statut1.png]] Validated - Some actions are expected for the object (that's why color is yellow).
* [[Image:statut3.png]] Name of status will varies according to object. It is a more advanced status than Validated, but object still need action to do on it (that's why color is partially yellow)
* [[Image:statut4.png]] Processed or Active or Enabled - No particular action is expected for the object, even if some event can still occur (green color means everything is ok currently)
* [[Image:statut5.png]] Cancelled - No more action is expected on the object. No specific event can occur for this object (white color means "don't take care of me" and the cross means "anymore")
* [[Image:statut8.png]] Error - There is a problem. This status means there is a critical problem to fix on object (red color means error)
Note that with other theme, meaning of status will not differ, but colors codification may be changed (for example a theme can decide good color for cancel theme is "orange" and not "white crossed".

= Features =
Each feature is provided by a module. All modules are documented in the module documentation. For a complete list of modules and their documentation, see the following pages:

*The list of standard modules is defined in page [[:Category:List_of_Modules]]
*The list of external modules (add-ons not provided by default) is set in the complementary modules page [[:Category:Complementary_modules]]

Triggers system

2017-03-03T04:22:24Z

Aikhan: /* Execute your own code on a Dolibarr's action */

{{TemplateDocDevEn}}

= Execute your own code on a Dolibarr's action =
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.

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 MyModyle 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 modMyModule 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-> System Infos -> 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 =
List of all events that launch triggers are available in [[Table llx c action trigger]]. This is a quick list of those events, identified by value of variable '''$action''' into trigger code and type of variable '''$object''' for each code.

In most cases, trigger action code is a key matching this rules:
* Start with module name
* Other information (isolated with character _)
* Action

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

= Manage and create a new trigger's action =

To manage other events on objects than the one defined before, you must edit the Dolibarr code to add the following code inside the business method of the class file of the object:

<source lang="php">
// Call triggers
include_once(DOL_DOCUMENT_ROOT . "/core/class/interfaces.class.php");
$interface=new Interfaces($this->db);
$result=$interface->run_triggers('XXXXX_YYYYY',$this,$user,$langs,$conf);
if ($result < 0) { $error++; $this->errors=$interface->errors; }
// End call triggers
</source>
'''With Dolibarr >= 3.7 you must use this piece of code for new trigger :'''
<source lang="php">
// Call trigger
include_once(DOL_DOCUMENT_ROOT . "/core/class/interfaces.class.php");
$interface=new Interfaces($this->db);
$result=$this->call_trigger('XXXXX_YYYYY',$user); // this is the new way to call triggers with Dolibarr >= 3.7.0
if ($result < 0) { $error++; $this->errors=$interface->errors; }
// End call triggers
</source>

Here, '''$this''' contains the business class with all information to send to the trigger functions. Replace 'XXXXX_YYYYY' by an event code not already used.
Then you will be able to add inside the run_trigger method, a "if" to manage this code. The run_trigger method will contains a part of code like this :

<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 development

2016-04-24T02:19:12Z

Aikhan: /* Generate the PHP DAO class */

[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :
* Add new tables in database
* Add your own menu entries
* Add new screens to edit new tables
* Add or remove tabs on object view (invoice, product, order, event, ...)
* Add predefined exports for the internal export tool
* Add new information boxes in the home page
* Add new substitutions variables
* Define new permissions
* Execute code automatically triggered by a particular Dolibarr action
* Insert your code inside Dolibarr hooks positions
* Add your numbering module
* Add a new document template
* Add a new skin
etc...
All those operations are possible with version 3.2 or more of Dolibarr.

Following chapters presents how to do all of this manually with an easy way. For experienced developers, a method to do this using MDA generation is also on the work. See last chapter for this.

=Example of Template External Module=
A good model to start development of external module can be found here : [https://github.com/rdoursenaud/dolibarr-module-template GitHub Dolibarr Module Modèle]

=Create your module =
== Create a Module descriptor for your Module (required) ==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin).

=== Create your module descriptor ===
The first step is to create a file descriptor for the module.
* Create directory '''/htdocs/''mymodule''/core/modules'''. Then copy the file modMyModule.class.php from the directory dev/skeletons into this directory '''htdocs/''mymodule''/core/modules'''. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').
Next modify the contents of this file as follows:
* Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
* Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of modules id]].
* Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).
Your file descriptor for your module is ready. See next step to activate it.

=== Test your descriptor ===

Launch Dolibarr and go to page '''Setup->module'''?
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.

== Tree of path for new module files (required) ==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only second line is mandatory.

{{TemplateModuleTreeSimple}}

== Create your SQL tables and the PHP DAO class (optional) ==
'''When''': If your module needs to manage data of its own

=== Create your .sql file ===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and load data for your own module must be placed in a directory: Create a subdirectory called "sql" into directory of your module (eg htdocs/mymodule/sql) to put the sql scripts that you will create.

Then check into your descriptor file, into function '''init''' that the line

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

is not commented.

''Rules to follow:''
* Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table, with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).

* To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.

Example of content of a file data.sql
<source lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</source>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

=== Test your .sql files ===

Once the files ready, you can return to Dolibarr to disable the module, drop those tables in database and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

=== Generate the PHP DAO class ===
Once you have created your tables into the database, move to the dev/skeletons directory and run the script

<source lang="bash">php build_class_from_table.php tablename modulename</source>
Note: If the command does not work, try to use php-cli php instead.

This will generate a file '''out.tablename.class.php''' that contains the class to manage table tablename.
In this class, you can find the CRUD methods (Create / Read / Update / Delete) already working to do an insert, a fetch (select), an update, a delete of a row in table.
Remove just the "out" from the file name and put the file in a subdirectory of '''htdocs''' specific to your module (in htdocs/mymodule for example).

A file '''out.tablename_script.php''' has been generated and contains a sample code to use the class for each of the 4 CRUD methods.

== The tab management (optional) ==

=== Add or remove your own tabs on object sheets ===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"
* Part 1: The element type (objecttype) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}
* Part 2: A code to identify tab to add (start with +) or to remove (start with -)
* Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
* Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
* Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
* Part 6: The url of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

=== Show tabs navigation into your own pages ===
'''When''': To show all standard tabs of an object (produit, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<source lang="php">require_once($url_fichier) ;</source>

This is list of those files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :
* Object thirdparty (thirdparty) :
** DOL_DOCUMENT_ROOT/societe.class.php
** DOL_DOCUMENT_ROOT/lib/company.lib.php
* Object product (product) :
** DOL_DOCUMENT_ROOT/product.class.php
** DOL_DOCUMENT_ROOT/lib/product.lib.php
* Object invoice (invoice) :
** DOL_DOCUMENT_ROOT/facture.class.php
** DOL_DOCUMENT_ROOT/lib/invoice.lib.php

'''2. Create and load the object to show into your tab'''

Create instance of object of the correct class and load object from database by using the fetch method of object en providing to this method the id you get from url (ie : /mytab.php?id=1).

''Example :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</source>

'''3. Get list of all tabs to show for your object type'''

Use fonction XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. Parameter to put into this method is the instance of object you want tabs.

The resulting array has the following structure
<source lang="php">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</source>

''Example :''
<source lang="php">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</source>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</source>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

== Create or modify PHP screens (optional) ==
'''When''': If the purpose of your module is to add features that require new or modified screens.

=== Create a new PHP screen ===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''dev/skeletons''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''skeletons_page.php''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.
The modules developed for all version of Dolibarr after the 3.2 should be able to be moved in a different folder than "htdocs", like "htdocs/custom", without having to modify the source code of the module, that's why we make several includes, so this rule must be applied by all modules.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

* $user Objet that contains the characteristics of the user + his permissions.
* $conf Objet that contains Dolibarr configuration.
* $db Objet that contains an opened connection handler to the database.
* $langs Objet that contains the user's language.

Then enter your code to display the page.

* To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):
''Example :''
<source lang="php">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</source>

* To include classes provided with Dolibarr, use the following syntax:
''Example :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== Add some fields into existing forms ===
You may want to provide a module that add more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means disable the "New element" menu entry and adding yours, and disable tab that show element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerfull since you can change everything you want into page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...
* First thing is to add a table, owned by your module, to store value of new fields. This table will have only one column called "rowid" (will contains same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
* Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.
If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

=== Replace parts of screen that are templated (version 3.3+) ===
Some parts of Dolibarr screen are isolated into native PHP template files.
You can develop a module to overwrite such templates with yours.
{{ToComplete}}

=== Add/replace part of fields supported by hooks ===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

=== Database access ===
If you need to edit some data in database inside you own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<source lang="php">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</source>

To read:

<source lang="php">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== Define style of your pages ===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

* class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
* class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
* class="'''flat'''" on all input fields (''input, select, textarea''...).
* class="'''button'''" on HTML fields with type ''input type="submit"''.

=== Use the Dolibarr date picker ===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== Add your own setup page (optional) ==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

=== Create your page to edit parameters ===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

=== Modify the descriptor file of your module ===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php");
</source>
If the page is in the directory '''mymodule/admin/''', then like this:
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</source>

=== Test your page ===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

== Define your entries in menu (optional) ==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

=== Define your menu entries ===
For this, you must define into the module descriptor, the array this->menu that declare all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

To show menu or not depending on a permission, modify property '''perms''' in array. See chapter on permissions later to see how to add permissions.

=== Test your menu entries ===
Disable and reenable your module under Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

== Add your own permissions (optional) ==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<source lang="php">
$this->rights_class = 'mymodule'
</source>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</source>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any new created user.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''').
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<source lang="php">
if ($user->rights->mymodule->action->subaction) ...
</source>

== Define you own box (optional) ==
'''When''': If your module need to provide one or several new boxes to show on home page.

=== Define your box ===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<source lang="php">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</source>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

=== Test if your box is detected by Dolibarr ===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activated. Activate the box and go on home page to see if the box is showing correctly.

== Define your own export (optional) ==
'''When''': If your module provide new predefined database export profiles (for its own tables or for already existing tables of another module).

=== Define export ===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

=== Test your export ===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

== Define your CSS styles (optional) ==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).

=== Create and declare your style sheet ===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have only one CSS file per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS file only if you need absolutely to add not already existing styles.

Once your style sheet is ready, declare it into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be a relative URL to your CSS file.
For example
<source lang="php">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php'));
</source>

=== Test your style sheet ===
Disable and enable your module.

Go on home page (index.php). Show the HTML source of the page.

You should see into the HTML header, a line that declare your style sheet.

== Add your Javascript functions (optional) ==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

== Run your own code on any Dolibarr event (optional) ==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

== Insert your code inside Dolibarr hooks positions (optional) ==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See previous chapter for adding code during a business event).

See page [[Hooks_system]].

== Add your own numbering rules ==
'''When''': When you need a new rule for generated ref of elements that is not covered by existing rules.

See page [[Create numbering module]].

== Add your document template (optional) ==
'''When''': When you want to personalized your own generated PDF or ODT documents.

Note: To add this feature you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

== Add your skin (optional) ==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions =
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Using MDA =
A method to generate a functional module from a UML model has been developed. More information on the page [[UML2Dolibarr - Build a module using MDA]].

=Create a package to distribute and install your module =
This process must be used to generate a package to submit it on the http://www.dolistore.com market place.
But you can use it to have a package easy to distribute on your on network.

* Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

* Run the script via Perl (need the Perl version 5.0 or later):
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

* The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:
<source lang="bash">
tar -xvf mymodule.zip
</source>

* If you want your module to be public, you can submit it (the zip file) on Dolibarr market place web site: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").
** If your module was build correctly, file will be validated later.
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).

= Enabling/activation condition of external module on DoliStore =

See [[Module_Dolistore_Validation_Rules|Validation Rules]]

FAQ Get,update GIT project sources

2016-04-11T06:13:15Z

Aikhan: /* Clone process */

[[Category:FAQ EN]]
{{TemplateDocDevEn}}
This is informations on how you can get sources of Dolibarr project.
Several methods are described, but we recommandusing the one based on GitHub.

=Get last version of sources by tgz download=
This method can be used by non technical users.
It allows you to get sources of main development branch (called HEAD) by just downloading a file: This operation consist to get last version of Dolibarr files that are packaged each night into a tgz file. File is available with link:

{{LinkLastSnapshot}}

New files overwrite old ones.
The inconvenient of this method is that you must download and uncompress package each time you want to get updates. Developers should not use this method to get sources but the next one.

=Get last version of sources using a GIT anonymous access=
You can use this method if you don't have any GIT access. With this method, you won't be able to submit any changes, so, if you are a developer, it is recommended to create a GitHub account and use the next method instead of this one.

== Prerequisite ==
* With Eclipse IDE
First you must have a working install of Eclipse. '''EGit''' plugin must also have been installed.
For this, use the '''Find And Install process''' into Eclipse menu, add the GIT update URL:
http://download.eclipse.org/egit/updates
Then choose to install '''EGit''' (No need to choose JGit)

* With the GIT Command Line Client Interface
You need to install GIT client (GIT command line tool with Linux installed with "sudo apt-get install git", or the GIT client for Windows found at https://git-scm.com/download/win).

== Clone process ==
First, enter value of the repository with reference sources into your GIT client tool.

* With Eclipse, go into perspective GIT, click onto button "Clone GIT repository". Enter GIT URL of project to get.
GIT Url for Dolibarr official source is:
<source lang="ini">
git://github.com/Dolibarr/dolibarr.git (read only)
or if you created a fork of dolibarr github from github web interface
git@github.com:yourgitaccount/dolibarr.git (read and write access)
</source>
Your Eclipse GIT client will ask you to choose the branches you are interested in. Branches not selected now could be selected later by doing a "Fetch" from the "Remotes" view, but try to choose only the branch you need. This will save you time and problems later.

Note: if you are behind a firewall, you must set Eclipse proxy credentials into Eclipse menu Windows - Preferences - General - Network connection and use the alternative URL:
<source lang="ini">
https://gitlogin:gitpassword@github.com/yourgitaccount/dolibarr.git
</source>

* With GIT on Command Line Interface:
First setup your git client:
<source lang="bash">
git config --global user.name "Your Name"
git config --global user.email "user@domain.com"
git config --list
</source>
Then clone repository locally:
<source lang="bash">
git://github.com/Dolibarr/dolibarr.git (read only)
or if you created a fork of dolibarr github from github web interface
git@github.com:yourgitaccount/dolibarr.git (read and write access)
</source>

Note: if you are behind a firewall, you must set your porxy information and use the alternative https URL:
<source lang="bash">
git config --global http.proxy http://proxyuser:proxypass@proxyserver:proxyport
git clone https://gitlogin:gitpassword@github.com/yourgitaccount/dolibarr.git dolibarr
</source>

Once this step is validated, your GIT client will download all files from remote GIT server. This may last several seconds or minutes.

Once download is finished, you must choose which branch to us to work on.

* With GIT on Command Line Interface;
<source lang="bash">
git checkout develop
git checkout x.y
</source>
This will create local branch and make checkout automatically.
* With Eclipse, right click on "Branches - Remotes - The branch you want to duplicate locally".
Choose "Create Branch" (and check the box "Checkout"). This will duplicate content of branch to work on it locally and will refresh your "Working Directory" to work on this branch.

Create Eclipse project:

If using Eclipse, once your branch is created locally, create a PHP project from assistant by choosing "'''Create from existing project'''" and select directory that is your GIT local repository (Do not choose to create a PHP project from scratch).
Then right click on project from your Eclipse workspace and Choose "'''Team - Share'''". Select GIT and click on option "'''Use or create repository in parent folder of project'''".
An alternate method is File->Import, Git->Project from Git, Select the Git repository and Next, Use New project Wizard -> Php project, enter the folder of you GIT local repository.

Then, you can setup Eclipse to avoid it to scan all project files for its build tools (Outline scanner, TODO scanner, syntax scanner...). This will avoid Eclipse to be too slow. For this, right click on project, choose Build Path and setup it like into following screenshot.

[[File:Eclipse php build path.png|240px]]

=Get last version of sources using a GitHub user access=
== Prerequisite ==

* With Eclipse IDE
You must before create an account on GitHub (https://github.com/) and upload a public RSA or DSA certificate into your account profile.

Then, you must have a working install of Eclipse. '''EGit''' plugin must also have been installed.
For this, use the '''Find And Install process''' into Eclipse menu, add the GIT update URL:
http://download.eclipse.org/egit/updates
Then choose to install '''EGit'''.

* With the GIT Command Line Client Interface:
You must before create an account on GitHub (https://github.com/) and upload a public RSA or DSA certificate into your account profile.

Then, you need to install GIT client (GIT command line tool with Linux installed with "sudo apt-get install git", or the GIT client for Windows found at https://git-scm.com/download/win).

== Fork process ==
Login to Github, with login you created in previous step. Then go onto page

https://github.com/Dolibarr/dolibarr

And click on button "Fork".

This will create a copy (a fork) of project into your own github area. Because you will be the owner of this fork, you will have all permissions on it to be used in next steps.

== Clone process ==
Then process is same as getting sources with anonymous access.

URL to use for GIT clone is same:
<source lang="ini">
git@github.com:YourGitHubLogin/dolibarr.git
</source>

Note that a HTTPS URL is also available but it's sometimes offline (so prefer using first one, link with HTTPS is required only if you are behind a firewall):
<source lang="ini">
https://yourgithublogin@github.com/Dolibarr/dolibarr.git
</source>

=Update your repository=
To update your local workspace:

* With Eclipse IDE:
right click on Eclipse project and select "Pull".

If you made some changes into your Eclipse workspace on files that were changed into the GIT remote reference, your GIT client will make a merge automatically.
* If there is conflicts, the merge will mark all conflict files as "conflict" (See later to solve this state).
* If not, you will get all new version files including all your changes.

If you already have commited some files into your local repository, your workspace will be marked as "Merged".
All you have to do is make a commit to validate your local repository as including your changes and changes made by others.

*With the GIT Command Line Client Interface:
<source lang="bash">
git pull
</source>

= Commit and publish your changes =
To see all changes you made into your working directory and waiting to be added into Git:
* With GIT Command Line Interface:
<source lang="bash">
git status
git diff subdir/filename
</source>

To add changes made into your local repository into the GIT index, then commit this index :
* With Eclipse: Right click on file or directory to commit. Select file to add/remove/update into commit.
* With GIT Command Line Interface:
<source lang="bash">
git commit -a -m "Commit text"
</source>
This will save add and changes into your local branch.

To push them on the GIT repository server,
* With Eclipse: right click on project and choose "'''Team - Push to Upstream'''".
* With GIT Command Line Interface:
<source lang="bash">
git push
</source>

To cancel a commit:
* With GIT Command Line Interface, if commit was not already pushed:
<source lang="bash">
git reset --soft HEAD~1
</source>
* With GIT Command Line Interface, if commit was already pushed:
<source lang="bash">
git revert IdCommit or git revert HEAD (for last commit)
</source>

To merge changes done into your forked GIT instance into official Dolibarr instance:
* Go into GitHub web interface of your forked Git instance.
* Click on small button "Create a Pull request".
* Choose commit you request inclusion and validate.

= Ask official project to include your changes =
Once you pushed one or several commit toward your distant fork area on github, you can ask the Dolibarr core team to include it into official project.
For this, follow this tutorial: https://help.github.com/articles/creating-a-pull-request/

= Add an external commit into current repository =
Some developers may work and do commit into their own Git repository after forking the project. If you are interesting into getting this changes, you can import them with the following steps.

You need both Eclipse and GIT Command Line interface to achieve this:
* First, go into GIT setup view and right click on "'''Remotes'''" of your Eclipse Git working space and choose "'''Create a remote...'''"
* Type name or remote fork the developer has create (in most cases, it's developer Git login). For example: "'''thedevlogin'''". Choose also "'''Configure Fetch'''".
* Type URI of Git repository of developer. For example: '''git://github.com/thedevlogin/dolibarr.git'''. Also add a refspec value to declare the branch you want to get. For example: '''refs/heads/master:refs/remotes/thedevlogin/master'''. Click "'''Save and Fetch'''". A new entry will be added into "Remote Tracking" making possible to read/get commits done into this branch.

Now, go on command line of your git repository (in most cases on Linux, it's '''/home/yourlogin/git/yourdolibarr''') and type the git cherry-pick command:
<source lang="bash">
git cherry-pick -x commitid
</source>
where commitid is value of commit id you want to get.

Once this is done, go back to Eclipse and make a refresh on project. You will see modified files appears with decorators (with conflicts if there is).

It the cherry-pick fails because of conflicts, you can cancel the cherry-pick try with
<source lang="bash">
git cherry-pick --abort
</source>

=Solving a conflict=
If a file has been marked as "conflict" after a Pull, open the file to edit it.
Find string "<<<<<<<<<<", you will see part of code that is conflict between "<<<<<<<<<" and ">>>>>>>>". Edit manually code lines and remove "<<<<<<<<" and ">>>>>>>".

Then, right click on file and select "Add".

If you prefer to forget completely all changes you made into all files (so to restore you workspace with content of remote repository), you can make a hard reset:
* With Eclipse: Right click on project top line and select "'''Reset'''" then "'''Hard'''" then "'''Reference - HEAD'''".
* With GIT Command Line Interface: You can achieve this with command
<source lang="bash">
git reset --hard HEAD
</source>
To reset changes you commited but not pushed to origin
<source lang="bash">
git reset --hard origin/develop
</source>

=Tagging sources=
With GIT Command Line Interface:

To add a tag to a current version:
<source lang="bash">
git tag -a -m "Release|Maintenance release x.y.z" "x.y.z"
or
git tag -a -f -m "Beta x.y.betai" "x.y.betai_YYYYMMDD" idcommit # -f force if an existing tag already exists, idcommit allows to choose commit to tag

git push --tags # To push tags to remote origin
</source>

To remove a tag:
<source lang="bash">
git tag -d "x.y.z_YYYYMMDD"
git push remoteentryname :x.y.z_YYYYMMDD # To validate delete on remote origin
</source>

=Creating a new branch=
With GIT Command Line Interface:

Create a clone (see previously) of the branch from where you want to create another branch, then go into directory and launch command:
<source lang="bash">
git branch x.y
git push origin x.y
</source>

With Eclipse:

Create a clone (see previously) of the branch from where you want to create another branch, with a checkout done. The go into view git. Choose branches, remote tracking and select start branch.
Right click and choose "Create branch".
Then make a push to create branch remotely.
Then go into "Remotes - origins" and edit the entries to pull and push onto new branch.
It may also be required to edit the .git/config file to have project linked by default onto new branch.

= Deleting a branch=
With GIT Command Line Interface:

Do a push on branch but add : before name of branch:
<source lang="bash">
git push remoteentryname :branchnametodelete
</source>

=Merging a maintenance branch x.x into dev branch=
With Eclipse:
* Go onto the root directory of project with a checkout of the dev branch.
* Check fetch setup to be sure, this repository contains both information of dev branch and version x.x you want to merge.
* Right click onto root directory and choose "Team - Merge". Select "x.x". Click onto "Merge options - Commit", because we want to commit merged branch if there is no conflicts.
* Once merge is done, check everything is ok.
* Commit and push.

= Pushing a branch onto another Git server =
You may want to synchronize another GIT server.
To synchronize push to another server, this is how to proceed.
With Eclipse:
* Go onto Git clone view and add a remote with a name, choose "Configure push" and enter URL. For example, for name "sourceforge" and URL "ssh://yoursourceforgelogin@git.code.sf.net/p/dolibarr/code"
* Just validate, a first push will be done automatically.
* To force sync, run
<source lang="bash">
git push sourceforge develop
git push --tags sourceforge develop
</source>

=Statistics=
With GIT Command Line interface:

To count number of changes developers have made between a version x and y:
* First, search commit id of tags you want to compare
To find id_start (common commit id between 2 versions/tags)
<source lang="bash">
git merge-base refs/tags/3.3.0 origin/3.4
or
git merge-base 3.7 origin/develop
</source>
To find id_end, choose among
<source lang="bash">
git show-ref
</source>
Choose a value for id_start and id_end
Note: id_end can be HEAD.
* Then run git log to have list of all changes from last common commit to last commit
<source lang="bash">
git log id_start..id_end
</source>
* To get total number of added/deleted lines:
<source lang="bash">
git log --ancestry-path --numstat --pretty="%H" id_start..id_end | awk 'NF==3 {plus+=$1; minus+=$2} END {printf("+%d, -%d\n", plus, minus)}'
</source>

To count number of changes finally between a version x and y (it differs from previous count because in previous count, a change can be done 2 times at two different moment to change differently. With second method, you count changes finally found if changes were ok at first try).
* Use same method than previously but instead of running git log, run git diff.
<source lang="bash">
git diff -b -M --numstat --pretty="%H" id_start..id_end | awk 'NF==3 {plus+=$1; minus+=$2} END {printf("+%d, -%d\n", plus, minus)}'
</source>

More information in GIT usage is available [http://wiki.eclipse.org/EGit/User_Guide here].

FAQ Get,update GIT project sources

2016-04-11T06:12:21Z

Aikhan: /* Fork process */

[[Category:FAQ EN]]
{{TemplateDocDevEn}}
This is informations on how you can get sources of Dolibarr project.
Several methods are described, but we recommandusing the one based on GitHub.

=Get last version of sources by tgz download=
This method can be used by non technical users.
It allows you to get sources of main development branch (called HEAD) by just downloading a file: This operation consist to get last version of Dolibarr files that are packaged each night into a tgz file. File is available with link:

{{LinkLastSnapshot}}

New files overwrite old ones.
The inconvenient of this method is that you must download and uncompress package each time you want to get updates. Developers should not use this method to get sources but the next one.

=Get last version of sources using a GIT anonymous access=
You can use this method if you don't have any GIT access. With this method, you won't be able to submit any changes, so, if you are a developer, it is recommended to create a GitHub account and use the next method instead of this one.

== Prerequisite ==
* With Eclipse IDE
First you must have a working install of Eclipse. '''EGit''' plugin must also have been installed.
For this, use the '''Find And Install process''' into Eclipse menu, add the GIT update URL:
http://download.eclipse.org/egit/updates
Then choose to install '''EGit''' (No need to choose JGit)

* With the GIT Command Line Client Interface
You need to install GIT client (GIT command line tool with Linux installed with "sudo apt-get install git", or the GIT client for Windows found at https://git-scm.com/download/win).

== Clone process ==
First, enter value of the repository with reference sources into your GIT client tool.

* With Eclipse, go into perspective GIT, click onto button "Clone GIT repository". Enter GIT URL of project to get.
GIT Url for Dolibarr official source is:
<source lang="ini">
git://github.com/Dolibarr/dolibarr.git (read only)
or if you created a fork of dolibarr github from github web interface
git@github.com:yourgitaccount/dolibarr.git (read and write access)
</source>
Your Eclipse GIT client will ask you to choose the branches you are interested in. Branches not selected now could be selected later by doing a "Fetch" from the "Remotes" view, but try to choose only the branch you need. This will save you time and problems later.

Note: if you are behind a firewall, you must set Eclipse proxy credentials into Eclipse menu Windows - Preferences - General - Network connection and use the alternative URL:
<source lang="ini">
https://gitlogin:gitpassword@github.com/yourgitaccount/dolibarr.git
</source>

* With GIT on Command Line Interface:
First setup your git client:
<source lang="bash">
git config --global user.name "Your Name"
git config --global user.email "user@domain.com"
git config --list
</source>
Then clone repository locally:
<source lang="bash">
git://github.com/Dolibarr/dolibarr.git (read only)
or if you created a fork of dolibarr github from github web interface
git@github.com:yourgitaccount/dolibarr.git (read and write access)
</source>

Note: if you are behind a firewall, you must set your porxy information and use the alternative https URL:
<source lang="bash">
git config --global http.proxy http://proxyuser:proxypass@proxyserver:proxyport
git clone https://gitlogin:gitpassword@github.com/yourgitaccount/dolibarr.git dolibarr
</source>

Once this step is validated, your GIT client will download all files from remote GIT server. This may last several seconds or minutes.

Once download is finished, you must choose which branch to us to work on.

* With GIT on Command Line Interface;
<source lang="bash">
git checkout develop
git checkout x.y
</source>
This will create local branch and make checkout automatically.
* With Eclipse, right click on "Branches - Remotes - The branch you want to duplicate locally".
Choose "Create Branch" (and check the box "Checkout"). This will duplicate content of branch to work on it locally and will refresh your "Working Directory" to work on this branch.

Create Eclipse project:

If using Eclipse, once your branch is created locally, create a PHP project from assistant by choosing "'''Create from existing project'''" and select directory that is your GIT local repository (Do not choose to create a PHP project from scratch).
Then right click on project from your Eclipse workspace and Choose "'''Team - Share'''". Select GIT and click on option "'''Use or create repository in parent folder of project'''".
An alternate method is File->Import, Git->Project from Git, Select the Git repository and Next, Use New project Wizard -> Php project, enter the folder of you GIT local repository.

Then, you can setup Eclipse to avoid it to scan all project files for its build tools (Outline scanner, TODO scanner, syntax scanner...). This will avoid Eclipse to be too slow. For this, right click on project, choose Build Path and setup it like into following screenshot.

[[File:Eclipse php build path.png|240px]]

=Get last version of sources using a GitHub user access=
== Prerequisite ==

* With Eclipse IDE
You must before create an account on GitHub (https://github.com/) and upload a public RSA or DSA certificate into your account profile.

Then, you must have a working install of Eclipse. '''EGit''' plugin must also have been installed.
For this, use the '''Find And Install process''' into Eclipse menu, add the GIT update URL:
http://download.eclipse.org/egit/updates
Then choose to install '''EGit'''.

* With the GIT Command Line Client Interface:
You must before create an account on GitHub (https://github.com/) and upload a public RSA or DSA certificate into your account profile.

Then, you need to install GIT client (GIT command line tool with Linux installed with "sudo apt-get install git", or the GIT client for Windows found at https://git-scm.com/download/win).

== Fork process ==
Login to Github, with login you created in previous step. Then go onto page

https://github.com/Dolibarr/dolibarr

And click on button "Fork".

This will create a copy (a fork) of project into your own github area. Because you will be the owner of this fork, you will have all permissions on it to be used in next steps.

== Clone process ==
Then process is same than getting sources with anonymous access.

URL to use for GIT clone is same:
<source lang="ini">
git@github.com:YourGitHubLogin/dolibarr.git
</source>

Note that a HTTPS URL is also available but it's sometimes offline (so prefer using first one, link with HTTPS is required only if you are behind a firewall):
<source lang="ini">
https://yourgithublogin@github.com/Dolibarr/dolibarr.git
</source>

=Update your repository=
To update your local workspace:

* With Eclipse IDE:
right click on Eclipse project and select "Pull".

If you made some changes into your Eclipse workspace on files that were changed into the GIT remote reference, your GIT client will make a merge automatically.
* If there is conflicts, the merge will mark all conflict files as "conflict" (See later to solve this state).
* If not, you will get all new version files including all your changes.

If you already have commited some files into your local repository, your workspace will be marked as "Merged".
All you have to do is make a commit to validate your local repository as including your changes and changes made by others.

*With the GIT Command Line Client Interface:
<source lang="bash">
git pull
</source>

= Commit and publish your changes =
To see all changes you made into your working directory and waiting to be added into Git:
* With GIT Command Line Interface:
<source lang="bash">
git status
git diff subdir/filename
</source>

To add changes made into your local repository into the GIT index, then commit this index :
* With Eclipse: Right click on file or directory to commit. Select file to add/remove/update into commit.
* With GIT Command Line Interface:
<source lang="bash">
git commit -a -m "Commit text"
</source>
This will save add and changes into your local branch.

To push them on the GIT repository server,
* With Eclipse: right click on project and choose "'''Team - Push to Upstream'''".
* With GIT Command Line Interface:
<source lang="bash">
git push
</source>

To cancel a commit:
* With GIT Command Line Interface, if commit was not already pushed:
<source lang="bash">
git reset --soft HEAD~1
</source>
* With GIT Command Line Interface, if commit was already pushed:
<source lang="bash">
git revert IdCommit or git revert HEAD (for last commit)
</source>

To merge changes done into your forked GIT instance into official Dolibarr instance:
* Go into GitHub web interface of your forked Git instance.
* Click on small button "Create a Pull request".
* Choose commit you request inclusion and validate.

= Ask official project to include your changes =
Once you pushed one or several commit toward your distant fork area on github, you can ask the Dolibarr core team to include it into official project.
For this, follow this tutorial: https://help.github.com/articles/creating-a-pull-request/

= Add an external commit into current repository =
Some developers may work and do commit into their own Git repository after forking the project. If you are interesting into getting this changes, you can import them with the following steps.

You need both Eclipse and GIT Command Line interface to achieve this:
* First, go into GIT setup view and right click on "'''Remotes'''" of your Eclipse Git working space and choose "'''Create a remote...'''"
* Type name or remote fork the developer has create (in most cases, it's developer Git login). For example: "'''thedevlogin'''". Choose also "'''Configure Fetch'''".
* Type URI of Git repository of developer. For example: '''git://github.com/thedevlogin/dolibarr.git'''. Also add a refspec value to declare the branch you want to get. For example: '''refs/heads/master:refs/remotes/thedevlogin/master'''. Click "'''Save and Fetch'''". A new entry will be added into "Remote Tracking" making possible to read/get commits done into this branch.

Now, go on command line of your git repository (in most cases on Linux, it's '''/home/yourlogin/git/yourdolibarr''') and type the git cherry-pick command:
<source lang="bash">
git cherry-pick -x commitid
</source>
where commitid is value of commit id you want to get.

Once this is done, go back to Eclipse and make a refresh on project. You will see modified files appears with decorators (with conflicts if there is).

It the cherry-pick fails because of conflicts, you can cancel the cherry-pick try with
<source lang="bash">
git cherry-pick --abort
</source>

=Solving a conflict=
If a file has been marked as "conflict" after a Pull, open the file to edit it.
Find string "<<<<<<<<<<", you will see part of code that is conflict between "<<<<<<<<<" and ">>>>>>>>". Edit manually code lines and remove "<<<<<<<<" and ">>>>>>>".

Then, right click on file and select "Add".

If you prefer to forget completely all changes you made into all files (so to restore you workspace with content of remote repository), you can make a hard reset:
* With Eclipse: Right click on project top line and select "'''Reset'''" then "'''Hard'''" then "'''Reference - HEAD'''".
* With GIT Command Line Interface: You can achieve this with command
<source lang="bash">
git reset --hard HEAD
</source>
To reset changes you commited but not pushed to origin
<source lang="bash">
git reset --hard origin/develop
</source>

=Tagging sources=
With GIT Command Line Interface:

To add a tag to a current version:
<source lang="bash">
git tag -a -m "Release|Maintenance release x.y.z" "x.y.z"
or
git tag -a -f -m "Beta x.y.betai" "x.y.betai_YYYYMMDD" idcommit # -f force if an existing tag already exists, idcommit allows to choose commit to tag

git push --tags # To push tags to remote origin
</source>

To remove a tag:
<source lang="bash">
git tag -d "x.y.z_YYYYMMDD"
git push remoteentryname :x.y.z_YYYYMMDD # To validate delete on remote origin
</source>

=Creating a new branch=
With GIT Command Line Interface:

Create a clone (see previously) of the branch from where you want to create another branch, then go into directory and launch command:
<source lang="bash">
git branch x.y
git push origin x.y
</source>

With Eclipse:

Create a clone (see previously) of the branch from where you want to create another branch, with a checkout done. The go into view git. Choose branches, remote tracking and select start branch.
Right click and choose "Create branch".
Then make a push to create branch remotely.
Then go into "Remotes - origins" and edit the entries to pull and push onto new branch.
It may also be required to edit the .git/config file to have project linked by default onto new branch.

= Deleting a branch=
With GIT Command Line Interface:

Do a push on branch but add : before name of branch:
<source lang="bash">
git push remoteentryname :branchnametodelete
</source>

=Merging a maintenance branch x.x into dev branch=
With Eclipse:
* Go onto the root directory of project with a checkout of the dev branch.
* Check fetch setup to be sure, this repository contains both information of dev branch and version x.x you want to merge.
* Right click onto root directory and choose "Team - Merge". Select "x.x". Click onto "Merge options - Commit", because we want to commit merged branch if there is no conflicts.
* Once merge is done, check everything is ok.
* Commit and push.

= Pushing a branch onto another Git server =
You may want to synchronize another GIT server.
To synchronize push to another server, this is how to proceed.
With Eclipse:
* Go onto Git clone view and add a remote with a name, choose "Configure push" and enter URL. For example, for name "sourceforge" and URL "ssh://yoursourceforgelogin@git.code.sf.net/p/dolibarr/code"
* Just validate, a first push will be done automatically.
* To force sync, run
<source lang="bash">
git push sourceforge develop
git push --tags sourceforge develop
</source>

=Statistics=
With GIT Command Line interface:

To count number of changes developers have made between a version x and y:
* First, search commit id of tags you want to compare
To find id_start (common commit id between 2 versions/tags)
<source lang="bash">
git merge-base refs/tags/3.3.0 origin/3.4
or
git merge-base 3.7 origin/develop
</source>
To find id_end, choose among
<source lang="bash">
git show-ref
</source>
Choose a value for id_start and id_end
Note: id_end can be HEAD.
* Then run git log to have list of all changes from last common commit to last commit
<source lang="bash">
git log id_start..id_end
</source>
* To get total number of added/deleted lines:
<source lang="bash">
git log --ancestry-path --numstat --pretty="%H" id_start..id_end | awk 'NF==3 {plus+=$1; minus+=$2} END {printf("+%d, -%d\n", plus, minus)}'
</source>

To count number of changes finally between a version x and y (it differs from previous count because in previous count, a change can be done 2 times at two different moment to change differently. With second method, you count changes finally found if changes were ok at first try).
* Use same method than previously but instead of running git log, run git diff.
<source lang="bash">
git diff -b -M --numstat --pretty="%H" id_start..id_end | awk 'NF==3 {plus+=$1; minus+=$2} END {printf("+%d, -%d\n", plus, minus)}'
</source>

More information in GIT usage is available [http://wiki.eclipse.org/EGit/User_Guide here].

FAQ Get,update GIT project sources

2016-04-11T05:50:58Z

Aikhan: /* Fork process */

[[Category:FAQ EN]]
{{TemplateDocDevEn}}
This is informations on how you can get sources of Dolibarr project.
Several methods are described, but we recommandusing the one based on GitHub.

=Get last version of sources by tgz download=
This method can be used by non technical users.
It allows you to get sources of main development branch (called HEAD) by just downloading a file: This operation consist to get last version of Dolibarr files that are packaged each night into a tgz file. File is available with link:

{{LinkLastSnapshot}}

New files overwrite old ones.
The inconvenient of this method is that you must download and uncompress package each time you want to get updates. Developers should not use this method to get sources but the next one.

=Get last version of sources using a GIT anonymous access=
You can use this method if you don't have any GIT access. With this method, you won't be able to submit any changes, so, if you are a developer, it is recommended to create a GitHub account and use the next method instead of this one.

== Prerequisite ==
* With Eclipse IDE
First you must have a working install of Eclipse. '''EGit''' plugin must also have been installed.
For this, use the '''Find And Install process''' into Eclipse menu, add the GIT update URL:
http://download.eclipse.org/egit/updates
Then choose to install '''EGit''' (No need to choose JGit)

* With the GIT Command Line Client Interface
You need to install GIT client (GIT command line tool with Linux installed with "sudo apt-get install git", or the GIT client for Windows found at https://git-scm.com/download/win).

== Clone process ==
First, enter value of the repository with reference sources into your GIT client tool.

* With Eclipse, go into perspective GIT, click onto button "Clone GIT repository". Enter GIT URL of project to get.
GIT Url for Dolibarr official source is:
<source lang="ini">
git://github.com/Dolibarr/dolibarr.git (read only)
or if you created a fork of dolibarr github from github web interface
git@github.com:yourgitaccount/dolibarr.git (read and write access)
</source>
Your Eclipse GIT client will ask you to choose the branches you are interested in. Branches not selected now could be selected later by doing a "Fetch" from the "Remotes" view, but try to choose only the branch you need. This will save you time and problems later.

Note: if you are behind a firewall, you must set Eclipse proxy credentials into Eclipse menu Windows - Preferences - General - Network connection and use the alternative URL:
<source lang="ini">
https://gitlogin:gitpassword@github.com/yourgitaccount/dolibarr.git
</source>

* With GIT on Command Line Interface:
First setup your git client:
<source lang="bash">
git config --global user.name "Your Name"
git config --global user.email "user@domain.com"
git config --list
</source>
Then clone repository locally:
<source lang="bash">
git://github.com/Dolibarr/dolibarr.git (read only)
or if you created a fork of dolibarr github from github web interface
git@github.com:yourgitaccount/dolibarr.git (read and write access)
</source>

Note: if you are behind a firewall, you must set your porxy information and use the alternative https URL:
<source lang="bash">
git config --global http.proxy http://proxyuser:proxypass@proxyserver:proxyport
git clone https://gitlogin:gitpassword@github.com/yourgitaccount/dolibarr.git dolibarr
</source>

Once this step is validated, your GIT client will download all files from remote GIT server. This may last several seconds or minutes.

Once download is finished, you must choose which branch to us to work on.

* With GIT on Command Line Interface;
<source lang="bash">
git checkout develop
git checkout x.y
</source>
This will create local branch and make checkout automatically.
* With Eclipse, right click on "Branches - Remotes - The branch you want to duplicate locally".
Choose "Create Branch" (and check the box "Checkout"). This will duplicate content of branch to work on it locally and will refresh your "Working Directory" to work on this branch.

Create Eclipse project:

If using Eclipse, once your branch is created locally, create a PHP project from assistant by choosing "'''Create from existing project'''" and select directory that is your GIT local repository (Do not choose to create a PHP project from scratch).
Then right click on project from your Eclipse workspace and Choose "'''Team - Share'''". Select GIT and click on option "'''Use or create repository in parent folder of project'''".
An alternate method is File->Import, Git->Project from Git, Select the Git repository and Next, Use New project Wizard -> Php project, enter the folder of you GIT local repository.

Then, you can setup Eclipse to avoid it to scan all project files for its build tools (Outline scanner, TODO scanner, syntax scanner...). This will avoid Eclipse to be too slow. For this, right click on project, choose Build Path and setup it like into following screenshot.

[[File:Eclipse php build path.png|240px]]

=Get last version of sources using a GitHub user access=
== Prerequisite ==

* With Eclipse IDE
You must before create an account on GitHub (https://github.com/) and upload a public RSA or DSA certificate into your account profile.

Then, you must have a working install of Eclipse. '''EGit''' plugin must also have been installed.
For this, use the '''Find And Install process''' into Eclipse menu, add the GIT update URL:
http://download.eclipse.org/egit/updates
Then choose to install '''EGit'''.

* With the GIT Command Line Client Interface:
You must before create an account on GitHub (https://github.com/) and upload a public RSA or DSA certificate into your account profile.

Then, you need to install GIT client (GIT command line tool with Linux installed with "sudo apt-get install git", or the GIT client for Windows found at https://git-scm.com/download/win).

== Fork process ==
Login to Github, with login you created a previous step. Then go onto page

https://github.com/Dolibarr/dolibarr

And click on button "Fork".

This will create a copy (a fork) of project into your own github area. Because you will be the owner of this fork, you will have all read/write permissions on it used in next steps.

== Clone process ==
Then process is same than getting sources with anonymous access.

URL to use for GIT clone is same:
<source lang="ini">
git@github.com:YourGitHubLogin/dolibarr.git
</source>

Note that a HTTPS URL is also available but it's sometimes offline (so prefer using first one, link with HTTPS is required only if you are behind a firewall):
<source lang="ini">
https://yourgithublogin@github.com/Dolibarr/dolibarr.git
</source>

=Update your repository=
To update your local workspace:

* With Eclipse IDE:
right click on Eclipse project and select "Pull".

If you made some changes into your Eclipse workspace on files that were changed into the GIT remote reference, your GIT client will make a merge automatically.
* If there is conflicts, the merge will mark all conflict files as "conflict" (See later to solve this state).
* If not, you will get all new version files including all your changes.

If you already have commited some files into your local repository, your workspace will be marked as "Merged".
All you have to do is make a commit to validate your local repository as including your changes and changes made by others.

*With the GIT Command Line Client Interface:
<source lang="bash">
git pull
</source>

= Commit and publish your changes =
To see all changes you made into your working directory and waiting to be added into Git:
* With GIT Command Line Interface:
<source lang="bash">
git status
git diff subdir/filename
</source>

To add changes made into your local repository into the GIT index, then commit this index :
* With Eclipse: Right click on file or directory to commit. Select file to add/remove/update into commit.
* With GIT Command Line Interface:
<source lang="bash">
git commit -a -m "Commit text"
</source>
This will save add and changes into your local branch.

To push them on the GIT repository server,
* With Eclipse: right click on project and choose "'''Team - Push to Upstream'''".
* With GIT Command Line Interface:
<source lang="bash">
git push
</source>

To cancel a commit:
* With GIT Command Line Interface, if commit was not already pushed:
<source lang="bash">
git reset --soft HEAD~1
</source>
* With GIT Command Line Interface, if commit was already pushed:
<source lang="bash">
git revert IdCommit or git revert HEAD (for last commit)
</source>

To merge changes done into your forked GIT instance into official Dolibarr instance:
* Go into GitHub web interface of your forked Git instance.
* Click on small button "Create a Pull request".
* Choose commit you request inclusion and validate.

= Ask official project to include your changes =
Once you pushed one or several commit toward your distant fork area on github, you can ask the Dolibarr core team to include it into official project.
For this, follow this tutorial: https://help.github.com/articles/creating-a-pull-request/

= Add an external commit into current repository =
Some developers may work and do commit into their own Git repository after forking the project. If you are interesting into getting this changes, you can import them with the following steps.

You need both Eclipse and GIT Command Line interface to achieve this:
* First, go into GIT setup view and right click on "'''Remotes'''" of your Eclipse Git working space and choose "'''Create a remote...'''"
* Type name or remote fork the developer has create (in most cases, it's developer Git login). For example: "'''thedevlogin'''". Choose also "'''Configure Fetch'''".
* Type URI of Git repository of developer. For example: '''git://github.com/thedevlogin/dolibarr.git'''. Also add a refspec value to declare the branch you want to get. For example: '''refs/heads/master:refs/remotes/thedevlogin/master'''. Click "'''Save and Fetch'''". A new entry will be added into "Remote Tracking" making possible to read/get commits done into this branch.

Now, go on command line of your git repository (in most cases on Linux, it's '''/home/yourlogin/git/yourdolibarr''') and type the git cherry-pick command:
<source lang="bash">
git cherry-pick -x commitid
</source>
where commitid is value of commit id you want to get.

Once this is done, go back to Eclipse and make a refresh on project. You will see modified files appears with decorators (with conflicts if there is).

It the cherry-pick fails because of conflicts, you can cancel the cherry-pick try with
<source lang="bash">
git cherry-pick --abort
</source>

=Solving a conflict=
If a file has been marked as "conflict" after a Pull, open the file to edit it.
Find string "<<<<<<<<<<", you will see part of code that is conflict between "<<<<<<<<<" and ">>>>>>>>". Edit manually code lines and remove "<<<<<<<<" and ">>>>>>>".

Then, right click on file and select "Add".

If you prefer to forget completely all changes you made into all files (so to restore you workspace with content of remote repository), you can make a hard reset:
* With Eclipse: Right click on project top line and select "'''Reset'''" then "'''Hard'''" then "'''Reference - HEAD'''".
* With GIT Command Line Interface: You can achieve this with command
<source lang="bash">
git reset --hard HEAD
</source>
To reset changes you commited but not pushed to origin
<source lang="bash">
git reset --hard origin/develop
</source>

=Tagging sources=
With GIT Command Line Interface:

To add a tag to a current version:
<source lang="bash">
git tag -a -m "Release|Maintenance release x.y.z" "x.y.z"
or
git tag -a -f -m "Beta x.y.betai" "x.y.betai_YYYYMMDD" idcommit # -f force if an existing tag already exists, idcommit allows to choose commit to tag

git push --tags # To push tags to remote origin
</source>

To remove a tag:
<source lang="bash">
git tag -d "x.y.z_YYYYMMDD"
git push remoteentryname :x.y.z_YYYYMMDD # To validate delete on remote origin
</source>

=Creating a new branch=
With GIT Command Line Interface:

Create a clone (see previously) of the branch from where you want to create another branch, then go into directory and launch command:
<source lang="bash">
git branch x.y
git push origin x.y
</source>

With Eclipse:

Create a clone (see previously) of the branch from where you want to create another branch, with a checkout done. The go into view git. Choose branches, remote tracking and select start branch.
Right click and choose "Create branch".
Then make a push to create branch remotely.
Then go into "Remotes - origins" and edit the entries to pull and push onto new branch.
It may also be required to edit the .git/config file to have project linked by default onto new branch.

= Deleting a branch=
With GIT Command Line Interface:

Do a push on branch but add : before name of branch:
<source lang="bash">
git push remoteentryname :branchnametodelete
</source>

=Merging a maintenance branch x.x into dev branch=
With Eclipse:
* Go onto the root directory of project with a checkout of the dev branch.
* Check fetch setup to be sure, this repository contains both information of dev branch and version x.x you want to merge.
* Right click onto root directory and choose "Team - Merge". Select "x.x". Click onto "Merge options - Commit", because we want to commit merged branch if there is no conflicts.
* Once merge is done, check everything is ok.
* Commit and push.

= Pushing a branch onto another Git server =
You may want to synchronize another GIT server.
To synchronize push to another server, this is how to proceed.
With Eclipse:
* Go onto Git clone view and add a remote with a name, choose "Configure push" and enter URL. For example, for name "sourceforge" and URL "ssh://yoursourceforgelogin@git.code.sf.net/p/dolibarr/code"
* Just validate, a first push will be done automatically.
* To force sync, run
<source lang="bash">
git push sourceforge develop
git push --tags sourceforge develop
</source>

=Statistics=
With GIT Command Line interface:

To count number of changes developers have made between a version x and y:
* First, search commit id of tags you want to compare
To find id_start (common commit id between 2 versions/tags)
<source lang="bash">
git merge-base refs/tags/3.3.0 origin/3.4
or
git merge-base 3.7 origin/develop
</source>
To find id_end, choose among
<source lang="bash">
git show-ref
</source>
Choose a value for id_start and id_end
Note: id_end can be HEAD.
* Then run git log to have list of all changes from last common commit to last commit
<source lang="bash">
git log id_start..id_end
</source>
* To get total number of added/deleted lines:
<source lang="bash">
git log --ancestry-path --numstat --pretty="%H" id_start..id_end | awk 'NF==3 {plus+=$1; minus+=$2} END {printf("+%d, -%d\n", plus, minus)}'
</source>

To count number of changes finally between a version x and y (it differs from previous count because in previous count, a change can be done 2 times at two different moment to change differently. With second method, you count changes finally found if changes were ok at first try).
* Use same method than previously but instead of running git log, run git diff.
<source lang="bash">
git diff -b -M --numstat --pretty="%H" id_start..id_end | awk 'NF==3 {plus+=$1; minus+=$2} END {printf("+%d, -%d\n", plus, minus)}'
</source>

More information in GIT usage is available [http://wiki.eclipse.org/EGit/User_Guide here].

FAQ Get,update GIT project sources

2016-04-11T05:48:05Z

Aikhan: /* Get last version of sources using a GIT anonymous access */

[[Category:FAQ EN]]
{{TemplateDocDevEn}}
This is informations on how you can get sources of Dolibarr project.
Several methods are described, but we recommandusing the one based on GitHub.

=Get last version of sources by tgz download=
This method can be used by non technical users.
It allows you to get sources of main development branch (called HEAD) by just downloading a file: This operation consist to get last version of Dolibarr files that are packaged each night into a tgz file. File is available with link:

{{LinkLastSnapshot}}

New files overwrite old ones.
The inconvenient of this method is that you must download and uncompress package each time you want to get updates. Developers should not use this method to get sources but the next one.

=Get last version of sources using a GIT anonymous access=
You can use this method if you don't have any GIT access. With this method, you won't be able to submit any changes, so, if you are a developer, it is recommended to create a GitHub account and use the next method instead of this one.

== Prerequisite ==
* With Eclipse IDE
First you must have a working install of Eclipse. '''EGit''' plugin must also have been installed.
For this, use the '''Find And Install process''' into Eclipse menu, add the GIT update URL:
http://download.eclipse.org/egit/updates
Then choose to install '''EGit''' (No need to choose JGit)

* With the GIT Command Line Client Interface
You need to install GIT client (GIT command line tool with Linux installed with "sudo apt-get install git", or the GIT client for Windows found at https://git-scm.com/download/win).

== Clone process ==
First, enter value of the repository with reference sources into your GIT client tool.

* With Eclipse, go into perspective GIT, click onto button "Clone GIT repository". Enter GIT URL of project to get.
GIT Url for Dolibarr official source is:
<source lang="ini">
git://github.com/Dolibarr/dolibarr.git (read only)
or if you created a fork of dolibarr github from github web interface
git@github.com:yourgitaccount/dolibarr.git (read and write access)
</source>
Your Eclipse GIT client will ask you to choose the branches you are interested in. Branches not selected now could be selected later by doing a "Fetch" from the "Remotes" view, but try to choose only the branch you need. This will save you time and problems later.

Note: if you are behind a firewall, you must set Eclipse proxy credentials into Eclipse menu Windows - Preferences - General - Network connection and use the alternative URL:
<source lang="ini">
https://gitlogin:gitpassword@github.com/yourgitaccount/dolibarr.git
</source>

* With GIT on Command Line Interface:
First setup your git client:
<source lang="bash">
git config --global user.name "Your Name"
git config --global user.email "user@domain.com"
git config --list
</source>
Then clone repository locally:
<source lang="bash">
git://github.com/Dolibarr/dolibarr.git (read only)
or if you created a fork of dolibarr github from github web interface
git@github.com:yourgitaccount/dolibarr.git (read and write access)
</source>

Note: if you are behind a firewall, you must set your porxy information and use the alternative https URL:
<source lang="bash">
git config --global http.proxy http://proxyuser:proxypass@proxyserver:proxyport
git clone https://gitlogin:gitpassword@github.com/yourgitaccount/dolibarr.git dolibarr
</source>

Once this step is validated, your GIT client will download all files from remote GIT server. This may last several seconds or minutes.

Once download is finished, you must choose which branch to us to work on.

* With GIT on Command Line Interface;
<source lang="bash">
git checkout develop
git checkout x.y
</source>
This will create local branch and make checkout automatically.
* With Eclipse, right click on "Branches - Remotes - The branch you want to duplicate locally".
Choose "Create Branch" (and check the box "Checkout"). This will duplicate content of branch to work on it locally and will refresh your "Working Directory" to work on this branch.

Create Eclipse project:

If using Eclipse, once your branch is created locally, create a PHP project from assistant by choosing "'''Create from existing project'''" and select directory that is your GIT local repository (Do not choose to create a PHP project from scratch).
Then right click on project from your Eclipse workspace and Choose "'''Team - Share'''". Select GIT and click on option "'''Use or create repository in parent folder of project'''".
An alternate method is File->Import, Git->Project from Git, Select the Git repository and Next, Use New project Wizard -> Php project, enter the folder of you GIT local repository.

Then, you can setup Eclipse to avoid it to scan all project files for its build tools (Outline scanner, TODO scanner, syntax scanner...). This will avoid Eclipse to be too slow. For this, right click on project, choose Build Path and setup it like into following screenshot.

[[File:Eclipse php build path.png|240px]]

=Get last version of sources using a GitHub user access=
== Prerequisite ==

* With Eclipse IDE
You must before create an account on GitHub (https://github.com/) and upload a public RSA or DSA certificate into your account profile.

Then, you must have a working install of Eclipse. '''EGit''' plugin must also have been installed.
For this, use the '''Find And Install process''' into Eclipse menu, add the GIT update URL:
http://download.eclipse.org/egit/updates
Then choose to install '''EGit'''.

* With the GIT Command Line Client Interface:
You must before create an account on GitHub (https://github.com/) and upload a public RSA or DSA certificate into your account profile.

Then, you need to install GIT client (GIT command line tool with Linux installed with "sudo apt-get install git", or the GIT client for Windows found at https://git-scm.com/download/win).

== Fork process ==
Login to Github, with login you created a previous step. Then go onto page

https://github.com/Dolibarr/dolibarr

And click on button "Fork".

This will create a copy (a fork) of project into your own area. Because you will be the owner of this fork, you will have all permissions on it to make next steps.

== Clone process ==
Then process is same than getting sources with anonymous access.

URL to use for GIT clone is same:
<source lang="ini">
git@github.com:YourGitHubLogin/dolibarr.git
</source>

Note that a HTTPS URL is also available but it's sometimes offline (so prefer using first one, link with HTTPS is required only if you are behind a firewall):
<source lang="ini">
https://yourgithublogin@github.com/Dolibarr/dolibarr.git
</source>

=Update your repository=
To update your local workspace:

* With Eclipse IDE:
right click on Eclipse project and select "Pull".

If you made some changes into your Eclipse workspace on files that were changed into the GIT remote reference, your GIT client will make a merge automatically.
* If there is conflicts, the merge will mark all conflict files as "conflict" (See later to solve this state).
* If not, you will get all new version files including all your changes.

If you already have commited some files into your local repository, your workspace will be marked as "Merged".
All you have to do is make a commit to validate your local repository as including your changes and changes made by others.

*With the GIT Command Line Client Interface:
<source lang="bash">
git pull
</source>

= Commit and publish your changes =
To see all changes you made into your working directory and waiting to be added into Git:
* With GIT Command Line Interface:
<source lang="bash">
git status
git diff subdir/filename
</source>

To add changes made into your local repository into the GIT index, then commit this index :
* With Eclipse: Right click on file or directory to commit. Select file to add/remove/update into commit.
* With GIT Command Line Interface:
<source lang="bash">
git commit -a -m "Commit text"
</source>
This will save add and changes into your local branch.

To push them on the GIT repository server,
* With Eclipse: right click on project and choose "'''Team - Push to Upstream'''".
* With GIT Command Line Interface:
<source lang="bash">
git push
</source>

To cancel a commit:
* With GIT Command Line Interface, if commit was not already pushed:
<source lang="bash">
git reset --soft HEAD~1
</source>
* With GIT Command Line Interface, if commit was already pushed:
<source lang="bash">
git revert IdCommit or git revert HEAD (for last commit)
</source>

To merge changes done into your forked GIT instance into official Dolibarr instance:
* Go into GitHub web interface of your forked Git instance.
* Click on small button "Create a Pull request".
* Choose commit you request inclusion and validate.

= Ask official project to include your changes =
Once you pushed one or several commit toward your distant fork area on github, you can ask the Dolibarr core team to include it into official project.
For this, follow this tutorial: https://help.github.com/articles/creating-a-pull-request/

= Add an external commit into current repository =
Some developers may work and do commit into their own Git repository after forking the project. If you are interesting into getting this changes, you can import them with the following steps.

You need both Eclipse and GIT Command Line interface to achieve this:
* First, go into GIT setup view and right click on "'''Remotes'''" of your Eclipse Git working space and choose "'''Create a remote...'''"
* Type name or remote fork the developer has create (in most cases, it's developer Git login). For example: "'''thedevlogin'''". Choose also "'''Configure Fetch'''".
* Type URI of Git repository of developer. For example: '''git://github.com/thedevlogin/dolibarr.git'''. Also add a refspec value to declare the branch you want to get. For example: '''refs/heads/master:refs/remotes/thedevlogin/master'''. Click "'''Save and Fetch'''". A new entry will be added into "Remote Tracking" making possible to read/get commits done into this branch.

Now, go on command line of your git repository (in most cases on Linux, it's '''/home/yourlogin/git/yourdolibarr''') and type the git cherry-pick command:
<source lang="bash">
git cherry-pick -x commitid
</source>
where commitid is value of commit id you want to get.

Once this is done, go back to Eclipse and make a refresh on project. You will see modified files appears with decorators (with conflicts if there is).

It the cherry-pick fails because of conflicts, you can cancel the cherry-pick try with
<source lang="bash">
git cherry-pick --abort
</source>

=Solving a conflict=
If a file has been marked as "conflict" after a Pull, open the file to edit it.
Find string "<<<<<<<<<<", you will see part of code that is conflict between "<<<<<<<<<" and ">>>>>>>>". Edit manually code lines and remove "<<<<<<<<" and ">>>>>>>".

Then, right click on file and select "Add".

If you prefer to forget completely all changes you made into all files (so to restore you workspace with content of remote repository), you can make a hard reset:
* With Eclipse: Right click on project top line and select "'''Reset'''" then "'''Hard'''" then "'''Reference - HEAD'''".
* With GIT Command Line Interface: You can achieve this with command
<source lang="bash">
git reset --hard HEAD
</source>
To reset changes you commited but not pushed to origin
<source lang="bash">
git reset --hard origin/develop
</source>

=Tagging sources=
With GIT Command Line Interface:

To add a tag to a current version:
<source lang="bash">
git tag -a -m "Release|Maintenance release x.y.z" "x.y.z"
or
git tag -a -f -m "Beta x.y.betai" "x.y.betai_YYYYMMDD" idcommit # -f force if an existing tag already exists, idcommit allows to choose commit to tag

git push --tags # To push tags to remote origin
</source>

To remove a tag:
<source lang="bash">
git tag -d "x.y.z_YYYYMMDD"
git push remoteentryname :x.y.z_YYYYMMDD # To validate delete on remote origin
</source>

=Creating a new branch=
With GIT Command Line Interface:

Create a clone (see previously) of the branch from where you want to create another branch, then go into directory and launch command:
<source lang="bash">
git branch x.y
git push origin x.y
</source>

With Eclipse:

Create a clone (see previously) of the branch from where you want to create another branch, with a checkout done. The go into view git. Choose branches, remote tracking and select start branch.
Right click and choose "Create branch".
Then make a push to create branch remotely.
Then go into "Remotes - origins" and edit the entries to pull and push onto new branch.
It may also be required to edit the .git/config file to have project linked by default onto new branch.

= Deleting a branch=
With GIT Command Line Interface:

Do a push on branch but add : before name of branch:
<source lang="bash">
git push remoteentryname :branchnametodelete
</source>

=Merging a maintenance branch x.x into dev branch=
With Eclipse:
* Go onto the root directory of project with a checkout of the dev branch.
* Check fetch setup to be sure, this repository contains both information of dev branch and version x.x you want to merge.
* Right click onto root directory and choose "Team - Merge". Select "x.x". Click onto "Merge options - Commit", because we want to commit merged branch if there is no conflicts.
* Once merge is done, check everything is ok.
* Commit and push.

= Pushing a branch onto another Git server =
You may want to synchronize another GIT server.
To synchronize push to another server, this is how to proceed.
With Eclipse:
* Go onto Git clone view and add a remote with a name, choose "Configure push" and enter URL. For example, for name "sourceforge" and URL "ssh://yoursourceforgelogin@git.code.sf.net/p/dolibarr/code"
* Just validate, a first push will be done automatically.
* To force sync, run
<source lang="bash">
git push sourceforge develop
git push --tags sourceforge develop
</source>

=Statistics=
With GIT Command Line interface:

To count number of changes developers have made between a version x and y:
* First, search commit id of tags you want to compare
To find id_start (common commit id between 2 versions/tags)
<source lang="bash">
git merge-base refs/tags/3.3.0 origin/3.4
or
git merge-base 3.7 origin/develop
</source>
To find id_end, choose among
<source lang="bash">
git show-ref
</source>
Choose a value for id_start and id_end
Note: id_end can be HEAD.
* Then run git log to have list of all changes from last common commit to last commit
<source lang="bash">
git log id_start..id_end
</source>
* To get total number of added/deleted lines:
<source lang="bash">
git log --ancestry-path --numstat --pretty="%H" id_start..id_end | awk 'NF==3 {plus+=$1; minus+=$2} END {printf("+%d, -%d\n", plus, minus)}'
</source>

To count number of changes finally between a version x and y (it differs from previous count because in previous count, a change can be done 2 times at two different moment to change differently. With second method, you count changes finally found if changes were ok at first try).
* Use same method than previously but instead of running git log, run git diff.
<source lang="bash">
git diff -b -M --numstat --pretty="%H" id_start..id_end | awk 'NF==3 {plus+=$1; minus+=$2} END {printf("+%d, -%d\n", plus, minus)}'
</source>

More information in GIT usage is available [http://wiki.eclipse.org/EGit/User_Guide here].

Module Medical Center

2016-01-18T08:04:28Z

Aikhan: /* Users */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described in the '''usage''' chapter.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of caregivers staff (doctor, nurse, midwife, physiotherapist, or secretary ...), and thus a user belonging to the firm using the Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient and consultations (Patient records and consultations)===
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

<div class="divforimgcentpercent">
[[File:Dolimed screenshot patientcard.png|border]]
</div>

Here is a description of how to use each tab.

==== Onglet des informations générales (Tab general information)====

Most information on this tab are properties to qualify the patient.

The field "Followed by" has however a specific usage. It is set by default on the user creating the patient. It is possible to assign one or more users (individual doctors cabinet following the patient for example). If the user has permission "Extend acess to all patient", the the user will see all patients. If permission is not granted, then user will see only patient he is a follower of. This information can also be used for some statistics reports.

==== Onglet Correspondans (tab for correspondents) ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.

(On this tab, you can associate all physicians treating the patient with or knowing their specialty.)

==== Onglet Agenda (tab agenda)====
(This tab is only visible if the Calendar module has been activated.)
(It provides a calendar-type view of certain events that have been recorded on the patient (creation of the patient file, appointments, entering a consultation).)

==== Onglet Catégories (Tab for categories)====
This tab is only visible if the [[Module Categories]] has been activated.
It classifies a patient in one or more categories. You decide which categories you create. Their creation is fair from the "Patient - Category - New Category" menu.

==== Onglet Antécédents/Traitements (Tab Background / Treatments) ====
To complete ...

==== Tab Notes ====
To complete

==== Tab consultations ====
Cet onglet permet l'enregistrement d'une consultation du patient.
On y retrouve l'historique des consultations du patient.

<div class="divforimgcentpercent">
[[File:Capture dolimed consultations1.png|border]]
</div>

En cliquant sur une fiche '''Consultation existante''' ou en cliquant sur le bouton '''Créer consultation''', on ouvre la fiche de consultation.
Sur cette fiche consultation, on va saisir les symptomes remontés par le patient ou détectés, les actes réalisés ou traitements prescrits.
Le montant pris pour la consultation se renseigne également à la fin de la saisie de la fiche.

<div class="divforimgcentpercent">
[[File:Capture dolimed consultations2.png|border]]
</div>

==== Tab Bio ====

Cet onglet permet l'enregistrements des demandes d'analyses biologiques du patient ainsi que les résultats.

==== Tab Explorations ====
Cet onglet permet l'enregistrements des demandes d'analyses radiologiques du patient ainsi que les résultats.

<div class="divforimgcentpercent">
[[File:Capture dolimed explorations.png|border]]
</div>

==== Onglet Documents (Tab Documents)====
* This page allows you to attach attachments (image scanners, ultrasound, papers words ...)
But it also can generate OpenOffice documents from a model. The model is supplied in courrier_consult.odt example.
* To generate a document, choose the model, possibly associated Bio page and click Generate.
The model will be used and all variables tags will be replaced with the patient's information or consultation.
* To make your own document model, see the [[Create a template ODT]].
The following tags are available in addition to the standard Dolibarr:
{{TagsOdtCabinetMed}}

Example of generated document (click twice to enlarge)

[[File:Capture dolimed document odt.png|border|300px]]

== Menu Bilan consultations ==
Select Balance consultations brings up a table that displays the menu for the past 3 years, income per month with details.
Clicking on a month, this place details about each day of the month.
It is also possible from this screen to export the details in an Excel file.

<div class="divforimgcentpercent">
[[File:Dolimed screenshot report.png|border]]
</div>

= Développement =
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:

* GIT Repository: git clone https://git.framasoft.org/eldy/dolimed.git

Note this is a private repository, so you must apply to be a member from https://git.framasoft.org web site to be able to clone sources using GIT.

Module Third Parties

2015-12-02T17:18:19Z

Aikhan: /* Introduction */

[[Category:Third parties]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Third Parties|
num=1|
devdoc=[[Module Third Parties (developer)]]|
userdoc=This page|}}

= Introduction =
The "Third Parties" module allows you to manage entities like customers, prospects and / or suppliers (called Tiers). This module is a pre-requisite for many other modules that are based on these concepts (invoices, orders, contracts, proposals, etc. ...).

A third party means any customer, prospect or supplier which, can be a corporation/business entity (For example: An LLC, a trade association etc.) or can be an individual person. A contact on the otherhand, is a representative person of a corporation (For example: CEO or any other person of an LLC, the principal dealer of Trade, president or treasurer of an association etc.) or is the person himself (in case of an individual person).

Dolibarr operates the same way for the third and businesses. Also, for individuals, a "Contact " contains the same features/informations as the object "Company".

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}
Description of setup of third party module is available on page [[Module Third Parties setup]].

= Creating a new third party =

Click the tab 'Third parties' then under the menus 'Third party' choose 'New third party' or 'New prospect' or 'New customer' ('''Example Third parties->Third party->New customer'''). Input all information (fill only mandatory fields if you want).

Once third party is created, you can add some Notes, and add linked files using corresponding tabs.

= Modify a third party =
Go into menu third party, click on name of third party to modify.

Click on button "Modify" (right bottom). Type all changes.

Click on button "Save".

= Delete a third party =
Go on third party card and click on button "Delete".
Only a third party that has no linked objects (invoices, contracts, orders, etc) can be deleted.

= Create a contact =
There are several ways to create contacts/addresses

* Go to menu Third Parties - Contacts/Addresses - New contact/address. Enter the requested information (you do not have to complete all fields). This will create a contact that can not be linked to third.

* On third, go to the customer or supplier tab and click on "Create Contact ". Enter the requested information (you do not have to complete all fields). This will create a contact linked to third.

= Edit Contact =
Go to menu Third Parties - Contacts/Addresses - List, click the contact to edit and select the tab sheet or personal info.

Click "Modify" (bottom right).

Enter the changes.

Click "Save".

= Delete Contact =
Go to contact and click 'Delete'

= Life cycle / Business rules =

A third party has only two state: Active Or Inactive.
A deleted third party does not change its state, but disappears completely from Dolibarr.

You can create one or more physical contact or addresses for a Third party (these will be then used as contacts to send emails for [[Module Commercial Proposals|commercial proposals]], [[Module Customers Orders|customer orders]], [[Module Customers Invoices|customer invoices]], etc...).

= Examples of use cases =
{{ExamplesCaseEn
|name=UCTP01:
|situation=I have a new customer, prospect, supplier.
|actions=Go to menu Third party -> New third party -> Input all data and click on Create.
}} 

Module Products

2015-12-02T17:14:29Z

Aikhan: /* Virtual products (also called Pack products) */

[[Category:Produit]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Products|
num=50|
devdoc=[[Module Products (developer)]]|
userdoc=This page|}}

= Introduction =
This module manage a catalog of products.

See also [[Module Services En|Modules Services]] to manage a catalog of services or page [[Module Stocks En|Module Stocks]] to manage warehouses and stock.

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

= Definition =
== Products ==
A ''product'' is a good to manage as it is an object you sell to customers or it is an object you buy from suppliers. It is a material good, contrarily to [[ServicesEn|Services]].

A product follows this rules:
* A product can be stocked into a warehouse (only products appears in module [[Module_StockEn|Stock]]. Services are not visible).
* A product can be delivered (only products appears in module [[Module Shipment|Shipment]]. Services are not visible. Services are realized but can not be shipped).
* A product is a material good. It's value often decrease with time (Value of an already used product is lower than same never used product).

== Virtual products (also called Pack products) ==
{{ToTranslate}}
Un produit ou service virtuel est un produit père, constitué d'autres produits. Cette fonction s'active depuis la page de configuration du module Produits ou Service.
Elle a pour vocation à définir des "packages" ou "lots" de produits qui permettent de raisonner sur les commandes, factures et stocks avec un seul élément au lieu des n produits
constituant le lot.

'''Translation:'''
A product or service is a virtual father product consisting of other products. This function is activated from the Products module or service configuration page. It aims to define "packages" or "batches" of products that allow to reason about orders, invoices and inventory with a single element instead of the n products as Lot.

Un produit virtuel répond aux règles suivantes:
* Lors de l'ajout d'un produit dans un document (propositions, facture, commande), seule la ligne du produit virtuel père est affichée.
* Le stock de produit composant le produit virtuel est incrémenté/décrémenté quand le produit virtuel est incrémenté/décrémenté.
* Un produit virtuel peut lui même être constitué d'autres produits virtuels qui eux contiennent de vrais produits.
'''Translation:'''
A virtual product complies with the following rules:
* When adding a product in a document (proposals, invoice, order), only the line of virtual product father is shown.
* Product stock component virtual product is incremented / decremented when the virtual product is incremented / decremented.
* A virtual product may itself be composed of other virtual products that contain them real products.

Remarque:
Il ne s'agit pas d'une fonction de "fabrication/production" où les produits fils composant le produit virtuel seraient consommés du stock pour obtenir un produit père supplémentaire en stock.
Ici, les sous-produits composants un produit virtuel ne sont décrémentés du stock qu'au moment de la consommation du produit virtuel et restent des sous-produits consommables de manière indépendantes des autres, contrairement à un de module de fabrication, où lorsque qu'un sous-produits est utilisé pour fabriquer un module père, le sous produits est décrémenté du stock même si le produit père n'est pas encore distribué, et souvent ce sous-produits ne peut plus faire le chemin inverse pour revenir en stock.

'''Translation:'''
Note:
It is not a function of "manufacturing / production" where the virtual product component products are consumed son of stock father for an additional product in stock.
Here, the sub-components produced a virtual product are decremented stock at the time of consumption of the virtual product and remain independent manner consumables byproducts other, unlike a manufacturing module, wherein when that a by-product is used to manufacture a father module, the products under the same stock is decremented if the father product is not yet distributed, and often this byproducts can no longer do the reverse way back in stock.

= Life cycle / Business rules =
{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Products

2015-12-02T17:14:07Z

Aikhan: /* Virtual products (also called Pack products) */

[[Category:Produit]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Products|
num=50|
devdoc=[[Module Products (developer)]]|
userdoc=This page|}}

= Introduction =
This module manage a catalog of products.

See also [[Module Services En|Modules Services]] to manage a catalog of services or page [[Module Stocks En|Module Stocks]] to manage warehouses and stock.

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

= Definition =
== Products ==
A ''product'' is a good to manage as it is an object you sell to customers or it is an object you buy from suppliers. It is a material good, contrarily to [[ServicesEn|Services]].

A product follows this rules:
* A product can be stocked into a warehouse (only products appears in module [[Module_StockEn|Stock]]. Services are not visible).
* A product can be delivered (only products appears in module [[Module Shipment|Shipment]]. Services are not visible. Services are realized but can not be shipped).
* A product is a material good. It's value often decrease with time (Value of an already used product is lower than same never used product).

== Virtual products (also called Pack products) ==
{{ToTranslate}}
Un produit ou service virtuel est un produit père, constitué d'autres produits. Cette fonction s'active depuis la page de configuration du module Produits ou Service.
Elle a pour vocation à définir des "packages" ou "lots" de produits qui permettent de raisonner sur les commandes, factures et stocks avec un seul élément au lieu des n produits
constituant le lot.
'''Translation:'''
A product or service is a virtual father product consisting of other products. This function is activated from the Products module or service configuration page. It aims to define "packages" or "batches" of products that allow to reason about orders, invoices and inventory with a single element instead of the n products as Lot.

Un produit virtuel répond aux règles suivantes:
* Lors de l'ajout d'un produit dans un document (propositions, facture, commande), seule la ligne du produit virtuel père est affichée.
* Le stock de produit composant le produit virtuel est incrémenté/décrémenté quand le produit virtuel est incrémenté/décrémenté.
* Un produit virtuel peut lui même être constitué d'autres produits virtuels qui eux contiennent de vrais produits.
'''Translation:'''
A virtual product complies with the following rules:
* When adding a product in a document (proposals, invoice, order), only the line of virtual product father is shown.
* Product stock component virtual product is incremented / decremented when the virtual product is incremented / decremented.
* A virtual product may itself be composed of other virtual products that contain them real products.

Remarque:
Il ne s'agit pas d'une fonction de "fabrication/production" où les produits fils composant le produit virtuel seraient consommés du stock pour obtenir un produit père supplémentaire en stock.
Ici, les sous-produits composants un produit virtuel ne sont décrémentés du stock qu'au moment de la consommation du produit virtuel et restent des sous-produits consommables de manière indépendantes des autres, contrairement à un de module de fabrication, où lorsque qu'un sous-produits est utilisé pour fabriquer un module père, le sous produits est décrémenté du stock même si le produit père n'est pas encore distribué, et souvent ce sous-produits ne peut plus faire le chemin inverse pour revenir en stock.
'''Translation:'''
Note:
It is not a function of "manufacturing / production" where the virtual product component products are consumed son of stock father for an additional product in stock.
Here, the sub-components produced a virtual product are decremented stock at the time of consumption of the virtual product and remain independent manner consumables byproducts other, unlike a manufacturing module, wherein when that a by-product is used to manufacture a father module, the products under the same stock is decremented if the father product is not yet distributed, and often this byproducts can no longer do the reverse way back in stock.

= Life cycle / Business rules =
{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Products

2015-12-02T17:13:05Z

Aikhan: /* Virtual products (also called Pack products) */

[[Category:Produit]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Products|
num=50|
devdoc=[[Module Products (developer)]]|
userdoc=This page|}}

= Introduction =
This module manage a catalog of products.

See also [[Module Services En|Modules Services]] to manage a catalog of services or page [[Module Stocks En|Module Stocks]] to manage warehouses and stock.

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

= Definition =
== Products ==
A ''product'' is a good to manage as it is an object you sell to customers or it is an object you buy from suppliers. It is a material good, contrarily to [[ServicesEn|Services]].

A product follows this rules:
* A product can be stocked into a warehouse (only products appears in module [[Module_StockEn|Stock]]. Services are not visible).
* A product can be delivered (only products appears in module [[Module Shipment|Shipment]]. Services are not visible. Services are realized but can not be shipped).
* A product is a material good. It's value often decrease with time (Value of an already used product is lower than same never used product).

== Virtual products (also called Pack products) ==
{{ToTranslate}}
Un produit ou service virtuel est un produit père, constitué d'autres produits. Cette fonction s'active depuis la page de configuration du module Produits ou Service.
Elle a pour vocation à définir des "packages" ou "lots" de produits qui permettent de raisonner sur les commandes, factures et stocks avec un seul élément au lieu des n produits
constituant le lot.
'''
Translation:'''
A product or service is a virtual father product consisting of other products. This function is activated from the Products module or service configuration page. It aims to define "packages" or "batches" of products that allow to reason about orders, invoices and inventory with a single element instead of the n products as Lot.

Un produit virtuel répond aux règles suivantes:
* Lors de l'ajout d'un produit dans un document (propositions, facture, commande), seule la ligne du produit virtuel père est affichée.
* Le stock de produit composant le produit virtuel est incrémenté/décrémenté quand le produit virtuel est incrémenté/décrémenté.
* Un produit virtuel peut lui même être constitué d'autres produits virtuels qui eux contiennent de vrais produits.
'''Translation:'''
A virtual product complies with the following rules:
* When adding a product in a document (proposals, invoice, order), only the line of virtual product father is shown.
* Product stock component virtual product is incremented / decremented when the virtual product is incremented / decremented.
* A virtual product may itself be composed of other virtual products that contain them real products.

Remarque:
Il ne s'agit pas d'une fonction de "fabrication/production" où les produits fils composant le produit virtuel seraient consommés du stock pour obtenir un produit père supplémentaire en stock.
Ici, les sous-produits composants un produit virtuel ne sont décrémentés du stock qu'au moment de la consommation du produit virtuel et restent des sous-produits consommables de manière indépendantes des autres, contrairement à un de module de fabrication, où lorsque qu'un sous-produits est utilisé pour fabriquer un module père, le sous produits est décrémenté du stock même si le produit père n'est pas encore distribué, et souvent ce sous-produits ne peut plus faire le chemin inverse pour revenir en stock.
'''
Translation:'''
Note:
It is not a function of "manufacturing / production" where the virtual product component products are consumed son of stock father for an additional product in stock.
Here, the sub-components produced a virtual product are decremented stock at the time of consumption of the virtual product and remain independent manner consumables byproducts other, unlike a manufacturing module, wherein when that a by-product is used to manufacture a father module, the products under the same stock is decremented if the father product is not yet distributed, and often this byproducts can no longer do the reverse way back in stock.

= Life cycle / Business rules =
{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Products

2015-12-02T16:52:01Z

Aikhan: /* Virtual products (also called Pack products) */

[[Category:Produit]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Products|
num=50|
devdoc=[[Module Products (developer)]]|
userdoc=This page|}}

= Introduction =
This module manage a catalog of products.

See also [[Module Services En|Modules Services]] to manage a catalog of services or page [[Module Stocks En|Module Stocks]] to manage warehouses and stock.

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

= Definition =
== Products ==
A ''product'' is a good to manage as it is an object you sell to customers or it is an object you buy from suppliers. It is a material good, contrarily to [[ServicesEn|Services]].

A product follows this rules:
* A product can be stocked into a warehouse (only products appears in module [[Module_StockEn|Stock]]. Services are not visible).
* A product can be delivered (only products appears in module [[Module Shipment|Shipment]]. Services are not visible. Services are realized but can not be shipped).
* A product is a material good. It's value often decrease with time (Value of an already used product is lower than same never used product).

== Virtual products (also called Pack products) ==
{{ToTranslate}}
Un produit ou service virtuel est un produit père, constitué d'autres produits. Cette fonction s'active depuis la page de configuration du module Produits ou Service.
Elle a pour vocation à définir des "packages" ou "lots" de produits qui permettent de raisonner sur les commandes, factures et stocks avec un seul élément au lieu des n produits
constituant le lot.

Translation:
A product or service is a virtual father product consisting of other products. This function is activated from the Products module or service configuration page. It aims to define "packages" or "batches" of products that allow to reason about orders, invoices and inventory with a single element instead of the n products as Lot.

Un produit virtuel répond aux règles suivantes:
* Lors de l'ajout d'un produit dans un document (propositions, facture, commande), seule la ligne du produit virtuel père est affichée.
* Le stock de produit composant le produit virtuel est incrémenté/décrémenté quand le produit virtuel est incrémenté/décrémenté.
* Un produit virtuel peut lui même être constitué d'autres produits virtuels qui eux contiennent de vrais produits.
Translation:
A virtual product complies with the following rules:
* When adding a product in a document (proposals, invoice, order), only the line of virtual product father is shown.
* Product stock component virtual product is incremented / decremented when the virtual product is incremented / decremented.
* A virtual product may itself be composed of other virtual products that contain them real products.

Remarque:
Il ne s'agit pas d'une fonction de "fabrication/production" où les produits fils composant le produit virtuel seraient consommés du stock pour obtenir un produit père supplémentaire en stock.
Ici, les sous-produits composants un produit virtuel ne sont décrémentés du stock qu'au moment de la consommation du produit virtuel et restent des sous-produits consommables de manière indépendantes des autres, contrairement à un de module de fabrication, où lorsque qu'un sous-produits est utilisé pour fabriquer un module père, le sous produits est décrémenté du stock même si le produit père n'est pas encore distribué, et souvent ce sous-produits ne peut plus faire le chemin inverse pour revenir en stock.

Translation:
Note:
It is not a function of "manufacturing / production" where the virtual product component products are consumed son of stock father for an additional product in stock.
Here, the sub-components produced a virtual product are decremented stock at the time of consumption of the virtual product and remain independent manner consumables byproducts other, unlike a manufacturing module, wherein when that a by-product is used to manufacture a father module, the products under the same stock is decremented if the father product is not yet distributed, and often this byproducts can no longer do the reverse way back in stock.

= Life cycle / Business rules =
{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module Products

2015-12-02T16:50:23Z

Aikhan: /* Virtual products (also called Pack products) */

[[Category:Produit]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Products|
num=50|
devdoc=[[Module Products (developer)]]|
userdoc=This page|}}

= Introduction =
This module manage a catalog of products.

See also [[Module Services En|Modules Services]] to manage a catalog of services or page [[Module Stocks En|Module Stocks]] to manage warehouses and stock.

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

= Definition =
== Products ==
A ''product'' is a good to manage as it is an object you sell to customers or it is an object you buy from suppliers. It is a material good, contrarily to [[ServicesEn|Services]].

A product follows this rules:
* A product can be stocked into a warehouse (only products appears in module [[Module_StockEn|Stock]]. Services are not visible).
* A product can be delivered (only products appears in module [[Module Shipment|Shipment]]. Services are not visible. Services are realized but can not be shipped).
* A product is a material good. It's value often decrease with time (Value of an already used product is lower than same never used product).

== Virtual products (also called Pack products) ==
{{ToTranslate}}
Un produit ou service virtuel est un produit père, constitué d'autres produits. Cette fonction s'active depuis la page de configuration du module Produits ou Service.
Elle a pour vocation à définir des "packages" ou "lots" de produits qui permettent de raisonner sur les commandes, factures et stocks avec un seul élément au lieu des n produits
constituant le lot.
Translation:
A product or service is a virtual father product consisting of other products. This function is activated from the Products module or service configuration page. It aims to define "packages" or "batches" of products that allow to reason about orders, invoices and inventory with a single element instead of the n products as Lot.

Un produit virtuel répond aux règles suivantes:
* Lors de l'ajout d'un produit dans un document (propositions, facture, commande), seule la ligne du produit virtuel père est affichée.
* Le stock de produit composant le produit virtuel est incrémenté/décrémenté quand le produit virtuel est incrémenté/décrémenté.
* Un produit virtuel peut lui même être constitué d'autres produits virtuels qui eux contiennent de vrais produits.
Translation:
A virtual product complies with the following rules:
* When adding a product in a document (proposals, invoice, order), only the line of virtual product father is shown.
* Product stock component virtual product is incremented / decremented when the virtual product is incremented / decremented.
* A virtual product may itself be composed of other virtual products that contain them real products.

Remarque:
Il ne s'agit pas d'une fonction de "fabrication/production" où les produits fils composant le produit virtuel seraient consommés du stock pour obtenir un produit père supplémentaire en stock.
Ici, les sous-produits composants un produit virtuel ne sont décrémentés du stock qu'au moment de la consommation du produit virtuel et restent des sous-produits consommables de manière indépendantes des autres, contrairement à un de module de fabrication, où lorsque qu'un sous-produits est utilisé pour fabriquer un module père, le sous produits est décrémenté du stock même si le produit père n'est pas encore distribué, et souvent ce sous-produits ne peut plus faire le chemin inverse pour revenir en stock.
Translation:
Note:
It is not a function of "manufacturing / production" where the virtual product component products are consumed son of stock father for an additional product in stock.
Here, the sub-components produced a virtual product are decremented stock at the time of consumption of the virtual product and remain independent manner consumables byproducts other, unlike a manufacturing module, wherein when that a by-product is used to manufacture a father module, the products under the same stock is decremented if the father product is not yet distributed, and often this byproducts can no longer do the reverse way back in stock.

= Life cycle / Business rules =
{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}} 

Module development

2015-08-10T06:45:39Z

Aikhan: /* Add or removed your own tabs on object sheets */

[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :
* Add new tables in database
* Add your own menu entries
* Add new screens to edit new tables
* Add or remove tabs on object view (invoice, product, order, event, ...)
* Add predefined exports for the internal export tool
* Add new information boxes in the home page
* Add new substitutions variables
* Define new permissions
* Execute code automatically triggered by a particular Dolibarr action
* Insert your code inside Dolibarr hooks positions
* Add your numbering module
* Add a new document template
* Add a new skin
etc...
All those operations are possible with version 3.2 or more of Dolibarr.

Following chapters presents how to do all of this manually with an easy way. For experienced developers, a method to do this using MDA generation is also on the work. See last chapter for this.

=Example of Template External Module=
A good model to start development of external module can be found here : [https://github.com/rdoursenaud/dolibarr-module-template GitHub Dolibarr Module Modèle]

=Create your module =
== Create a Module descriptor for your Module (required) ==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin or a document template).

=== Create your module descriptor ===
The first step is to create a file descriptor for the module.
* Create directory '''/htdocs/''mymodule''/core/modules'''. Then copy the file modMyModule.class.php from the directory dev/skeletons into this directory '''htdocs/''mymodule''/core/modules'''. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').
Next modify the contents of this file as follows:
* Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
* Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult tha page that lists already reserved id numbers: [[List of modules id|List of modules id]].
* Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).
Your file descriptor for your module is ready.

=== Test your descriptor ===

Launch Dolibarr and go to page '''Setup->module'''? You must see a new line with your new module and the possibility to activate it or not (browse all the tabs of each category of modules to find it). The value of $this->special determines in which tab will be your module.

== Tree of path for new module files (required) ==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only second line is mandatory.

{{TemplateModuleTreeSimple}}

== Create your SQL tables and the PHP DAO class (optional) ==
'''When''': If your module needs to manage data of its own

=== Create your .sql file ===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and load data for your own module must be placed in a directory: Create a subdirectory called "sql" into directory of your module (eg htdocs/mymodule/sql) to put the sql scripts that you will create.

Then check into your descriptor file, into function '''init''' that the line

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

is not commented.

''Rules to follow:''
* Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table, with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).

* To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.

Example of content of a file data.sql
<source lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</source>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

=== Test your .sql files ===

Once the files ready, you can return to Dolibarr to disable the module, drop those tables in database and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

=== Generate the PHP DAO class ===
Once you have created your tables into the database, move to the dev/skeletons directory and run the script

<source lang="bash">php build_class_from_table.php tablename</source>
Note: If the command does not work, try to use php-cli php instead.

This will generate a file '''out.tablename.class.php''' that contains the class to manage table tablename.
In this class, you can find the CRUD methods (Create / Read / Update / Delete) already working to do an insert, a fetch (select), an update, a delete of a row in table.
Remove just the "out" from the file name and put the file in a subdirectory of '''htdocs''' specific to your module (in htdocs/mymodule for example).

A file '''out.tablename_script.php''' has been generated and contains a sample code to use the class for each of the 4 CRUD methods.

== The tab management (optional) ==

=== Add or remove your own tabs on object sheets ===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"
* Part 1: The element type (objecttype) where the tab should appear is a value from the following:
{{TemplateModuleTabs}}
* Part 2: A code to identify tab to add (start with +) or to remove (start with -)
* Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
* Part 4: The name of the file "*.lang" which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
* Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
* Part 6: The url of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

=== Show tabs navigation into your own pages ===
'''When''': To show all standard tabs of an object (produit, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<source lang="php">require_once($url_fichier) ;</source>

This is list of those files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :
* Object thirdparty (thirdparty) :
** DOL_DOCUMENT_ROOT/societe.class.php
** DOL_DOCUMENT_ROOT/lib/company.lib.php
* Object product (product) :
** DOL_DOCUMENT_ROOT/product.class.php
** DOL_DOCUMENT_ROOT/lib/product.lib.php
* Object invoice (invoice) :
** DOL_DOCUMENT_ROOT/facture.class.php
** DOL_DOCUMENT_ROOT/lib/invoice.lib.php

'''2. Create and load the object to show into your tab'''

Create instance of object of the correct class and load object from database by using the fetch method of object en providing to this method the id you get from url (ie : /mytab.php?id=1).

''Example :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</source>

'''3. Get list of all tabs to show for your object type'''

Use fonction XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. Parameter to put into this method is the instance of object you want tabs.

The resulting array has the following structure
<source lang="php">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</source>

''Example :''
<source lang="php">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</source>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</source>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

== Create or modify PHP screens (optional) ==
'''When''': If the purpose of your module is to add features that require new or modified screens.

=== Create a new PHP screen ===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''dev/skeletons''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''skeletons_page.php''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.
The modules developed for all version of Dolibarr after the 3.2 should be able to be moved in a different folder than "htdocs", like "htdocs/custom", without having to modify the source code of the module, that's why we make several includes, so this rule must be applied by all modules.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

* $user Objet that contains the characteristics of the user + his permissions.
* $conf Objet that contains Dolibarr configuration.
* $db Objet that contains an opened connection handler to the database.
* $langs Objet that contains the user's language.

Then enter your code to display the page.

* To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):
''Example :''
<source lang="php">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</source>

* To include classes provided with Dolibarr, use the following syntax:
''Example :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== Add some fields into existing forms ===
You may want to provide a module that add more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means disable the "New element" menu entry and adding yours, and disable tab that show element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerfull since you can change everything you want into page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...
* First thing is to add a table, owned by your module, to store value of new fields. This table will have only one column called "rowid" (will contains same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
* Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.
If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

=== Replace parts of screen that are templated (version 3.3+) ===
Some parts of Dolibarr screen are isolated into native PHP template files.
You can develop a module to overwrite such templates with yours.
{{ToComplete}}

=== Add/replace part of fields supported by hooks ===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

=== Database access ===
If you need to edit some data in database inside you own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<source lang="php">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</source>

To read:

<source lang="php">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== Define style of your pages ===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

* class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
* class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
* class="'''flat'''" on all input fields (''input, select, textarea''...).
* class="'''button'''" on HTML fields with type ''input type="submit"''.

=== Use the Dolibarr date picker ===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== Add your own setup page (optional) ==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

=== Create your page to edit parameters ===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

=== Modify the descriptor file of your module ===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php");
</source>
If the page is in the directory '''mymodule/admin/''', then like this:
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</source>

=== Test your page ===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

== Define your entries in menu (optional) ==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

=== Define your menu entries ===
For this, you must define into the module descriptor, the array this->menu that declare all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

To show menu or not depending on a permission, modify property '''perms''' in array. See chapter on permissions later to see how to add permissions.

=== Test your menu entries ===
Disable and reenable your module under Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

== Add your own permissions (optional) ==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<source lang="php">
$this->rights_class = 'mymodule'
</source>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</source>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any new created user.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''').
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<source lang="php">
if ($user->rights->mymodule->action->subaction) ...
</source>

== Define you own box (optional) ==
'''When''': If your module need to provide one or several new boxes to show on home page.

=== Define your box ===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<source lang="php">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</source>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

=== Test if your box is detected by Dolibarr ===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activated. Activate the box and go on home page to see if the box is showing correctly.

== Define your own export (optional) ==
'''When''': If your module provide new predefined database export profiles (for its own tables or for already existing tables of another module).

=== Define export ===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

=== Test your export ===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

== Define your CSS styles (optional) ==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).

=== Create and declare your style sheet ===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have only one CSS file per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS file only if you need absolutely to add not already existing styles.

Once your style sheet is ready, declare it into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be a relative URL to your CSS file.
For example
<source lang="php">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php'));
</source>

=== Test your style sheet ===
Disable and enable your module.

Go on home page (index.php). Show the HTML source of the page.

You should see into the HTML header, a line that declare your style sheet.

== Add your Javascript functions (optional) ==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

== Run your own code on any Dolibarr event (optional) ==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

== Insert your code inside Dolibarr hooks positions (optional) ==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See previous chapter for adding code during a business event).

See page [[Hooks_system]].

== Add your own numbering rules ==
'''When''': When you need a new rule for generated ref of elements that is not covered by existing rules.

See page [[Create numbering module]].

== Add your document template (optional) ==
'''When''': When you want to personalized your own generated PDF or ODT documents.

Note: To add this feature you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

== Add your skin (optional) ==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions =
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Using MDA =
A method to generate a functional module from a UML model has been developed. More information on the page [[UML2Dolibarr - Build a module using MDA]].

=Create a package to distribute and install your module =
This process must be used to generate a package to submit it on the http://www.dolistore.com market place.
But you can use it to have a package easy to distribute on your on network.

* Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

* Run the script via Perl (need the Perl version 5.0 or later):
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

* The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:
<source lang="bash">
tar -xvf mymodule.zip
</source>

* If you want your module to be public, you can submit it (the zip file) on Dolibarr market place web site: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").
** If your module was build correctly, file will be validated later.
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).

= Enabling/activation condition of external module on DoliStore =

See [[Module_Dolistore_Validation_Rules|Validation Rules]]

Module development

2015-08-10T06:19:10Z

Aikhan: /* Modify the descriptor file of your module */

[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :
* Add new tables in database
* Add your own menu entries
* Add new screens to edit new tables
* Add or remove tabs on object view (invoice, product, order, event, ...)
* Add predefined exports for the internal export tool
* Add new information boxes in the home page
* Add new substitutions variables
* Define new permissions
* Execute code automatically triggered by a particular Dolibarr action
* Insert your code inside Dolibarr hooks positions
* Add your numbering module
* Add a new document template
* Add a new skin
etc...
All those operations are possible with version 3.2 or more of Dolibarr.

Following chapters presents how to do all of this manually with an easy way. For experienced developers, a method to do this using MDA generation is also on the work. See last chapter for this.

=Example of Template External Module=
A good model to start development of external module can be found here : [https://github.com/rdoursenaud/dolibarr-module-template GitHub Dolibarr Module Modèle]

=Create your module =
== Create a Module descriptor for your Module (required) ==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin or a document template).

=== Create your module descriptor ===
The first step is to create a file descriptor for the module.
* Create directory '''/htdocs/''mymodule''/core/modules'''. Then copy the file modMyModule.class.php from the directory dev/skeletons into this directory '''htdocs/''mymodule''/core/modules'''. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').
Next modify the contents of this file as follows:
* Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
* Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult tha page that lists already reserved id numbers: [[List of modules id|List of modules id]].
* Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).
Your file descriptor for your module is ready.

=== Test your descriptor ===

Launch Dolibarr and go to page '''Setup->module'''? You must see a new line with your new module and the possibility to activate it or not (browse all the tabs of each category of modules to find it). The value of $this->special determines in which tab will be your module.

== Tree of path for new module files (required) ==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only second line is mandatory.

{{TemplateModuleTreeSimple}}

== Create your SQL tables and the PHP DAO class (optional) ==
'''When''': If your module needs to manage data of its own

=== Create your .sql file ===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and load data for your own module must be placed in a directory: Create a subdirectory called "sql" into directory of your module (eg htdocs/mymodule/sql) to put the sql scripts that you will create.

Then check into your descriptor file, into function '''init''' that the line

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

is not commented.

''Rules to follow:''
* Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table, with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).

* To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.

Example of content of a file data.sql
<source lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</source>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

=== Test your .sql files ===

Once the files ready, you can return to Dolibarr to disable the module, drop those tables in database and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

=== Generate the PHP DAO class ===
Once you have created your tables into the database, move to the dev/skeletons directory and run the script

<source lang="bash">php build_class_from_table.php tablename</source>
Note: If the command does not work, try to use php-cli php instead.

This will generate a file '''out.tablename.class.php''' that contains the class to manage table tablename.
In this class, you can find the CRUD methods (Create / Read / Update / Delete) already working to do an insert, a fetch (select), an update, a delete of a row in table.
Remove just the "out" from the file name and put the file in a subdirectory of '''htdocs''' specific to your module (in htdocs/mymodule for example).

A file '''out.tablename_script.php''' has been generated and contains a sample code to use the class for each of the 4 CRUD methods.

== The tab management (optional) ==

=== Add or removed your own tabs on object sheets ===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"
* Part 1: The element type (objecttype) where should the tab appears is a value from the following:
{{TemplateModuleTabs}}
* Part 2: A code to identify tab to add (start with +) or to remove (start with -)
* Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
* Part 4: The name of the file. Lang which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file into the lang file of module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
* Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
* Part 6: The url of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

=== Show tabs navigation into your own pages ===
'''When''': To show all standard tabs of an object (produit, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<source lang="php">require_once($url_fichier) ;</source>

This is list of those files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :
* Object thirdparty (thirdparty) :
** DOL_DOCUMENT_ROOT/societe.class.php
** DOL_DOCUMENT_ROOT/lib/company.lib.php
* Object product (product) :
** DOL_DOCUMENT_ROOT/product.class.php
** DOL_DOCUMENT_ROOT/lib/product.lib.php
* Object invoice (invoice) :
** DOL_DOCUMENT_ROOT/facture.class.php
** DOL_DOCUMENT_ROOT/lib/invoice.lib.php

'''2. Create and load the object to show into your tab'''

Create instance of object of the correct class and load object from database by using the fetch method of object en providing to this method the id you get from url (ie : /mytab.php?id=1).

''Example :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</source>

'''3. Get list of all tabs to show for your object type'''

Use fonction XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. Parameter to put into this method is the instance of object you want tabs.

The resulting array has the following structure
<source lang="php">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</source>

''Example :''
<source lang="php">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</source>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</source>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

== Create or modify PHP screens (optional) ==
'''When''': If the purpose of your module is to add features that require new or modified screens.

=== Create a new PHP screen ===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''dev/skeletons''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''skeletons_page.php''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.
The modules developed for all version of Dolibarr after the 3.2 should be able to be moved in a different folder than "htdocs", like "htdocs/custom", without having to modify the source code of the module, that's why we make several includes, so this rule must be applied by all modules.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

* $user Objet that contains the characteristics of the user + his permissions.
* $conf Objet that contains Dolibarr configuration.
* $db Objet that contains an opened connection handler to the database.
* $langs Objet that contains the user's language.

Then enter your code to display the page.

* To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):
''Example :''
<source lang="php">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</source>

* To include classes provided with Dolibarr, use the following syntax:
''Example :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== Add some fields into existing forms ===
You may want to provide a module that add more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means disable the "New element" menu entry and adding yours, and disable tab that show element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerfull since you can change everything you want into page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...
* First thing is to add a table, owned by your module, to store value of new fields. This table will have only one column called "rowid" (will contains same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
* Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.
If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

=== Replace parts of screen that are templated (version 3.3+) ===
Some parts of Dolibarr screen are isolated into native PHP template files.
You can develop a module to overwrite such templates with yours.
{{ToComplete}}

=== Add/replace part of fields supported by hooks ===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

=== Database access ===
If you need to edit some data in database inside you own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<source lang="php">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</source>

To read:

<source lang="php">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== Define style of your pages ===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

* class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
* class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
* class="'''flat'''" on all input fields (''input, select, textarea''...).
* class="'''button'''" on HTML fields with type ''input type="submit"''.

=== Use the Dolibarr date picker ===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== Add your own setup page (optional) ==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

=== Create your page to edit parameters ===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

=== Modify the descriptor file of your module ===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php");
</source>
If the page is in the directory '''mymodule/admin/''', then like this:
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</source>

=== Test your page ===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

== Define your entries in menu (optional) ==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

=== Define your menu entries ===
For this, you must define into the module descriptor, the array this->menu that declare all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

To show menu or not depending on a permission, modify property '''perms''' in array. See chapter on permissions later to see how to add permissions.

=== Test your menu entries ===
Disable and reenable your module under Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

== Add your own permissions (optional) ==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<source lang="php">
$this->rights_class = 'mymodule'
</source>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</source>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any new created user.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''').
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<source lang="php">
if ($user->rights->mymodule->action->subaction) ...
</source>

== Define you own box (optional) ==
'''When''': If your module need to provide one or several new boxes to show on home page.

=== Define your box ===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<source lang="php">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</source>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

=== Test if your box is detected by Dolibarr ===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activated. Activate the box and go on home page to see if the box is showing correctly.

== Define your own export (optional) ==
'''When''': If your module provide new predefined database export profiles (for its own tables or for already existing tables of another module).

=== Define export ===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

=== Test your export ===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

== Define your CSS styles (optional) ==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).

=== Create and declare your style sheet ===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have only one CSS file per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS file only if you need absolutely to add not already existing styles.

Once your style sheet is ready, declare it into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be a relative URL to your CSS file.
For example
<source lang="php">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php'));
</source>

=== Test your style sheet ===
Disable and enable your module.

Go on home page (index.php). Show the HTML source of the page.

You should see into the HTML header, a line that declare your style sheet.

== Add your Javascript functions (optional) ==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

== Run your own code on any Dolibarr event (optional) ==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

== Insert your code inside Dolibarr hooks positions (optional) ==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See previous chapter for adding code during a business event).

See page [[Hooks_system]].

== Add your own numbering rules ==
'''When''': When you need a new rule for generated ref of elements that is not covered by existing rules.

See page [[Create numbering module]].

== Add your document template (optional) ==
'''When''': When you want to personalized your own generated PDF or ODT documents.

Note: To add this feature you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

== Add your skin (optional) ==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions =
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Using MDA =
A method to generate a functional module from a UML model has been developed. More information on the page [[UML2Dolibarr - Build a module using MDA]].

=Create a package to distribute and install your module =
This process must be used to generate a package to submit it on the http://www.dolistore.com market place.
But you can use it to have a package easy to distribute on your on network.

* Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

* Run the script via Perl (need the Perl version 5.0 or later):
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

* The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:
<source lang="bash">
tar -xvf mymodule.zip
</source>

* If you want your module to be public, you can submit it (the zip file) on Dolibarr market place web site: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").
** If your module was build correctly, file will be validated later.
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).

= Enabling/activation condition of external module on DoliStore =

See [[Module_Dolistore_Validation_Rules|Validation Rules]]

Module development

2015-08-10T06:18:00Z

Aikhan: /* Modify the descriptor file of your module */

[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :
* Add new tables in database
* Add your own menu entries
* Add new screens to edit new tables
* Add or remove tabs on object view (invoice, product, order, event, ...)
* Add predefined exports for the internal export tool
* Add new information boxes in the home page
* Add new substitutions variables
* Define new permissions
* Execute code automatically triggered by a particular Dolibarr action
* Insert your code inside Dolibarr hooks positions
* Add your numbering module
* Add a new document template
* Add a new skin
etc...
All those operations are possible with version 3.2 or more of Dolibarr.

Following chapters presents how to do all of this manually with an easy way. For experienced developers, a method to do this using MDA generation is also on the work. See last chapter for this.

=Example of Template External Module=
A good model to start development of external module can be found here : [https://github.com/rdoursenaud/dolibarr-module-template GitHub Dolibarr Module Modèle]

=Create your module =
== Create a Module descriptor for your Module (required) ==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin or a document template).

=== Create your module descriptor ===
The first step is to create a file descriptor for the module.
* Create directory '''/htdocs/''mymodule''/core/modules'''. Then copy the file modMyModule.class.php from the directory dev/skeletons into this directory '''htdocs/''mymodule''/core/modules'''. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').
Next modify the contents of this file as follows:
* Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
* Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult tha page that lists already reserved id numbers: [[List of modules id|List of modules id]].
* Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).
Your file descriptor for your module is ready.

=== Test your descriptor ===

Launch Dolibarr and go to page '''Setup->module'''? You must see a new line with your new module and the possibility to activate it or not (browse all the tabs of each category of modules to find it). The value of $this->special determines in which tab will be your module.

== Tree of path for new module files (required) ==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only second line is mandatory.

{{TemplateModuleTreeSimple}}

== Create your SQL tables and the PHP DAO class (optional) ==
'''When''': If your module needs to manage data of its own

=== Create your .sql file ===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and load data for your own module must be placed in a directory: Create a subdirectory called "sql" into directory of your module (eg htdocs/mymodule/sql) to put the sql scripts that you will create.

Then check into your descriptor file, into function '''init''' that the line

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

is not commented.

''Rules to follow:''
* Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table, with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).

* To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.

Example of content of a file data.sql
<source lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</source>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

=== Test your .sql files ===

Once the files ready, you can return to Dolibarr to disable the module, drop those tables in database and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

=== Generate the PHP DAO class ===
Once you have created your tables into the database, move to the dev/skeletons directory and run the script

<source lang="bash">php build_class_from_table.php tablename</source>
Note: If the command does not work, try to use php-cli php instead.

This will generate a file '''out.tablename.class.php''' that contains the class to manage table tablename.
In this class, you can find the CRUD methods (Create / Read / Update / Delete) already working to do an insert, a fetch (select), an update, a delete of a row in table.
Remove just the "out" from the file name and put the file in a subdirectory of '''htdocs''' specific to your module (in htdocs/mymodule for example).

A file '''out.tablename_script.php''' has been generated and contains a sample code to use the class for each of the 4 CRUD methods.

== The tab management (optional) ==

=== Add or removed your own tabs on object sheets ===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"
* Part 1: The element type (objecttype) where should the tab appears is a value from the following:
{{TemplateModuleTabs}}
* Part 2: A code to identify tab to add (start with +) or to remove (start with -)
* Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
* Part 4: The name of the file. Lang which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file into the lang file of module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
* Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
* Part 6: The url of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

=== Show tabs navigation into your own pages ===
'''When''': To show all standard tabs of an object (produit, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<source lang="php">require_once($url_fichier) ;</source>

This is list of those files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :
* Object thirdparty (thirdparty) :
** DOL_DOCUMENT_ROOT/societe.class.php
** DOL_DOCUMENT_ROOT/lib/company.lib.php
* Object product (product) :
** DOL_DOCUMENT_ROOT/product.class.php
** DOL_DOCUMENT_ROOT/lib/product.lib.php
* Object invoice (invoice) :
** DOL_DOCUMENT_ROOT/facture.class.php
** DOL_DOCUMENT_ROOT/lib/invoice.lib.php

'''2. Create and load the object to show into your tab'''

Create instance of object of the correct class and load object from database by using the fetch method of object en providing to this method the id you get from url (ie : /mytab.php?id=1).

''Example :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</source>

'''3. Get list of all tabs to show for your object type'''

Use fonction XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. Parameter to put into this method is the instance of object you want tabs.

The resulting array has the following structure
<source lang="php">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</source>

''Example :''
<source lang="php">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</source>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</source>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

== Create or modify PHP screens (optional) ==
'''When''': If the purpose of your module is to add features that require new or modified screens.

=== Create a new PHP screen ===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''dev/skeletons''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''skeletons_page.php''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.
The modules developed for all version of Dolibarr after the 3.2 should be able to be moved in a different folder than "htdocs", like "htdocs/custom", without having to modify the source code of the module, that's why we make several includes, so this rule must be applied by all modules.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

* $user Objet that contains the characteristics of the user + his permissions.
* $conf Objet that contains Dolibarr configuration.
* $db Objet that contains an opened connection handler to the database.
* $langs Objet that contains the user's language.

Then enter your code to display the page.

* To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):
''Example :''
<source lang="php">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</source>

* To include classes provided with Dolibarr, use the following syntax:
''Example :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== Add some fields into existing forms ===
You may want to provide a module that add more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means disable the "New element" menu entry and adding yours, and disable tab that show element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerfull since you can change everything you want into page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...
* First thing is to add a table, owned by your module, to store value of new fields. This table will have only one column called "rowid" (will contains same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
* Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.
If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

=== Replace parts of screen that are templated (version 3.3+) ===
Some parts of Dolibarr screen are isolated into native PHP template files.
You can develop a module to overwrite such templates with yours.
{{ToComplete}}

=== Add/replace part of fields supported by hooks ===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

=== Database access ===
If you need to edit some data in database inside you own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<source lang="php">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</source>

To read:

<source lang="php">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== Define style of your pages ===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

* class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
* class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
* class="'''flat'''" on all input fields (''input, select, textarea''...).
* class="'''button'''" on HTML fields with type ''input type="submit"''.

=== Use the Dolibarr date picker ===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== Add your own setup page (optional) ==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

=== Create your page to edit parameters ===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

=== Modify the descriptor file of your module ===
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set name of this PHP page.
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php");
</source>
If the page is in the directory '''mymodule/admin''', then like this:
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php@mymodule");
</source>

=== Test your page ===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

== Define your entries in menu (optional) ==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

=== Define your menu entries ===
For this, you must define into the module descriptor, the array this->menu that declare all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

To show menu or not depending on a permission, modify property '''perms''' in array. See chapter on permissions later to see how to add permissions.

=== Test your menu entries ===
Disable and reenable your module under Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

== Add your own permissions (optional) ==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<source lang="php">
$this->rights_class = 'mymodule'
</source>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</source>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any new created user.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''').
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<source lang="php">
if ($user->rights->mymodule->action->subaction) ...
</source>

== Define you own box (optional) ==
'''When''': If your module need to provide one or several new boxes to show on home page.

=== Define your box ===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<source lang="php">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</source>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

=== Test if your box is detected by Dolibarr ===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activated. Activate the box and go on home page to see if the box is showing correctly.

== Define your own export (optional) ==
'''When''': If your module provide new predefined database export profiles (for its own tables or for already existing tables of another module).

=== Define export ===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

=== Test your export ===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

== Define your CSS styles (optional) ==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).

=== Create and declare your style sheet ===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have only one CSS file per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS file only if you need absolutely to add not already existing styles.

Once your style sheet is ready, declare it into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be a relative URL to your CSS file.
For example
<source lang="php">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php'));
</source>

=== Test your style sheet ===
Disable and enable your module.

Go on home page (index.php). Show the HTML source of the page.

You should see into the HTML header, a line that declare your style sheet.

== Add your Javascript functions (optional) ==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

== Run your own code on any Dolibarr event (optional) ==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

== Insert your code inside Dolibarr hooks positions (optional) ==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See previous chapter for adding code during a business event).

See page [[Hooks_system]].

== Add your own numbering rules ==
'''When''': When you need a new rule for generated ref of elements that is not covered by existing rules.

See page [[Create numbering module]].

== Add your document template (optional) ==
'''When''': When you want to personalized your own generated PDF or ODT documents.

Note: To add this feature you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

== Add your skin (optional) ==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions =
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Using MDA =
A method to generate a functional module from a UML model has been developed. More information on the page [[UML2Dolibarr - Build a module using MDA]].

=Create a package to distribute and install your module =
This process must be used to generate a package to submit it on the http://www.dolistore.com market place.
But you can use it to have a package easy to distribute on your on network.

* Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

* Run the script via Perl (need the Perl version 5.0 or later):
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

* The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:
<source lang="bash">
tar -xvf mymodule.zip
</source>

* If you want your module to be public, you can submit it (the zip file) on Dolibarr market place web site: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").
** If your module was build correctly, file will be validated later.
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).

= Enabling/activation condition of external module on DoliStore =

See [[Module_Dolistore_Validation_Rules|Validation Rules]]

Module development

2015-08-10T06:08:39Z

Aikhan: /* Add your own setup page (optional) */

[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :
* Add new tables in database
* Add your own menu entries
* Add new screens to edit new tables
* Add or remove tabs on object view (invoice, product, order, event, ...)
* Add predefined exports for the internal export tool
* Add new information boxes in the home page
* Add new substitutions variables
* Define new permissions
* Execute code automatically triggered by a particular Dolibarr action
* Insert your code inside Dolibarr hooks positions
* Add your numbering module
* Add a new document template
* Add a new skin
etc...
All those operations are possible with version 3.2 or more of Dolibarr.

Following chapters presents how to do all of this manually with an easy way. For experienced developers, a method to do this using MDA generation is also on the work. See last chapter for this.

=Example of Template External Module=
A good model to start development of external module can be found here : [https://github.com/rdoursenaud/dolibarr-module-template GitHub Dolibarr Module Modèle]

=Create your module =
== Create a Module descriptor for your Module (required) ==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin or a document template).

=== Create your module descriptor ===
The first step is to create a file descriptor for the module.
* Create directory '''/htdocs/''mymodule''/core/modules'''. Then copy the file modMyModule.class.php from the directory dev/skeletons into this directory '''htdocs/''mymodule''/core/modules'''. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').
Next modify the contents of this file as follows:
* Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
* Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult tha page that lists already reserved id numbers: [[List of modules id|List of modules id]].
* Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).
Your file descriptor for your module is ready.

=== Test your descriptor ===

Launch Dolibarr and go to page '''Setup->module'''? You must see a new line with your new module and the possibility to activate it or not (browse all the tabs of each category of modules to find it). The value of $this->special determines in which tab will be your module.

== Tree of path for new module files (required) ==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only second line is mandatory.

{{TemplateModuleTreeSimple}}

== Create your SQL tables and the PHP DAO class (optional) ==
'''When''': If your module needs to manage data of its own

=== Create your .sql file ===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and load data for your own module must be placed in a directory: Create a subdirectory called "sql" into directory of your module (eg htdocs/mymodule/sql) to put the sql scripts that you will create.

Then check into your descriptor file, into function '''init''' that the line

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

is not commented.

''Rules to follow:''
* Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table, with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).

* To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.

Example of content of a file data.sql
<source lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</source>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

=== Test your .sql files ===

Once the files ready, you can return to Dolibarr to disable the module, drop those tables in database and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

=== Generate the PHP DAO class ===
Once you have created your tables into the database, move to the dev/skeletons directory and run the script

<source lang="bash">php build_class_from_table.php tablename</source>
Note: If the command does not work, try to use php-cli php instead.

This will generate a file '''out.tablename.class.php''' that contains the class to manage table tablename.
In this class, you can find the CRUD methods (Create / Read / Update / Delete) already working to do an insert, a fetch (select), an update, a delete of a row in table.
Remove just the "out" from the file name and put the file in a subdirectory of '''htdocs''' specific to your module (in htdocs/mymodule for example).

A file '''out.tablename_script.php''' has been generated and contains a sample code to use the class for each of the 4 CRUD methods.

== The tab management (optional) ==

=== Add or removed your own tabs on object sheets ===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"
* Part 1: The element type (objecttype) where should the tab appears is a value from the following:
{{TemplateModuleTabs}}
* Part 2: A code to identify tab to add (start with +) or to remove (start with -)
* Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
* Part 4: The name of the file. Lang which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file into the lang file of module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
* Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
* Part 6: The url of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

=== Show tabs navigation into your own pages ===
'''When''': To show all standard tabs of an object (produit, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<source lang="php">require_once($url_fichier) ;</source>

This is list of those files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :
* Object thirdparty (thirdparty) :
** DOL_DOCUMENT_ROOT/societe.class.php
** DOL_DOCUMENT_ROOT/lib/company.lib.php
* Object product (product) :
** DOL_DOCUMENT_ROOT/product.class.php
** DOL_DOCUMENT_ROOT/lib/product.lib.php
* Object invoice (invoice) :
** DOL_DOCUMENT_ROOT/facture.class.php
** DOL_DOCUMENT_ROOT/lib/invoice.lib.php

'''2. Create and load the object to show into your tab'''

Create instance of object of the correct class and load object from database by using the fetch method of object en providing to this method the id you get from url (ie : /mytab.php?id=1).

''Example :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</source>

'''3. Get list of all tabs to show for your object type'''

Use fonction XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. Parameter to put into this method is the instance of object you want tabs.

The resulting array has the following structure
<source lang="php">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</source>

''Example :''
<source lang="php">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</source>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</source>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

== Create or modify PHP screens (optional) ==
'''When''': If the purpose of your module is to add features that require new or modified screens.

=== Create a new PHP screen ===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''dev/skeletons''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''skeletons_page.php''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.
The modules developed for all version of Dolibarr after the 3.2 should be able to be moved in a different folder than "htdocs", like "htdocs/custom", without having to modify the source code of the module, that's why we make several includes, so this rule must be applied by all modules.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

* $user Objet that contains the characteristics of the user + his permissions.
* $conf Objet that contains Dolibarr configuration.
* $db Objet that contains an opened connection handler to the database.
* $langs Objet that contains the user's language.

Then enter your code to display the page.

* To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):
''Example :''
<source lang="php">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</source>

* To include classes provided with Dolibarr, use the following syntax:
''Example :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== Add some fields into existing forms ===
You may want to provide a module that add more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means disable the "New element" menu entry and adding yours, and disable tab that show element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerfull since you can change everything you want into page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...
* First thing is to add a table, owned by your module, to store value of new fields. This table will have only one column called "rowid" (will contains same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
* Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.
If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

=== Replace parts of screen that are templated (version 3.3+) ===
Some parts of Dolibarr screen are isolated into native PHP template files.
You can develop a module to overwrite such templates with yours.
{{ToComplete}}

=== Add/replace part of fields supported by hooks ===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

=== Database access ===
If you need to edit some data in database inside you own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<source lang="php">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</source>

To read:

<source lang="php">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== Define style of your pages ===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

* class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
* class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
* class="'''flat'''" on all input fields (''input, select, textarea''...).
* class="'''button'''" on HTML fields with type ''input type="submit"''.

=== Use the Dolibarr date picker ===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== Add your own setup page (optional) ==
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.

=== Create your page to edit parameters ===
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).

=== Modify the descriptor file of your module ===
Then, within the descriptor file of your module, modify the variable config_page_url to set name of this PHP page (without the path, which is not necesary if the page is inside directory admin).
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php");
</source>

=== Test your page ===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

== Define your entries in menu (optional) ==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

=== Define your menu entries ===
For this, you must define into the module descriptor, the array this->menu that declare all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

To show menu or not depending on a permission, modify property '''perms''' in array. See chapter on permissions later to see how to add permissions.

=== Test your menu entries ===
Disable and reenable your module under Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

== Add your own permissions (optional) ==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<source lang="php">
$this->rights_class = 'mymodule'
</source>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</source>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any new created user.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''').
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<source lang="php">
if ($user->rights->mymodule->action->subaction) ...
</source>

== Define you own box (optional) ==
'''When''': If your module need to provide one or several new boxes to show on home page.

=== Define your box ===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<source lang="php">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</source>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

=== Test if your box is detected by Dolibarr ===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activated. Activate the box and go on home page to see if the box is showing correctly.

== Define your own export (optional) ==
'''When''': If your module provide new predefined database export profiles (for its own tables or for already existing tables of another module).

=== Define export ===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

=== Test your export ===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

== Define your CSS styles (optional) ==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).

=== Create and declare your style sheet ===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have only one CSS file per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS file only if you need absolutely to add not already existing styles.

Once your style sheet is ready, declare it into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be a relative URL to your CSS file.
For example
<source lang="php">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php'));
</source>

=== Test your style sheet ===
Disable and enable your module.

Go on home page (index.php). Show the HTML source of the page.

You should see into the HTML header, a line that declare your style sheet.

== Add your Javascript functions (optional) ==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

== Run your own code on any Dolibarr event (optional) ==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

== Insert your code inside Dolibarr hooks positions (optional) ==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See previous chapter for adding code during a business event).

See page [[Hooks_system]].

== Add your own numbering rules ==
'''When''': When you need a new rule for generated ref of elements that is not covered by existing rules.

See page [[Create numbering module]].

== Add your document template (optional) ==
'''When''': When you want to personalized your own generated PDF or ODT documents.

Note: To add this feature you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

== Add your skin (optional) ==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions =
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Using MDA =
A method to generate a functional module from a UML model has been developed. More information on the page [[UML2Dolibarr - Build a module using MDA]].

=Create a package to distribute and install your module =
This process must be used to generate a package to submit it on the http://www.dolistore.com market place.
But you can use it to have a package easy to distribute on your on network.

* Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

* Run the script via Perl (need the Perl version 5.0 or later):
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

* The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:
<source lang="bash">
tar -xvf mymodule.zip
</source>

* If you want your module to be public, you can submit it (the zip file) on Dolibarr market place web site: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").
** If your module was build correctly, file will be validated later.
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).

= Enabling/activation condition of external module on DoliStore =

See [[Module_Dolistore_Validation_Rules|Validation Rules]]

Module development

2015-08-10T06:01:46Z

Aikhan: /* Create your page to edit parameters */

[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :
* Add new tables in database
* Add your own menu entries
* Add new screens to edit new tables
* Add or remove tabs on object view (invoice, product, order, event, ...)
* Add predefined exports for the internal export tool
* Add new information boxes in the home page
* Add new substitutions variables
* Define new permissions
* Execute code automatically triggered by a particular Dolibarr action
* Insert your code inside Dolibarr hooks positions
* Add your numbering module
* Add a new document template
* Add a new skin
etc...
All those operations are possible with version 3.2 or more of Dolibarr.

Following chapters presents how to do all of this manually with an easy way. For experienced developers, a method to do this using MDA generation is also on the work. See last chapter for this.

=Example of Template External Module=
A good model to start development of external module can be found here : [https://github.com/rdoursenaud/dolibarr-module-template GitHub Dolibarr Module Modèle]

=Create your module =
== Create a Module descriptor for your Module (required) ==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin or a document template).

=== Create your module descriptor ===
The first step is to create a file descriptor for the module.
* Create directory '''/htdocs/''mymodule''/core/modules'''. Then copy the file modMyModule.class.php from the directory dev/skeletons into this directory '''htdocs/''mymodule''/core/modules'''. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').
Next modify the contents of this file as follows:
* Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
* Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult tha page that lists already reserved id numbers: [[List of modules id|List of modules id]].
* Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).
Your file descriptor for your module is ready.

=== Test your descriptor ===

Launch Dolibarr and go to page '''Setup->module'''? You must see a new line with your new module and the possibility to activate it or not (browse all the tabs of each category of modules to find it). The value of $this->special determines in which tab will be your module.

== Tree of path for new module files (required) ==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only second line is mandatory.

{{TemplateModuleTreeSimple}}

== Create your SQL tables and the PHP DAO class (optional) ==
'''When''': If your module needs to manage data of its own

=== Create your .sql file ===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables and load data for your own module must be placed in a directory: Create a subdirectory called "sql" into directory of your module (eg htdocs/mymodule/sql) to put the sql scripts that you will create.

Then check into your descriptor file, into function '''init''' that the line

<source lang="php">$this->_load_tables('/mymodule/sql/');</source>

is not commented.

''Rules to follow:''
* Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table, with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).

* To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.

Example of content of a file data.sql
<source lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</source>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

=== Test your .sql files ===

Once the files ready, you can return to Dolibarr to disable the module, drop those tables in database and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

=== Generate the PHP DAO class ===
Once you have created your tables into the database, move to the dev/skeletons directory and run the script

<source lang="bash">php build_class_from_table.php tablename</source>
Note: If the command does not work, try to use php-cli php instead.

This will generate a file '''out.tablename.class.php''' that contains the class to manage table tablename.
In this class, you can find the CRUD methods (Create / Read / Update / Delete) already working to do an insert, a fetch (select), an update, a delete of a row in table.
Remove just the "out" from the file name and put the file in a subdirectory of '''htdocs''' specific to your module (in htdocs/mymodule for example).

A file '''out.tablename_script.php''' has been generated and contains a sample code to use the class for each of the 4 CRUD methods.

== The tab management (optional) ==

=== Add or removed your own tabs on object sheets ===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"
* Part 1: The element type (objecttype) where should the tab appears is a value from the following:
{{TemplateModuleTabs}}
* Part 2: A code to identify tab to add (start with +) or to remove (start with -)
* Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
* Part 4: The name of the file. Lang which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file into the lang file of module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
* Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
* Part 6: The url of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

=== Show tabs navigation into your own pages ===
'''When''': To show all standard tabs of an object (produit, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<source lang="php">require_once($url_fichier) ;</source>

This is list of those files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :
* Object thirdparty (thirdparty) :
** DOL_DOCUMENT_ROOT/societe.class.php
** DOL_DOCUMENT_ROOT/lib/company.lib.php
* Object product (product) :
** DOL_DOCUMENT_ROOT/product.class.php
** DOL_DOCUMENT_ROOT/lib/product.lib.php
* Object invoice (invoice) :
** DOL_DOCUMENT_ROOT/facture.class.php
** DOL_DOCUMENT_ROOT/lib/invoice.lib.php

'''2. Create and load the object to show into your tab'''

Create instance of object of the correct class and load object from database by using the fetch method of object en providing to this method the id you get from url (ie : /mytab.php?id=1).

''Example :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</source>

'''3. Get list of all tabs to show for your object type'''

Use fonction XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. Parameter to put into this method is the instance of object you want tabs.

The resulting array has the following structure
<source lang="php">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</source>

''Example :''
<source lang="php">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</source>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</source>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

== Create or modify PHP screens (optional) ==
'''When''': If the purpose of your module is to add features that require new or modified screens.

=== Create a new PHP screen ===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''dev/skeletons''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''skeletons_page.php''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.
The modules developed for all version of Dolibarr after the 3.2 should be able to be moved in a different folder than "htdocs", like "htdocs/custom", without having to modify the source code of the module, that's why we make several includes, so this rule must be applied by all modules.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

* $user Objet that contains the characteristics of the user + his permissions.
* $conf Objet that contains Dolibarr configuration.
* $db Objet that contains an opened connection handler to the database.
* $langs Objet that contains the user's language.

Then enter your code to display the page.

* To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):
''Example :''
<source lang="php">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</source>

* To include classes provided with Dolibarr, use the following syntax:
''Example :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== Add some fields into existing forms ===
You may want to provide a module that add more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means disable the "New element" menu entry and adding yours, and disable tab that show element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerfull since you can change everything you want into page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...
* First thing is to add a table, owned by your module, to store value of new fields. This table will have only one column called "rowid" (will contains same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
* Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.
If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

=== Replace parts of screen that are templated (version 3.3+) ===
Some parts of Dolibarr screen are isolated into native PHP template files.
You can develop a module to overwrite such templates with yours.
{{ToComplete}}

=== Add/replace part of fields supported by hooks ===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

=== Database access ===
If you need to edit some data in database inside you own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<source lang="php">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</source>

To read:

<source lang="php">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== Define style of your pages ===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

* class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
* class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
* class="'''flat'''" on all input fields (''input, select, textarea''...).
* class="'''button'''" on HTML fields with type ''input type="submit"''.

=== Use the Dolibarr date picker ===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== Add your own setup page (optional) ==
'''When''': If your module need to ask user several parameters.

=== Create your page to edit parameters ===
If your module need several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above mentioned table.
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).
Then, within the descriptor file of your module, modify the variable config_page_url to set name of this PHP page (without the path, which is not necesary if the page is inside directory admin).
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php");
</source>

=== Test your page ===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

== Define your entries in menu (optional) ==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

=== Define your menu entries ===
For this, you must define into the module descriptor, the array this->menu that declare all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

To show menu or not depending on a permission, modify property '''perms''' in array. See chapter on permissions later to see how to add permissions.

=== Test your menu entries ===
Disable and reenable your module under Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

== Add your own permissions (optional) ==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<source lang="php">
$this->rights_class = 'mymodule'
</source>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</source>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any new created user.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''').
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<source lang="php">
if ($user->rights->mymodule->action->subaction) ...
</source>

== Define you own box (optional) ==
'''When''': If your module need to provide one or several new boxes to show on home page.

=== Define your box ===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<source lang="php">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</source>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

=== Test if your box is detected by Dolibarr ===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activated. Activate the box and go on home page to see if the box is showing correctly.

== Define your own export (optional) ==
'''When''': If your module provide new predefined database export profiles (for its own tables or for already existing tables of another module).

=== Define export ===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

=== Test your export ===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

== Define your CSS styles (optional) ==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).

=== Create and declare your style sheet ===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have only one CSS file per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS file only if you need absolutely to add not already existing styles.

Once your style sheet is ready, declare it into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be a relative URL to your CSS file.
For example
<source lang="php">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php'));
</source>

=== Test your style sheet ===
Disable and enable your module.

Go on home page (index.php). Show the HTML source of the page.

You should see into the HTML header, a line that declare your style sheet.

== Add your Javascript functions (optional) ==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

== Run your own code on any Dolibarr event (optional) ==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

== Insert your code inside Dolibarr hooks positions (optional) ==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See previous chapter for adding code during a business event).

See page [[Hooks_system]].

== Add your own numbering rules ==
'''When''': When you need a new rule for generated ref of elements that is not covered by existing rules.

See page [[Create numbering module]].

== Add your document template (optional) ==
'''When''': When you want to personalized your own generated PDF or ODT documents.

Note: To add this feature you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

== Add your skin (optional) ==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions =
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Using MDA =
A method to generate a functional module from a UML model has been developed. More information on the page [[UML2Dolibarr - Build a module using MDA]].

=Create a package to distribute and install your module =
This process must be used to generate a package to submit it on the http://www.dolistore.com market place.
But you can use it to have a package easy to distribute on your on network.

* Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

* Run the script via Perl (need the Perl version 5.0 or later):
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

* The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:
<source lang="bash">
tar -xvf mymodule.zip
</source>

* If you want your module to be public, you can submit it (the zip file) on Dolibarr market place web site: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").
** If your module was build correctly, file will be validated later.
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).

= Enabling/activation condition of external module on DoliStore =

See [[Module_Dolistore_Validation_Rules|Validation Rules]]

Language and development rules

2015-08-07T04:52:25Z

Aikhan: /* Classes and properties structures */

{{TemplateDocDevEn}}

This is some rules on language, syntax and norm we use into Dolibarr project:

= Versions =
* Dolibarr must work on:
# All OS (Windows, Linux, MACOS...)
# PHP {{PHPMinVersion}} (Must work with no need of complementary PHP module, except module to PHP module to access database).
# Mysql {{MySqlMinVersion}}

= Copyright Norms =
* All PHP files must start with a header that looks like
<source lang="php">
<?php
/* Copyright (C) YYYY John Doe <email@email.com>
*
* Licence information
*/
...
</source>
When you edit an existing file of project, you must add a Copyright line under others.

= PHP Norms =
== PHP ==
* Dolibarr is written with PHP and supports all PHP version higher than {{PHPMinVersion}}. All files must end with extension .php

* Usage of PHP superglobals variables must use dedicated operators $_COOKIES, $_SERVER, $_ENV but use Dolibarr function GETPOST() to get content of $_GET or $_POST..
Other operators ($HTTP_SERVER_GET, ...) are now deprecated inside PHP, so they must no more be used. Like that code will work also if option '''register_long_arrays''' is set to off.
Moreover, the code must work when PHP option '''register_globals''' is off (recommended by PHP). It must work the same way when the option '''register_globals''' is on (by default on a lot of installations).

* Do not use '''PHP_SELF'''. Use instead $_SERVER["PHP_SELF"]. Also, Dolibarr framework sanitizes content of $_SERVER["PHP_SELF"] variable (into main.inc.php file, so before any business code).

* When several variables must be initialized with same value, you must use several instructions (separated with ;)
<source lang="php">
$var1=1;$var2=1;$var3=1;
</source>
instead of
<source lang="php">
$var1=$var2=$var3=1;
</source>
that is slower.

* String must be rounded by simple or double quote and a variable within the string must be out side of the quote.
<source lang="php">
print 'My text show my '.$variable.' !';
</source>

* Comments must use the C syntax, ie a double slash for a comment on one line and a slash-star to open a bloc for several lines
<source lang="php">
/* Bloc of comment
*
* End of bloc
*/

$monobjet = new MonObjet($db);
$result=$monobjet->fetch($idobject);

for ($i = 1 , $i < 2 ; $i++)
{
// comment on one line
print $i;
}

</source>

* Functions must return a value equal or higher than 0 if successful and strictly lower than 0 if error.

* No dead code (code never used) into Dolibarr core code (code used by external modules only must be included within the external modules).

* Use "include_once" for anything with functions or class definitions in it (like *.class.php and *.lib.php files), use "include" for template-style php with files containing common part of HTML and PHP code (like *.inc.php and *.tpl.php files).

* Coding style to use is the PSR-2 (https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md). There is however exceptions:
** Length of line: PSR-2 mention we can go up to 120 characters on same line, this is a soft limit. It is better to have long lines instead of long page with code content that is just data declaration and does not contain any logic. However, we introduced a hard limit of '''1000''' characters (having line larger that this will return errors on Continuous Integration tests).
** Tabs are allowed: The other exception is that we don't replace the tabs with spaces. Using tabs is more convenient for most editors/developers. Also using spaces breaks some auto-format features (like Eclipse autoformat feature on some Eclipse version).
** Note 1: The following rule are very important to follow:
*** Files must be saved with Unix format (LF) and not Windows (CR/LF). Unix format is compatible on all OS such as Unix like, Windows, Mac, but the Windows text file format may not work on some PHP under Unix.
*** Smart tags PHP are not used. PHP code section must start with '''<?php'''
** Note 2: You can use the file '''dev/codesniffer/ruleset.xml''' as rule file to control coding style with PHPCodeSniffer.
** Note 3: You may note that current code is not yet compliant with this rule. The reason is that we must "now" follow the PSR-2, but it wasn't in the past. So feel free to change coding style to match new rules if you find such cases.

== Classes and properties structures ==

Some properties of classes are found in different classes. To avoid having different names, we will use the following names:
* date_creation: date of creation
* user_creation: object User creating object
* fk_user_creation: id of user creating object
* date_modification: date of last modification
* user_modification: object User performing the modification
* fk_user_modification: id of user doing modification
* date_validation: date validation
* user_validation: object User
* fk_user_validation: id of user making validation

= SQL rules =

== Table and fields structures ==

* Structure of tables.
When you create a new table, it is recommended to use the same conventions as other Dolibarr tables. This means the following fields:
- rowid integer for id
- tms timestamp that will contain date of last modification (the database manages this field automatically, no need to manage it by the code, just create the field)
- import_key that will contains the import code YYYYMMDDHHMMSS if you make mass import.
Eventualy
- datec timestamp that is the creation date
- fk_user_author integer that is the id of user making creation
- fk_user_mod integer that is the id of user making change
- fk_soc integer that is the ID of the Thirdparty

Note field:
- note_private text for private comment of the object
- note_pubic text for public comment of the object
or
- note text if there is no need to have private and public

* Type of fields:
Well, to be compatible with any accuracy required by any country on amounts, and with any database syntax, we will use the following type into database:
- integer for an any of foreign key
- double(24,8) for any amount
- double(6,3) for any vat rate
- real for a quantity
- varchar for a string (also if length is 1, the type char is more and more deprecated)
- timestamp for a field date+time that is automatically updated
- datetime for a field date+time
- date for a field date

* All tables has a prefix to avoid name conflicts with other projects. In current version this prefix is fixed ans can't be modified. Its value is <tt>llx_</tt>. In a future version this value should be modified during installation process.

== Primary keys ==
The primary key of a table must be called <tt>rowid</tt>.

Some old tables does not use this rule and use a primary key called <tt>id</tt> (ie [[Table llx_c_actioncomm]]), but the reason is history and this should not happens anymore.

== Foreign keys ==
Name of a foreign key must start with the prefix <tt>fk_</tt> followed by the table name (i.e. name of the referencing table) (this is required to avoid duplicate names in project that are not allowed even if in different tables by some DBMS like Postgresql) then the field name (i.e. name of the referencing field) (this is to allow to have several foreign keys in same table).

Example:
''fk_facture_fourn_fk_soc'' is a foreign key in the table llx_facture_fourn for the field fk_soc in this table (that references the rowid field in another table)

Note: If you develop your own external module, it must have no foreign keys that point to Dolibarr standard tables. This will break standard dolibarr upgrades, repair, backup and restore tools and may also break standard features.

== Alternative keys ==
Sometimes, we need another unique keys than primary key. We can add in this case an alternate unique key. When we need this, we can create an alternate unique key. Such an index is called by a name that start by prefix <tt>uk_</tt> followed by an underscore, then the the table name (this is required to avoid duplicate names of unique keys that may create problems for some DBMS like Postgresql) and then another string to define the key (this is to allow to have several unique keys on same table).

Example:
''uk_societe_code_client'' is a unique key on table llx_societe on field code_client.

== Index performance ==
Some fields are often used as search or order criteria, or for joins. In such case, we need to set a performance index on field to increase performances. Such indexes are named with a prefix <tt>idx_</tt> then the table name and then the field name.

Example:
''idx_societe_user_creat'' is a performance index on table llx_societe for field user_creat

== DDL file format ==
Files containing definition of the database structure (DDL files) must be '''2 per table''':
* The first file defines the table and its fields. The file name contains the table name, e.g. like this: <tt>llx_''mytable''.sql</tt>
A comment will be added for each field to explain its usage.
* The second file defines all foreign keys, performance indexes or other constraints and the file name will be like: <tt>llx_''mytable''.key.sql</tt>

These files must be stored in the directory '''install/mysql/tables''' for all standard files or '''mymodule/tables''' for tables provided by an external module.

Example: '''file for creating the table llx_mytable will be llx_mytable.sql''':

<source lang="sql">
-- ===========================================================================
-- Copyright (C) 2013 Author <email@author.com>
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 3 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with this program. If not, see <http://www.gnu.org/licenses/>.
-- ===========================================================================

create table llx_mytable
(
rowid integer NOT NULL AUTO_INCREMENT PRIMARY KEY,
ref varchar(30) NOT NULL, -- object reference number
entity integer DEFAULT 1 NOT NULL, -- multi company id
ref_ext varchar(255),-- reference into an external system (not used by dolibarr)
field_one integer,
field_two integer NOT NULL,
fk_field integer,
field_date datetime,
datec timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,, -- creation datetime
tms timestamp, -- update time stamp
fk_user_author integer NOT NULL, -- Author, foreign key of llx_user
fk_user_mod integer NOT NULL, -- Last updater, foreign key of llx_user
import_key varchar(14) -- Use by import process
)type=innodb;
</source>

Example: '''file for creating keys/indexes for the table llx_mytable will be llx_mytable.key.sql''':

<source lang="sql">
-- ===========================================================================
-- Copyright (C) 2013 Author <email@author.com>
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 3 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with this program. If not, see <http://www.gnu.org/licenses/>.
-- ===========================================================================

ALTER TABLE llx_mytable ADD UNIQUE uk_mytable_field (field_one, field_two);

ALTER TABLE llx_mytable ADD CONSTRAINT fk_mytable_fk_field FOREIGN KEY (fk_field) REFERENCES llx_matablepere (rowid);
</source>

== SQL Coding rules ==
* Alias usage/Fields naming
When doing select, we can use alias to simplify writing/reading of requests:
<source lang="sql">
select chp1, chpxxx2 as chp2 from table2 as t1, table2 as t2 where t1.chpx = t2.chpy
</source>
However, we must not used alias for update request as they are not compatible with Mysql 3.1.

* Using SELECT * is forbidden ! When using SELECT you must define complete list of fields to get. This avoids confusion. Example:
<source lang="sql">
SELECT field_a, field_b, field_c FROM table_1 WHERE field_d = '$id'
</source>

* Into SQL requests, you must quote fields except the fields that contain amounts which must be stored as double or real type. Quotes on numbers may result in saving as a different value. For example 412.62 in an insert will be saved as value 412.61999512 into database (due to implicit conversion string to numeric) if the target field has type double(24,8). Only PHP see value 412.61999512. Other tools will see 412.62 giving a sense that there is no problem. But it's PHP that has the good vision. There is really a wrong value into database. By removing quotes on numbers, no problem occurs.

Example:
<source lang="sql">
Good: INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', 412.62)
Bad: INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', '412.62')
</source>

Note, problem of float numbers is same problem on all langauges and not only when inserting data into database. It occurs also with any language when you work on "real" numbers, so numbers must be, as soon as they are affected, cleaned with function price2num with second parameter defined to :
'MU' (for unit prices), 'MT' (for total prices) or 'MS' (otherwise) depending on usage of number. (see function documentation)

* Functions NOW, SYSDATE or DATEDIFF are forbidden inside SQL requests. If you must use the current date into a field, value must come from the PHP and not from the database engine. This is for better portability of code and correct management of TimeZone.

For example, don't do:
<source lang="php">
$sql="SELECT rowid FROM table where datefield = NOW()";
</source>
but do:
<source lang="php">
$sql="SELECT rowid FROM table where datefield = '".$this->db->idate(dol_now())."'";
</source>

For example, don't do:
<source lang="php">
$sql="SELECT rowid FROM table where DATEDIFF(table.datefield, NOW()) > 7";
</source>
but do:
<source lang="php">
$sql="SELECT rowid FROM table where datefield < '".$this->db->idate(dol_now() - (7 * 24 * 3600))."'";
</source>

An other advantage of this rule, is that request benefits of index because we are making a compare of a field with a fixed value. When using datediff, you make an operation on field before comparison, this means database can't use the index on field, resulting on very bad performance compared to solution without the datediff.

== Mysql specificities ==
* Tables must be declared with format InnoDB.
This format supports foreign keys and their restrictions, and transactions integrity is also supported. This guarantees that Dolibarr events keep all data with correct values between tables even when transaction modify different tables.

* Dolibarr must work even if Mysql option '''strict''' is active.
To activate it (recommended when developing on Dolibarr), add the following line into the config file of your Mysql server (my.cnf or my.ini)
<source lang="ini">
sql-mode="STRICT_ALL_TABLES,ONLY_FULL_GROUP_BY,NO_ZERO_DATE"
</source>

== PostgreSQL specificities ==
Only Mysql SQL files must be maintained.
Those files are converted "on the fly" by the database Dolibarr driver.

There is an exception
The SQL "UPDATE FROM":

MySQL Syntax:
<source lang="sql">
UPDATE table_taget as target, table_source as source SET fieldtarget=source.fieldsource
WHERE source.rowid=target.rowid;
</source>

PgSQL Syntax:
<source lang="sql">
UPDATE table_taget as target SET fieldtarget=source.fieldsource
FROM table_source as source WHERE source.rowid=target.rowid;
</source>

There is no native SQL request "update from" in dolibarr core. But in your module you should do :
<source lang="php">
if ($this->db->type=='pgsql') {
$sql="UPDATE table_taget as target SET fieldtarget=source.fieldsource
FROM table_source as source WHERE source.rowid=target.rowid";
} else {
$sql= "UPDATE table_taget as target, table_source as source SET fieldtarget=source.fieldsource
WHERE source.rowid=target.rowid";
}
</source>

= HTML norms =
== Syntax rules ==
* HTML used must be HTML compliant and not XHTML. All attributes of HTML tags must be in lower case and quoted with ".

* Links href must be absolute and use the function dol_buildpath() to get absolute path from a relative path and img tag must be build using function img_picto().
For example:
<source lang="php">
print '<a href="'.dol_buildpath('/mydir/mypage.php').'">'.img_picto('Texte alt','namepictopng','').'</a>';
</source>

* HTML tables must have columns with no forced width, except for columns that contains data we know the length. For example, a column with a picto only can be forced to with="20px".
Otherwise, we must avoid forcing the column width. Reason is that, in most cases, the browser make a better works to define column width automatically than forced values, and it works whatever is the resolution.

* Javascript/ajax code and call to javascript files into php pages must be avoided. However, if you need to include javascript code, you must add a condition on "$conf->use_javascript_ajax"
<source lang="php">
if ($conf->use_javascript_ajax) {
... // php code generating javascript here
}
</source>

* Popup windows must not be used, except for tooltips (and must have a condition as explained before).

* External scripts must be written in Perl if they can't be written in PHP. Usage of another language is not forbidden but must be argued before in the development mailing-list.

== External templating framework ? ==
There is ton of frameworks to provide a templating language of an HTML page. The best and faster is just called "PHP", and because Dolibarr already depends on PHP, there is no need for depend on a third languages.

All templating frameworks are just preprocessor, BEFORE PHP. It can't be faster than PHP alone. When we say "speed, when using cache of templating framework, is increase", it is in fact the overtime spent by the framework that is reduced by cache, not the speed of processing PHP file. We should says "any templating framework has an overload over PHP, the cache of framework, just reduce the slowing effect of using it", but not "the speed is increased, it is always increased".

Above all, having a templating system is completely possible by doing a "'''.tpl.php'''" file that dos not contains any logic code, but only HTML and echo. We get same result (but faster and easier to develop because it does not need to do all the setXXX) before calling each template. All variables (known by code that include the template) are automaticaly known into a PHP template page. No risk to forget a set, and a lot of line of codes reduced, a lot of time saved.

Also, keeping a 100% isolation between code and HTML output is interesting in only 1 situation: When teams building design is complety different than team building logic code, AND if you build not too sophisticated pages, AND with no need of too many Ajax features (this need to know how code works).
And this situation is surely not the Dolibarr future (team will often be same, Ajax will be more and more present, event if I hope not too much, and screens are more and more dependent of dynamic or contextual events, difficult to have with a template without transforming the template into a page with high level of code).

There is a ton of other reasons to not use an external templating system and all arguments to use them are the best argument to use PHP as our templating system.

= Dolibarr norms and code skeleton =

== Skeleton code ==
To standardize the code, and to speed up the development of new components in Dolibarr, you'll find 4 skeletons fully prepared in the directory '''dev/skeletons'''.

* 1 that serves as an example of the module description: '''myModule.class.php'''
* 1 that serves as an example of code for creating a new class: '''skeleton_class.class.php'''
* 1 that serves as an example of code for creating a new page: '''skeleton_page.php'''
* 1 that serves as an example of code for creating a script for executing command lines: '''skeleton_script.php'''

Use it as an example.
Note that the skeletons are also used by the PHP code generator, which is described in the development chapter of Dolibarr modules, to speed up your development.

== Dates and Timezones ==
Dolibarr is an application that is multi-user and multi-location. It's therefore necessary to store dates in the right format. To avoid problems with conversions, the following rules should be applied:

* A date into memory must always be stored with Timestamp GMT format.
* A date stored into database, is the GMT Timestamp of date submitted into the request usng the <b>PHP server</b> timezone. This does not apply to date update automatically by database (fields '''tms''' into database).
For exemple le 1st january 1970, 3 hour at Paris (TZ=+1) = 2 hour at Greenwitch (TZ=0) will be stored into memory with value 7200 and will be submitted into a SQL request to database with the string '19700101030000' (PHP convert into its TZ hour and databse will unconvert it using its timezone too that is same than PHP).

All select methods should translate date fields, that are with format TZ of database ('19700101030000'), into a timestamp field by calling the method db->jdate. This is to store into memory a GTM Timestamp date. All insert methods must convert, during generation of SQL request, the memory date into the string by using db->idate (you may find examples into skeleton).

* Dates that are updated automatically (field '''tms''' into database) contains a GMT Timestamp GMT of date when change is done. The select will also use the db->jdate (that use PHP server TZ) to convert read data into a GMT Timestamp into memory. So if timezone of database differs from timezone of PHP server (one of them is not correctly set), you may experience differences between creation date and update date.

* Manipulation date with PHP must be done using the Dolibarr date functions: '''dol_now(), dol_mktime(), dol_stringtotime(), dol_getdate(), dol_time_plus_duree()'''. You may also find other functions available into file '''date.lib.php'''.

== UTF8/ISO encoding ==
Dolibarr stores data in the following way:
* In database, data is stored in UTF8 or ISO. It depends on the database's pagecode therefore these options are set at creation time. In any case, Dolibarr's database driver (in lib/database) deals with it to convert from/to UTF8 at insertion and readout.
* Memory data is stored in UTF8 (PHP object instances).
* Screen displayed web pages are UTF8 (for versions prior to 2.5.1, the deprecated $character_set parameter from conf.php file defines output format).

== Float numbers, amount and calculation ==
With PHP, like other languages (Java for exemple), non integer data (float, real, double) are not reliable for calculation.
Try to make for example
<source lang="php">
print 239.2 - 229.3 - 9.9;
</source>
You wont get zero but a very small decimal number. If you get zero her, you should be able to find other examples that don't work.
Problem of float is general, so a variable that is a result of a calculation using decimal numbers must ALWAYS be cleaned using the function '''price2num()''' with the econd parameter to: 'MU', 'MT' or 'MS' depending on need (see description of function).
<source lang="php">
print price2num(239.2 - 229.3 - 9.9, 'MT');
</source>
If data manipulated is not an amount, then using MU, MT, MS has no sense, and you must use the function '''round()'''.

== Creation of tables ==
Do not create tables, on the fly, during execution by a standard user, we mean, during current usage of software.
If you create a module that uses its own table, not available in the default Dolibarr code, then take a look at tutorial [[Module Development]]. It explains how to provide new tables with your module, so that, the tables will be created during module activation and not during module usage.

== Logs ==
Add logs to your code using function
<source lang="php">
dol_syslog($yourmessage, LOG_INFO|LOG_DEBUG|LOG_WARNING|LOG_ERR);
</source>

== Working directory ==
If you need to create a working directory, into your code, refer to it with
'''DOL_DATA_ROOT.'/mymodule''''

The directory can be created into your code by the following function:
<source lang="php">
$mymoduledir=DOL_DATA_ROOT.'/mymodule';
dol_mkdir($mymoduledir);
</source>

If you need a directory to store temporary data, this directory must be '''DOL_DATA_ROOT.'/mymodule/temp''''

= Design patterns and Object programming =

== Creation design patterns (GoF) ==
Design patterns defined by the Gang Of Four (see wikipédia on [[wikipedia:Design pattern|Design patters]]).
No usage of such patterns is required. We found some objects next to Singletons or Factory but not completely compliant with syntax, this is to be compatible with PHP 4 that is not a pure object language.

== Structure design patterns (GoF) ==
Design patterns defined by the Gang Of Four (see wikipédia on [[wikipedia:Design pattern|Design patters]]).
No usage of such patterns is required.

== Behavior design patterns (GoF) ==
Design patterns defined by the Gang Of Four (see wikipédia on [[wikipedia:Design pattern|Design patters]]).
No usage of such patterns is required.

== Design patterns of enterprise (Martin Fowler) ==

=== Patterns of code organization ===
[[wikipedia:Martin Fowler|Martin Fowler]] has identified 3 ways to organize code:
* The '''Transaction Script''' (The source code is linear for each user action).
This is the old school used by all procedural languages.
Inconvenient: Redundancy of code. Need to know the physical model of data to develop.
* The '''Domain Model'''
This notion is available with object languages. It is business process (to identify before) that are used for objects classes.
Inconvenient: Model very complex to maintain.
* The '''Table Module'''
This is a mix between 2 previous where we have only one unique class for each table of database.

-> As shown in code skeletons (see previous chapter), Dolibarr uses concept of '''Table Module'''.

=== Communication between business logic - data (ORM) ===

There are 3 ways to make links:

* The '''Table And Row Data Gateway'''
This is the most simple. You have one class per table and each class is a link to the table with CRUD methods (Ceate, Read, Update, Delete). A class instance is a record in the table. The class contains only code to reach lines and fields of table.

Example: This mode is used by some ORM Frameworks, like '''iBatis''' (http://ibatis.apache.org/).

* The '''Active Record'''
Same as previous, but we are allowed to add some business functions into the class, if such functions are dedicated to the table or recording into this table.

Example: This mode is used for Dolibarr development and most PHP softwares that include their own framework and best practices.

* The '''Data Mapper'''
Classes represent entities of the problem and not the data. So you have to double, triple ... these classes with Mapper classes to access the data.
More "purist" on paper (closer of business), this method also has the disadvantage of being more complex in practice.

Example: This is the choice if you use the ORM Framework '''Propel''' (http://propel.phpdb.org/trac/). We find this model in heavier applications, based on this ORM among others.

-> For Dolibarr development, it is recommended to use the connection mode '''Active Record''', which offers the advantages of a model close to the business without having the complexity, without obfuscating technical architecture. It is by this way that the development, understanding of code and technical maintenance and / or business behaviour seems the more productive (this is however an ongoing debate between the purists and the pragmatists, debate in which nobody can really be right, because it depends on the objectives).

Module development

2015-06-11T09:13:41Z

Aikhan: /* Create a descriptor of Module (required) */

[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :
* Add new tables in database
* Add your own menu entries
* Add new screens to edit new tables
* Add or remove tabs on object view (invoice, product, order, event, ...)
* Add predefined exports for the internal export tool
* Add new information boxes in the home page
* Add new substitutions variables
* Define new permissions
* Execute code automatically triggered by a particular Dolibarr action
* Insert your code inside Dolibarr hooks positions
* Add your numbering module
* Add a new document template
* Add a new skin
etc...
All those operations are possible with version 3.2 or more of Dolibarr.

Following chapters presents how to do all of this manually with an easy way. For experienced developers, a method to do this using MDA generation is also on the work. See last chapter for this.

=Example of Template External Module=
A good model to start development of external module can be found here : [https://github.com/rdoursenaud/dolibarr-module-template GitHub Dolibarr Module Modèle]

=Create your module =
== Create a Module descriptor for your Module (required) ==
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin or a document template).

=== Create your module descriptor ===
The first step is to create a file descriptor for the module.
* Create directory '''/htdocs/''mymodule''/core/modules'''. Then copy the file modMyModule.class.php from the directory dev/skeletons into this directory '''htdocs/''mymodule''/core/modules'''. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').
Next modify the contents of this file as follows:
* Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
* Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult tha page that lists already reserved id numbers: [[List of modules id|List of modules id]].
* Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).
Your file descriptor for your module is ready.

=== Test your descriptor ===

Launch Dolibarr and go to page '''Setup->module'''? You must see a new line with your new module and the possibility to activate it or not (browse all the tabs of each category of modules to find it). The value of $this->special determines in which tab will be your module.

== Tree of path for new module files (required) ==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only second line is mandatory.

{{TemplateModuleTreeSimple}}

== Create your SQL tables and the PHP DAO class (optional) ==
'''When''': If your module needs to manage data of its own

=== Create your .sql file ===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables of your own module must be placed in a directory.

Create a subdirectory called "sql" into directory of your module (eg htdocs/mymodule/sql) to put the sql scripts that you will create. Then in the "load_tables" function of your file descriptor module, modify the line

<source lang="php">$dir = DOL_DOCUMENT_ROOT.'/mymodule/sql/';</source>
by
<source lang="php">$dir = DOL_DOCUMENT_ROOT.'/valuechooseformymodule/sql/';</source>

''Rules to follow:''
* Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).

* To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.

Example of content of a file data.sql
<source lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</source>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

=== Test your .sql files ===

Once the files ready, you can return to Dolibarr to disable the module, drop those tables in database and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

=== Generate the PHP DAO class ===
Once you have created your tables into the database, move to the dev/skeletons directory and run the script

<source lang="bash">php build_class_from_table.php tablename</source>
Note: If the command does not work, try to use php-cli php instead.

This will generate a file '''out.tablename.class.php''' that contains the class to manage table tablename.
In this class, you can find the CRUD methods (Create / Read / Update / Delete) already working to do an insert, a fetch (select), an update, a delete of a row in table.
Remove just the "out" from the file name and put the file in a subdirectory of '''htdocs''' specific to your module (in htdocs/mymodule for example).

A file '''out.tablename_script.php''' has been generated and contains a sample code to use the class for each of the 4 CRUD methods.

== The tab management (optional) ==

=== Add or removed your own tabs on object sheets ===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"
* Part 1: The element type (objecttype) where should the tab appears is a value from the following:
{{TemplateModuleTabs}}
* Part 2: A code to identify tab to add (start with +) or to remove (start with -)
* Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
* Part 4: The name of the file. Lang which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file into the lang file of module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
* Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
* Part 6: The url of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

=== Show tabs navigation into your own pages ===
'''When''': To show all standard tabs of an object (produit, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<source lang="php">require_once($url_fichier) ;</source>

This is list of those files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :
* Object thirdparty (thirdparty) :
** DOL_DOCUMENT_ROOT/societe.class.php
** DOL_DOCUMENT_ROOT/lib/company.lib.php
* Object product (product) :
** DOL_DOCUMENT_ROOT/product.class.php
** DOL_DOCUMENT_ROOT/lib/product.lib.php
* Object invoice (invoice) :
** DOL_DOCUMENT_ROOT/facture.class.php
** DOL_DOCUMENT_ROOT/lib/invoice.lib.php

'''2. Create and load the object to show into your tab'''

Create instance of object of the correct class and load object from database by using the fetch method of object en providing to this method the id you get from url (ie : /mytab.php?id=1).

''Example :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</source>

'''3. Get list of all tabs to show for your object type'''

Use fonction XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. Parameter to put into this method is the instance of object you want tabs.

The resulting array has the following structure
<source lang="php">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</source>

''Example :''
<source lang="php">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</source>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</source>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

== Create or modify PHP screens (optional) ==
'''When''': If the purpose of your module is to add features that require new or modified screens.

=== Create a new PHP screen ===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''dev/skeletons''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''skeletons_page.php''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.
The modules developed for all version of Dolibarr after the 3.2 should be able to be moved in a different folder than "htdocs", like "htdocs/custom", without having to modify the source code of the module, that's why we make several includes, so this rule must be applied by all modules.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

* $user Objet that contains the characteristics of the user + his permissions.
* $conf Objet that contains Dolibarr configuration.
* $db Objet that contains an opened connection handler to the database.
* $langs Objet that contains the user's language.

Then enter your code to display the page.

* To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):
''Example :''
<source lang="php">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</source>

* To include classes provided with Dolibarr, use the following syntax:
''Example :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== Add some fields into existing forms ===
You may want to provide a module that add more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means disable the "New element" menu entry and adding yours, and disable tab that show element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerfull since you can change everything you want into page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...
* First thing is to add a table, owned by your module, to store value of new fields. This table will have only one column called "rowid" (will contains same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
* Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.
If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

=== Replace parts of screen that are templated (version 3.3+) ===
Some parts of Dolibarr screen are isolated into native PHP template files.
You can develop a module to overwrite such templates with yours.
{{ToComplete}}

=== Add/replace part of fields supported by hooks ===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

=== Database access ===
If you need to edit some data in database inside you own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<source lang="php">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</source>

To read:

<source lang="php">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== Define style of your pages ===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

* class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
* class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
* class="'''flat'''" on all input fields (''input, select, textarea''...).
* class="'''button'''" on HTML fields with type ''input type="submit"''.

=== Use the Dolibarr date picker ===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== Add your own setup page (optional) ==
'''When''': If your module need to ask user several parameters.

=== Create your page to edit parameters ===
If your module need several parameters to be setup, you must create a page to edit options (that will be saved into [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that show possibles options and update them into table from a form.
It is a necessary to take an example from a page into directory '''/admin''' that will show you the way to read/save your parameter.
Put this page into directory '''/admin'''.
Then, into the descriptor file of your module, modify the variable config_page_url to set name of this PHP page (without the path that is not necesary if page is inside directory admin).
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php");
</source>

=== Test your page ===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

== Define your entries in menu (optional) ==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

=== Define your menu entries ===
For this, you must define into the module descriptor, the array this->menu that declare all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

To show menu or not depending on a permission, modify property '''perms''' in array. See chapter on permissions later to see how to add permissions.

=== Test your menu entries ===
Disable and reenable your module under Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

== Add your own permissions (optional) ==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<source lang="php">
$this->rights_class = 'mymodule'
</source>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</source>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any new created user.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''').
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<source lang="php">
if ($user->rights->mymodule->action->subaction) ...
</source>

== Define you own box (optional) ==
'''When''': If your module need to provide one or several new boxes to show on home page.

=== Define your box ===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<source lang="php">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</source>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

=== Test if your box is detected by Dolibarr ===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activated. Activate the box and go on home page to see if the box is showing correctly.

== Define your own export (optional) ==
'''When''': If your module provide new predefined database export profiles (for its own tables or for already existing tables of another module).

=== Define export ===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

=== Test your export ===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

== Define your CSS styles (optional) ==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).

=== Create and declare your style sheet ===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have only one CSS file per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS file only if you need absolutely to add not already existing styles.

Once your style sheet is ready, declare it into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be a relative URL to your CSS file.
For example
<source lang="php">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php'));
</source>

=== Test your style sheet ===
Disable and enable your module.

Go on home page (index.php). Show the HTML source of the page.

You should see into the HTML header, a line that declare your style sheet.

== Add your Javascript functions (optional) ==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

== Run your own code on any Dolibarr event (optional) ==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

== Insert your code inside Dolibarr hooks positions (optional) ==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See previous chapter for adding code during a business event).

See page [[Hooks_system]].

== Add your own numbering rules ==
'''When''': When you need a new rule for generated ref of elements that is not covered by existing rules.

See page [[Create numbering module]].

== Add your document template (optional) ==
'''When''': When you want to personalized your own generated PDF or ODT documents.

Note: To add this feature you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

== Add your skin (optional) ==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions =
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Using MDA =
A method to generate a functional module from a UML model has been developed. More information on the page [[UML2Dolibarr - Build a module using MDA]].

=Create a package to distribute and install your module =
This process must be used to generate a package to submit it on the http://www.dolistore.com market place.
But you can use it to have a package easy to distribute on your on network.

* Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

* Run the script via Perl (need the Perl version 5.0 or later):
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

* The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:
<source lang="bash">
tar -xvf mymodule.zip
</source>

* If you want your module to be public, you can submit it (the zip file) on Dolibarr market place web site: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").
** If your module was build correctly, file will be validated later.
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).

= Enabling/activation condition of external module on DoliStore =

See [[Module_Dolistore_Validation_Rules|Validation Rules]]

List of modules id

2015-06-11T05:33:11Z

Aikhan: /* ID 100000 - 499999 */

[[Category:Core]]
{{TemplateDocDevEn}}
{{TemplateDocDevEs}}
{{TemplateDocDevFr}}

{{Flag en}} This page list all reserved modules numbers / ID. If you build or want to build your own modules (like this [[:Category:Complementary_modules|complementary module]]), you should take an ID range here.

{{Flag fr}} Cette page recense tous les numéros / ID réservés de modules. Si vous avez réalisé ou voulez réaliser vos propres modules (comme les [[:Category:Modules complémentaires|modules complémentaires suivant]]), vous devriez prendre une plage d'ID ici.

{{Flag sp}} Esta página contiene un listado de todos los id reservados para los módulos. Si ha creado o quiere realizar sus propios módulos, (como estos [[:Category:Módulos_complementarios|módulos complementarios]]), deberá reservarse un rango de ID aquí.

= ID 0 - 99999 =
{{Flag en}} Reserved for Dolibarr's internal modules.

{{Flag fr}} Réservé aux modules internes de Dolibarr.

{{Flag sp}} Reservado a los módulos internos de Dolibarr.

= ID 100000 - 499999 =
{{Flag en}} Reserved area for editors in need for an ID range. You can edit this page to add your own range (limited to 1000 values per editor)

{{Flag fr}} Zone réservé aux éditeurs qui ont besoin d'une plage d'ID spécifiques. Vous pouvez modifier cette page pour réserver votre plage (limité à 1000 valeurs par éditeur)

{{Flag sp}} Área reservada para los partners que necesiten un rango de ID. Puede modificar esta página para reservar su rango (limitado a 1000 valores por editor)

* ID 100000 - 100999: OpenThink (http://www.openthink.be)
* ID 101000 - 101999: NLTechno (http://www.nltechno.com)
* ID 102000 - 102999: Tiaris (http://www.tiaris.fr)
* ID 103000 - 103999: Open-concept.pro (http://www.open-concept.pro)
* ID 104000 - 104999: ATM Consulting (http://www.atm-consulting.fr)
* ID 105000 - 105999: GPC.solutions
* ID 106000 - 106999: PHPASSO
* ID 107000 - 107999: TecLib (http://www.teclib.com)
* ID 108000 - 108999: ETHICWEB
* ID 109000 - 109999: Aplose
* ID 110000 - 110999: Aternatik
* ID 120000 - 120999: Régis Houssin (http://www.inodbox.com)
* ID 130000 - 130999: Technicks ICT (http://www.technicks.eu)
* ID 140000 - 140999: Altairis
* ID 150000 - 150999: Jeffinfo
* ID 160000 - 160999: Charles-François BENKE ( patas-monkey.com)
* ID 190000 - 190999: Diciannove (http://19.coop)
* ID 199000 - 199999: RFMS
* ID 200000 - 200999: Noxiome
* ID 205000 - 205999: Kreiz IT
* ID 300000 - 300999: AtooNet (http://www.atoo-net.com)
* ID 400000 - 400999: 2byte.es (http://www.2byte.es)
* ID 401000 - 401999: B&D Informática
* ID 402000 - 402999: Marcos García de La Fuente (marcosgdf)
* ID 403000 - 403999: Sergibyte (http://www.sergibyte.com)
* ID 501000 - 501999: Aikhan

= ID > 500000 =
{{Flag en}} If you don't already have reserved ids and need some, please don't use a round number and use a number higher than 500000. If you have a wiki account, you can reserve your own range by editing the 100000 - 499999 range (1000 ids maximum per partner).

{{Flag fr}} Si vous n'avez pas de numéros réservés et en avez besoin, n'utilisez pas de chiffres rond et utilisez une valeur supérieure à 500000. Si vous avez un compte wiki, vous pouvez réserver vous-même votre plage en ajoutant votre entrée dans la zone 100000 - 499999 (pas plus de 1000 numéros par partenaire).

{{Flag sp}} Si no dispone de número reservado y necesita, no use cifras redondeadas y usa un valor superior a 500000. Si tiene una cuenta wiki, puede reservarse usted mismo sus id añadiendo su entrada en la zona 100000 - 499999 (no más de 1000 id por partner).

Module development

2015-06-11T04:32:52Z

Aikhan: /* Create your .sql file */

[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :
* Add new tables in database
* Add your own menu entries
* Add new screens to edit new tables
* Add or remove tabs on object view (invoice, product, order, event, ...)
* Add predefined exports for the internal export tool
* Add new information boxes in the home page
* Add new substitutions variables
* Define new permissions
* Execute code automatically triggered by a particular Dolibarr action
* Insert your code inside Dolibarr hooks positions
* Add your numbering module
* Add a new document template
* Add a new skin
etc...
All those operations are possible with version 3.2 or more of Dolibarr.

Following chapters presents how to do all of this manually with an easy way. For experienced developers, a method to do this using MDA generation is also on the work. See last chapter for this.

=Example of Template External Module=
A good model to start development of external module can be found here : [https://github.com/rdoursenaud/dolibarr-module-template GitHub Dolibarr Module Modèle]

=Create your module =
== Create a descriptor of Module (required) ==
'''When''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin or a document template).

=== Create your module descriptor ===
The first step is to create a file descriptor for the module.
* Create directory '''/htdocs/''mymodule''/core/modules'''. Then copy the file modMyModule.class.php from the directory dev/skeletons into this directory '''htdocs/''mymodule''/core/modules'''. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').
Next modify the contents of this file as follows:
* Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
* Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult tha page that lists already reserved id numbers: [[List of modules id|List of modules id]].
* Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).
Your file descriptor for your module is ready.

=== Test your descriptor ===

Launch Dolibarr and go to page '''Setup->module'''? You must see a new line with your new module and the possibility to activate it or not (browse all the tabs of each category of modules to find it). The value of $this->special determines in which tab will be your module.

== Tree of path for new module files (required) ==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only second line is mandatory.

{{TemplateModuleTreeSimple}}

== Create your SQL tables and the PHP DAO class (optional) ==
'''When''': If your module needs to manage data of its own

=== Create your .sql file ===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables of your own module must be placed in a directory.

Create a subdirectory called "sql" into directory of your module (eg htdocs/mymodule/sql) to put the sql scripts that you will create. Then in the "load_tables" function of your file descriptor module, modify the line

<source lang="php">$dir = DOL_DOCUMENT_ROOT.'/mymodule/sql/';</source>
by
<source lang="php">$dir = DOL_DOCUMENT_ROOT.'/valuechooseformymodule/sql/';</source>

''Rules to follow:''
* Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).

* To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.

Example of content of a file data.sql
<source lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</source>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

=== Test your .sql files ===

Once the files ready, you can return to Dolibarr to disable the module, drop those tables in database and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

=== Generate the PHP DAO class ===
Once you have created your tables into the database, move to the dev/skeletons directory and run the script

<source lang="bash">php build_class_from_table.php tablename</source>
Note: If the command does not work, try to use php-cli php instead.

This will generate a file '''out.tablename.class.php''' that contains the class to manage table tablename.
In this class, you can find the CRUD methods (Create / Read / Update / Delete) already working to do an insert, a fetch (select), an update, a delete of a row in table.
Remove just the "out" from the file name and put the file in a subdirectory of '''htdocs''' specific to your module (in htdocs/mymodule for example).

A file '''out.tablename_script.php''' has been generated and contains a sample code to use the class for each of the 4 CRUD methods.

== The tab management (optional) ==

=== Add or removed your own tabs on object sheets ===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"
* Part 1: The element type (objecttype) where should the tab appears is a value from the following:
{{TemplateModuleTabs}}
* Part 2: A code to identify tab to add (start with +) or to remove (start with -)
* Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
* Part 4: The name of the file. Lang which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file into the lang file of module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
* Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
* Part 6: The url of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

=== Show tabs navigation into your own pages ===
'''When''': To show all standard tabs of an object (produit, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<source lang="php">require_once($url_fichier) ;</source>

This is list of those files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :
* Object thirdparty (thirdparty) :
** DOL_DOCUMENT_ROOT/societe.class.php
** DOL_DOCUMENT_ROOT/lib/company.lib.php
* Object product (product) :
** DOL_DOCUMENT_ROOT/product.class.php
** DOL_DOCUMENT_ROOT/lib/product.lib.php
* Object invoice (invoice) :
** DOL_DOCUMENT_ROOT/facture.class.php
** DOL_DOCUMENT_ROOT/lib/invoice.lib.php

'''2. Create and load the object to show into your tab'''

Create instance of object of the correct class and load object from database by using the fetch method of object en providing to this method the id you get from url (ie : /mytab.php?id=1).

''Example :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</source>

'''3. Get list of all tabs to show for your object type'''

Use fonction XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. Parameter to put into this method is the instance of object you want tabs.

The resulting array has the following structure
<source lang="php">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</source>

''Example :''
<source lang="php">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</source>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</source>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

== Create or modify PHP screens (optional) ==
'''When''': If the purpose of your module is to add features that require new or modified screens.

=== Create a new PHP screen ===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''dev/skeletons''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''skeletons_page.php''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.
The modules developed for all version of Dolibarr after the 3.2 should be able to be moved in a different folder than "htdocs", like "htdocs/custom", without having to modify the source code of the module, that's why we make several includes, so this rule must be applied by all modules.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

* $user Objet that contains the characteristics of the user + his permissions.
* $conf Objet that contains Dolibarr configuration.
* $db Objet that contains an opened connection handler to the database.
* $langs Objet that contains the user's language.

Then enter your code to display the page.

* To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):
''Example :''
<source lang="php">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</source>

* To include classes provided with Dolibarr, use the following syntax:
''Example :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== Add some fields into existing forms ===
You may want to provide a module that add more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means disable the "New element" menu entry and adding yours, and disable tab that show element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerfull since you can change everything you want into page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...
* First thing is to add a table, owned by your module, to store value of new fields. This table will have only one column called "rowid" (will contains same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
* Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.
If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

=== Replace parts of screen that are templated (version 3.3+) ===
Some parts of Dolibarr screen are isolated into native PHP template files.
You can develop a module to overwrite such templates with yours.
{{ToComplete}}

=== Add/replace part of fields supported by hooks ===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

=== Database access ===
If you need to edit some data in database inside you own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<source lang="php">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</source>

To read:

<source lang="php">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== Define style of your pages ===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

* class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
* class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
* class="'''flat'''" on all input fields (''input, select, textarea''...).
* class="'''button'''" on HTML fields with type ''input type="submit"''.

=== Use the Dolibarr date picker ===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== Add your own setup page (optional) ==
'''When''': If your module need to ask user several parameters.

=== Create your page to edit parameters ===
If your module need several parameters to be setup, you must create a page to edit options (that will be saved into [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that show possibles options and update them into table from a form.
It is a necessary to take an example from a page into directory '''/admin''' that will show you the way to read/save your parameter.
Put this page into directory '''/admin'''.
Then, into the descriptor file of your module, modify the variable config_page_url to set name of this PHP page (without the path that is not necesary if page is inside directory admin).
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php");
</source>

=== Test your page ===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

== Define your entries in menu (optional) ==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

=== Define your menu entries ===
For this, you must define into the module descriptor, the array this->menu that declare all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

To show menu or not depending on a permission, modify property '''perms''' in array. See chapter on permissions later to see how to add permissions.

=== Test your menu entries ===
Disable and reenable your module under Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

== Add your own permissions (optional) ==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<source lang="php">
$this->rights_class = 'mymodule'
</source>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</source>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any new created user.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''').
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<source lang="php">
if ($user->rights->mymodule->action->subaction) ...
</source>

== Define you own box (optional) ==
'''When''': If your module need to provide one or several new boxes to show on home page.

=== Define your box ===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<source lang="php">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</source>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

=== Test if your box is detected by Dolibarr ===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activated. Activate the box and go on home page to see if the box is showing correctly.

== Define your own export (optional) ==
'''When''': If your module provide new predefined database export profiles (for its own tables or for already existing tables of another module).

=== Define export ===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

=== Test your export ===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

== Define your CSS styles (optional) ==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).

=== Create and declare your style sheet ===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have only one CSS file per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS file only if you need absolutely to add not already existing styles.

Once your style sheet is ready, declare it into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be a relative URL to your CSS file.
For example
<source lang="php">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php'));
</source>

=== Test your style sheet ===
Disable and enable your module.

Go on home page (index.php). Show the HTML source of the page.

You should see into the HTML header, a line that declare your style sheet.

== Add your Javascript functions (optional) ==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

== Run your own code on any Dolibarr event (optional) ==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

== Insert your code inside Dolibarr hooks positions (optional) ==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See previous chapter for adding code during a business event).

See page [[Hooks_system]].

== Add your own numbering rules ==
'''When''': When you need a new rule for generated ref of elements that is not covered by existing rules.

See page [[Create numbering module]].

== Add your document template (optional) ==
'''When''': When you want to personalized your own generated PDF or ODT documents.

Note: To add this feature you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

== Add your skin (optional) ==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions =
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Using MDA =
A method to generate a functional module from a UML model has been developed. More information on the page [[UML2Dolibarr - Build a module using MDA]].

=Create a package to distribute and install your module =
This process must be used to generate a package to submit it on the http://www.dolistore.com market place.
But you can use it to have a package easy to distribute on your on network.

* Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

* Run the script via Perl (need the Perl version 5.0 or later):
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

* The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:
<source lang="bash">
tar -xvf mymodule.zip
</source>

* If you want your module to be public, you can submit it (the zip file) on Dolibarr market place web site: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").
** If your module was build correctly, file will be validated later.
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).

= Enabling/activation condition of external module on DoliStore =

See [[Module_Dolistore_Validation_Rules|Validation Rules]]

Module development

2015-06-11T04:31:59Z

Aikhan: /* Create your SQL tables and the PHP DAO class (optional) */

[[Category:Core]]
{{TemplateDocDevEn}}

To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :
* Add new tables in database
* Add your own menu entries
* Add new screens to edit new tables
* Add or remove tabs on object view (invoice, product, order, event, ...)
* Add predefined exports for the internal export tool
* Add new information boxes in the home page
* Add new substitutions variables
* Define new permissions
* Execute code automatically triggered by a particular Dolibarr action
* Insert your code inside Dolibarr hooks positions
* Add your numbering module
* Add a new document template
* Add a new skin
etc...
All those operations are possible with version 3.2 or more of Dolibarr.

Following chapters presents how to do all of this manually with an easy way. For experienced developers, a method to do this using MDA generation is also on the work. See last chapter for this.

=Example of Template External Module=
A good model to start development of external module can be found here : [https://github.com/rdoursenaud/dolibarr-module-template GitHub Dolibarr Module Modèle]

=Create your module =
== Create a descriptor of Module (required) ==
'''When''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin or a document template).

=== Create your module descriptor ===
The first step is to create a file descriptor for the module.
* Create directory '''/htdocs/''mymodule''/core/modules'''. Then copy the file modMyModule.class.php from the directory dev/skeletons into this directory '''htdocs/''mymodule''/core/modules'''. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').
Next modify the contents of this file as follows:
* Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").
* Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult tha page that lists already reserved id numbers: [[List of modules id|List of modules id]].
* Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).
Your file descriptor for your module is ready.

=== Test your descriptor ===

Launch Dolibarr and go to page '''Setup->module'''? You must see a new line with your new module and the possibility to activate it or not (browse all the tabs of each category of modules to find it). The value of $this->special determines in which tab will be your module.

== Tree of path for new module files (required) ==
This is how your files must be organized when building a new module (the zip file must also match this rule).
Note: Only second line is mandatory.

{{TemplateModuleTreeSimple}}

== Create your SQL tables and the PHP DAO class (optional) ==
'''When''': If your module needs to manage data of its own

=== Create your .sql file ===
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.

Scripts for creating tables in your own module must be placed in a directory.

Create a subdirectory called "sql" into directory of your module (eg htdocs/mymodule/sql) to put the sql scripts that you will create. Then in the "load_tables" function of your file descriptor module, modify the line

<source lang="php">$dir = DOL_DOCUMENT_ROOT.'/mymodule/sql/';</source>
by
<source lang="php">$dir = DOL_DOCUMENT_ROOT.'/valuechooseformymodule/sql/';</source>

''Rules to follow:''
* Add the files about creating tables commands on the principle of a file '''llx_matable.sql''' per table with a possibly file '''llx_matable.key.sql''' (see existing files in '''install/mysql/tables''' for examples).

* To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.

Example of content of a file data.sql
<source lang="sql">
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');
</source>

Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.

=== Test your .sql files ===

Once the files ready, you can return to Dolibarr to disable the module, drop those tables in database and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.

=== Generate the PHP DAO class ===
Once you have created your tables into the database, move to the dev/skeletons directory and run the script

<source lang="bash">php build_class_from_table.php tablename</source>
Note: If the command does not work, try to use php-cli php instead.

This will generate a file '''out.tablename.class.php''' that contains the class to manage table tablename.
In this class, you can find the CRUD methods (Create / Read / Update / Delete) already working to do an insert, a fetch (select), an update, a delete of a row in table.
Remove just the "out" from the file name and put the file in a subdirectory of '''htdocs''' specific to your module (in htdocs/mymodule for example).

A file '''out.tablename_script.php''' has been generated and contains a sample code to use the class for each of the 4 CRUD methods.

== The tab management (optional) ==

=== Add or removed your own tabs on object sheets ===
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)

To do this go into the file descriptor of module previously created and edit the $this->tabs array:

<source lang="php">
// Array to add new pages in new tabs or remove existing one
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2
'objecttype:-tabname'); // To remove an existing tab identified by code tabname
</source>

The table should contain a list of strings, each string representing a new tab.
The format of the string consisting of 5 parts separated by ":"
* Part 1: The element type (objecttype) where should the tab appears is a value from the following:
{{TemplateModuleTabs}}
* Part 2: A code to identify tab to add (start with +) or to remove (start with -)
* Part 3: The title of the tab. This can be a hard read or better code translation in a file lang.
* Part 4: The name of the file. Lang which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file into the lang file of module, so htdocs/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file htdocs/langs/code_CODE/mylangfile.lang
* Part 5: A condition to test if tab must be visible. Put 1 to be always visible.
* Part 6: The url of the page to display when you click on the tab. The __ID__ string will be replaced automatically by the Id of the element concerned.

To feed the contents of the tab with data from the database, see the next chapter.

=== Show tabs navigation into your own pages ===
'''When''': To show all standard tabs of an object (produit, tiers, etc.) on your page.

You must follow these steps :

'''1. Include files you need into your file'''

For each object type, there are two files to include with line
<source lang="php">require_once($url_fichier) ;</source>

This is list of those files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :
* Object thirdparty (thirdparty) :
** DOL_DOCUMENT_ROOT/societe.class.php
** DOL_DOCUMENT_ROOT/lib/company.lib.php
* Object product (product) :
** DOL_DOCUMENT_ROOT/product.class.php
** DOL_DOCUMENT_ROOT/lib/product.lib.php
* Object invoice (invoice) :
** DOL_DOCUMENT_ROOT/facture.class.php
** DOL_DOCUMENT_ROOT/lib/invoice.lib.php

'''2. Create and load the object to show into your tab'''

Create instance of object of the correct class and load object from database by using the fetch method of object en providing to this method the id you get from url (ie : /mytab.php?id=1).

''Example :''
<source lang="php">
$id=GETPOST('id','int');
$ref=GETPOST('ref','alpha');
$product = new Product($db) ;
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok
</source>

'''3. Get list of all tabs to show for your object type'''

Use fonction XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. Parameter to put into this method is the instance of object you want tabs.

The resulting array has the following structure
<source lang="php">
$head // Array of tabs
$head[$h] // Element to describe one tab.
$head[$h][0] // Url of page to show when you click on tab
$head[$h][1] // Title of tab
$head[$h][2] // Code name to identify the tab
</source>

''Example :''
<source lang="php">
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly
</source>

'''4. show tabs into your page'''

Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().

<source lang="php">
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')
//$links // Tableau des onglets, appelé $head plus haut.
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance
//$title // Title to show (shown into a special tab that you can't click)
//$notab
//$picto // Name of image to show into title. Possible values are:
// product
// service
// company
</source>

This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.

== Create or modify PHP screens (optional) ==
'''When''': If the purpose of your module is to add features that require new or modified screens.

=== Create a new PHP screen ===
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''dev/skeletons''' (For the development of a script from the command line, see [[Script development]]).

To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.

Copy, into that directory, the file '''skeletons_page.php''' that will serve as a starting point for your page file.
Edit the file to have a correct relative path to the main.inc.php file.
<source lang="php">
$res=0;
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php"); // to work if your module directory is into dolibarr root htdocs directory
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php"); // to work if your module directory is into a subdir of root htdocs directory
if (! $res) die("Include of main fails");
</source>
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.
The modules developed for all version of Dolibarr after the 3.2 should be able to be moved in a different folder than "htdocs", like "htdocs/custom", without having to modify the source code of the module, that's why we make several includes, so this rule must be applied by all modules.

It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:

* $user Objet that contains the characteristics of the user + his permissions.
* $conf Objet that contains Dolibarr configuration.
* $db Objet that contains an opened connection handler to the database.
* $langs Objet that contains the user's language.

Then enter your code to display the page.

* To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):
''Example :''
<source lang="php">
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');
</source>

* To include classes provided with Dolibarr, use the following syntax:
''Example :''
<source lang="php">
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';
</source>

=== Add some fields into existing forms ===
You may want to provide a module that add more fields into forms (input and view) of some elements.

A heavy solution (but not so bad) may be to replace all pages used to create element (this means disable the "New element" menu entry and adding yours, and disable tab that show element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerfull since you can change everything you want into page).

We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...
* First thing is to add a table, owned by your module, to store value of new fields. This table will have only one column called "rowid" (will contains same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].
* Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.
If you follow this tutorial, to be able to add fields into category forms, you must do:
{{ToComplete}}

=== Replace parts of screen that are templated (version 3.3+) ===
Some parts of Dolibarr screen are isolated into native PHP template files.
You can develop a module to overwrite such templates with yours.
{{ToComplete}}

=== Add/replace part of fields supported by hooks ===
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.

=== Database access ===
If you need to edit some data in database inside you own table, use the PHP class generated before.

If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:

To make an insert, update or delete:

<source lang="php">
$db->begin(); // Start transaction
$db->query("My SQL request insert, update or delete");
$db->commit(); // Validate transaction
or $db->rollback() // Cancel transaction
</source>

To read:

<source lang="php">
$resql=$db->query("My select request");
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
</source>

=== Define style of your pages ===
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.

You can use for example:

* class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.
* class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.
* class="'''flat'''" on all input fields (''input, select, textarea''...).
* class="'''button'''" on HTML fields with type ''input type="submit"''.

=== Use the Dolibarr date picker ===
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:
<source lang="php">
$form=new Form($db);
$form->select_date('','mykey',0,0,0,"myform");
</source>
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).
This means a date selector must be included necessarily into an html FORM.

To get value after the POST of your form, the command is:
<source lang="php">
$mydate = dol_mktime(12, 0 , 0, $_POST['mykeymonth'], $_POST['mykeyday'], $_POST['mykeyyear']);
print strftime('%A %d %B %Y', $mydate);
</source>

== Add your own setup page (optional) ==
'''When''': If your module need to ask user several parameters.

=== Create your page to edit parameters ===
If your module need several parameters to be setup, you must create a page to edit options (that will be saved into [[Table llx_const|table '''llx_const''']]).
Create a page named '''mymodule_setuppage.php''' that show possibles options and update them into table from a form.
It is a necessary to take an example from a page into directory '''/admin''' that will show you the way to read/save your parameter.
Put this page into directory '''/admin'''.
Then, into the descriptor file of your module, modify the variable config_page_url to set name of this PHP page (without the path that is not necesary if page is inside directory admin).
<source lang="php">
$this->config_page_url = array("mymodule_setuppage.php");
</source>

=== Test your page ===
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.

== Define your entries in menu (optional) ==
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.

=== Define your menu entries ===
For this, you must define into the module descriptor, the array this->menu that declare all menus added by your module.
This array contains entries that will appear once your module is activated.
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.

This is the example of code to declare your own menu entries in a module descriptor file:
<source lang="php">
// Main menu entries
$this->menu = array(); // List of menus to add
$r=0;

// Add here entries to declare new menus
// Example to declare the Top Menu entry:
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
'type'=>'top', // This is a Top menu entry
'titre'=>'MyModule top menu',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule',
'url'=>'/mymodule/pagetop.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
$r++;

// Example to declare a Left Menu entry:
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu
'type'=>'left', // This is a Left menu entry
'titre'=>'MyModule left menu 1',
'mainmenu'=>'xxx',
'leftmenu'=>'yyy',
'url'=>'/mymodule/pagelevel1.php',
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>100,
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2); // 0=Menu for internal users,1=external users, 2=both
$r++;
</source>

To show menu or not depending on a permission, modify property '''perms''' in array. See chapter on permissions later to see how to add permissions.

=== Test your menu entries ===
Disable and reenable your module under Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).

== Add your own permissions (optional) ==
'''When''': If you want to add new permissions.

The way to define permissions that will manage your module is done inside the module descriptor created previously.
Modify line
<source lang="php">
$this->rights_class = 'mymodule'
</source>
with correct value for mymodule.

Then you must fill the array $this->rights with as many entries than different permissions you need to manage.

<source lang="php">
$this->rights[$r][0] = 10001;
$this->rights[$r][1] = 'Label by default of permission';
$this->rights[$r][3] = 1;
$this->rights[$r][4] = 'action';
$this->rights[$r][5] = 'subaction';
$r++;
</source>

Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any new created user.
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''').
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:

<source lang="php">
if ($user->rights->mymodule->action->subaction) ...
</source>

== Define you own box (optional) ==
'''When''': If your module need to provide one or several new boxes to show on home page.

=== Define your box ===
For this, modify the array $this->boxes into the module descriptor file.
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''

''Example:''
<source lang="php">
$this->boxes[0]['file']='mybox0.php@mymodule'
$this->boxes[0]['note']='My box 0'
...
$this->boxes[n]['file']='myboxn.php@mymodule'
$this->boxes[n]['note']='My box n'
</source>

Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').

=== Test if your box is detected by Dolibarr ===
Disable and enabled module.

Go into menu '''Home - Setup - Boxes'''.

Your boxes must appear in the list of boxes you can activated. Activate the box and go on home page to see if the box is showing correctly.

== Define your own export (optional) ==
'''When''': If your module provide new predefined database export profiles (for its own tables or for already existing tables of another module).

=== Define export ===
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.

=== Test your export ===
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).
Choose it, you must see list of all possible fields defined in the export arrays.
Choose on field and try to build an export file. If ok, try again with all fields.

== Define your CSS styles (optional) ==
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).

=== Create and declare your style sheet ===
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have only one CSS file per module.
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS file only if you need absolutely to add not already existing styles.

Once your style sheet is ready, declare it into your module descriptor file by modifying the property '''$this->modules_parts'''.
Value to put here must be a relative URL to your CSS file.
For example
<source lang="php">
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php'));
</source>

=== Test your style sheet ===
Disable and enable your module.

Go on home page (index.php). Show the HTML source of the page.

You should see into the HTML header, a line that declare your style sheet.

== Add your Javascript functions (optional) ==
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)

If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.

Example for page /htdocs/mymodule/mypage.php :
<source lang="php">
require('../main.inc.php');
$morejs=array("/mymodule/js/mymodule.js");
llxHeader('','Titre','','','','',$morejs,'',0,0);
</source>

== Run your own code on any Dolibarr event (optional) ==
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.

See also [[Interfaces_Dolibarr_toward_foreign_systems]]
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]

== Insert your code inside Dolibarr hooks positions (optional) ==
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See previous chapter for adding code during a business event).

See page [[Hooks_system]].

== Add your own numbering rules ==
'''When''': When you need a new rule for generated ref of elements that is not covered by existing rules.

See page [[Create numbering module]].

== Add your document template (optional) ==
'''When''': When you want to personalized your own generated PDF or ODT documents.

Note: To add this feature you don't need to create a module descriptor.

Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].

== Add your skin (optional) ==
'''When''': When you want to personalized your colors/fonts/images.

Note: To add this feature you don't need to create a module descriptor.

To add your own skin, read page [[Skins]].

=Some coding rules and predefined functions =
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".

A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".

=Using MDA =
A method to generate a functional module from a UML model has been developed. More information on the page [[UML2Dolibarr - Build a module using MDA]].

=Create a package to distribute and install your module =
This process must be used to generate a package to submit it on the http://www.dolistore.com market place.
But you can use it to have a package easy to distribute on your on network.

* Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).

Edit this file to add list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)

* Run the script via Perl (need the Perl version 5.0 or later):
<source lang="bash">
perl makepack-dolibarrmodule.pl
</source>
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.

* The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:
<source lang="bash">
tar -xvf mymodule.zip
</source>

* If you want your module to be public, you can submit it (the zip file) on Dolibarr market place web site: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").
** If your module was build correctly, file will be validated later.
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).

= Enabling/activation condition of external module on DoliStore =

See [[Module_Dolistore_Validation_Rules|Validation Rules]]

Module Medical Center

2015-06-07T08:17:00Z

Aikhan: /* Menu Bilan consultations */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described a little later.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of staff soigant (doctor, nurse, midwife, physiotherapist, or secretary ...), and therefore u nutilisateur part of the firm brought in to consult or enter Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
{{ToTranslate}}
Les Correspondants sont les autres soignants ou médecins s'occupant ou s'étant occupé du Patient.
Choisir le menu "'''Correspondants'''" fait apparaitre un sous-menu gauche offrant les fonctions pour créer, ou ajouter un nouveau Correspondant.
* Pour créer un correspondant, il suffit de cliquer sur l'entrée "Nouveau correspondant" et de saisir les informations sur la fiche vierge puis Enregistrer.
* Lorsqu'on a choisi l'entrée du menu "Liste des correspondants", on voie la liste de tous les correspondants enregistrés. Si on clique sur le nom de l'un d'eux, sa fiche s'ouvre. Et il est possible de la modifier.
* Il est possible de rappeler la fiche d'un Correspondant rapidement en saisissant une partie de son nom dans la zone de recherche rapide sur le bandeau de gauche.

'''Temporary translation'''
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient et consultations (Patient records and consultations)===
Pour créer une fiche patient, cliquer sur le menu "'''Patient - Nouveau Patient'''". Une fois créée, une fiche Patient contient plusieurs onglets:
* Un onglet avec les informations générales (qui sont celles enregistrés lors de la création)
* Un onglet Agenda (si le module Agenda a été activé)
* Un onglet Catégories (si le module Catégorie a été activé)
* Un onglet Correspondants
* Un ognlet Antécedants/Traitements
* Un onglet Notes
* Un onglet Consultations
* Un onglet Bio
* Un onglet Exploration
* Un onglet Courriers/Fichiers

Exemple: Cliquer sur l'image pour l'agrandir

[[File:Dolimed screenshot patientcard.png|200px]]

Voici un description sur la manière d'utiliser chaque onglet.

'''translation'''
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

Example: Click on image to enlarge

[[File:Dolimed screenshot patientcard.png|200px]]

Here is a description of how to use each tab.

==== Onglet des informations générales (Tab general information)====
* Sur la fiche du Patient, il est possible de lui affecter un ou plusieurs utilisateurs (médecins particuliers du cabinet suivant le patient par exemple). Bien que tous soignant puisse voir la fiche du patient d'un autre, ceci est utile pour classifier les patients par soignant principal. Cela est utilisé aussi pour les statistiques.

'''translation'''
* On the Patient card, it is possible to assign one or more users (individual doctors cabinet following the patient for example). Although all caregivers can see the patient's chart of another, this is useful to classify patients by primary caregiver. It is also used for statistics.

==== Onglet Correspondans (tab for correspondents) ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.

(On this tab, you can associate all physicians treating the patient with or knowing their specialty.)

==== Onglet Agenda (tab agenda)====
Cet onglet n'est visible que si le [[Module Agenda]] a été activé.
Il offre une vue de type calendrier de certains évênements qui ont été enregistrés sur le patient (création de la fiche patient, rendez-vous, saisie d'une consultation).

'''translation'''
(This tab is only visible if the Calendar module has been activated.)
(It provides a calendar-type view of certain events that have been recorded on the patient (creation of the patient file, appointments, entering a consultation).)

==== Onglet Catégories (Tab for categories)====
Cet onglet n'est visible que si le [[Module Catégories]] a été activé.

Il permet de classer un patient dans une ou plusieurs catégories. A vous de décider les catégories que vous créez. Leur création se fair depuis le menu "Patient - Catégorie - Nouvelle catégorie".

'''transaltion'''
This tab is only visible if the [[Module Categories]] has been activated.
It classifies a patient in one or more categories. You decide which categories you create. Their creation is fair from the "Patient - Category - New Category" menu.

==== Onglet Antécédents/Traitements (Tab Background / Treatments) ====
To complete ...

==== Tab Notes ====
To complete

==== Onglet Documents (Tab Documents)====
* Cette page permet de joindre des pièces jointes (images de scanners, d'échographie, documents words, ...)
Mais elle permet aussi de générer des documents OpenOffice à partir d'un modèle. Le modèle courrier_consult.odt est fourni en example.
* Pour générer un document, il faut choisir le modèle, éventuellement la fiche Bio associée puis cliquer sur Générer.
Le modèle sera utilisé et toutes les balises variables seront remplacées par les infos du patient ou de la consultation.
* Pour faire son propre modèle de document, voir la page [[Créer un modèle de document ODT]].
Les balises suivantes sont disponibles en plus de celle standard de Dolibarr:
{{TagsOdtCabinetMed}}

'''translation'''
* This page allows you to attach attachments (image scanners, ultrasound, papers words ...)
But it also can generate OpenOffice documents from a model. The model is supplied in courrier_consult.odt example.
* To generate a document, choose the model, possibly associated Bio page and click Generate.
The model will be used and all variables tags will be replaced with the patient's information or consultation.
* To make your own document model, see the [[Create a template ODT]].
The following tags are available in addition to the standard Dolibarr:
{{TagsOdtCabinetMed}}

== Menu Bilan consultations ==
Choisir le menu Bilan consultations fait apparaitre un tableau affichant pour les 3 dernières années, les revenus avec le détail par mois.
En cliquant sur un mois, cela déroule le détail sur chaque jour du mois.
Il est aussi possible depuis cet écran d'exporter le détail dans un fichier Excel.

Copie d'écran exemple (cliquez sur l'image pour agrandir):

[[File:Dolimed screenshot report.png|200px]]

'''translation'''
Select Balance consultations brings up a table that displays the menu for the past 3 years, income per month with details.
Clicking on a month, this place details about each day of the month.
It is also possible from this screen to export the details in an Excel file.

Screenshot example (click on the image to enlarge):

[[File:Dolimed screenshot report.png|200px]]

= Développement =
{{TemplateModNLTechnoEn}}

Module Medical Center

2015-06-07T08:14:24Z

Aikhan: /* Fiches Patient et consultations (Patient records and consultations) */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described a little later.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of staff soigant (doctor, nurse, midwife, physiotherapist, or secretary ...), and therefore u nutilisateur part of the firm brought in to consult or enter Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
{{ToTranslate}}
Les Correspondants sont les autres soignants ou médecins s'occupant ou s'étant occupé du Patient.
Choisir le menu "'''Correspondants'''" fait apparaitre un sous-menu gauche offrant les fonctions pour créer, ou ajouter un nouveau Correspondant.
* Pour créer un correspondant, il suffit de cliquer sur l'entrée "Nouveau correspondant" et de saisir les informations sur la fiche vierge puis Enregistrer.
* Lorsqu'on a choisi l'entrée du menu "Liste des correspondants", on voie la liste de tous les correspondants enregistrés. Si on clique sur le nom de l'un d'eux, sa fiche s'ouvre. Et il est possible de la modifier.
* Il est possible de rappeler la fiche d'un Correspondant rapidement en saisissant une partie de son nom dans la zone de recherche rapide sur le bandeau de gauche.

'''Temporary translation'''
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient et consultations (Patient records and consultations)===
Pour créer une fiche patient, cliquer sur le menu "'''Patient - Nouveau Patient'''". Une fois créée, une fiche Patient contient plusieurs onglets:
* Un onglet avec les informations générales (qui sont celles enregistrés lors de la création)
* Un onglet Agenda (si le module Agenda a été activé)
* Un onglet Catégories (si le module Catégorie a été activé)
* Un onglet Correspondants
* Un ognlet Antécedants/Traitements
* Un onglet Notes
* Un onglet Consultations
* Un onglet Bio
* Un onglet Exploration
* Un onglet Courriers/Fichiers

Exemple: Cliquer sur l'image pour l'agrandir

[[File:Dolimed screenshot patientcard.png|200px]]

Voici un description sur la manière d'utiliser chaque onglet.

'''translation'''
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

Example: Click on image to enlarge

[[File:Dolimed screenshot patientcard.png|200px]]

Here is a description of how to use each tab.

==== Onglet des informations générales (Tab general information)====
* Sur la fiche du Patient, il est possible de lui affecter un ou plusieurs utilisateurs (médecins particuliers du cabinet suivant le patient par exemple). Bien que tous soignant puisse voir la fiche du patient d'un autre, ceci est utile pour classifier les patients par soignant principal. Cela est utilisé aussi pour les statistiques.

'''translation'''
* On the Patient card, it is possible to assign one or more users (individual doctors cabinet following the patient for example). Although all caregivers can see the patient's chart of another, this is useful to classify patients by primary caregiver. It is also used for statistics.

==== Onglet Correspondans (tab for correspondents) ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.

(On this tab, you can associate all physicians treating the patient with or knowing their specialty.)

==== Onglet Agenda (tab agenda)====
Cet onglet n'est visible que si le [[Module Agenda]] a été activé.
Il offre une vue de type calendrier de certains évênements qui ont été enregistrés sur le patient (création de la fiche patient, rendez-vous, saisie d'une consultation).

'''translation'''
(This tab is only visible if the Calendar module has been activated.)
(It provides a calendar-type view of certain events that have been recorded on the patient (creation of the patient file, appointments, entering a consultation).)

==== Onglet Catégories (Tab for categories)====
Cet onglet n'est visible que si le [[Module Catégories]] a été activé.

Il permet de classer un patient dans une ou plusieurs catégories. A vous de décider les catégories que vous créez. Leur création se fair depuis le menu "Patient - Catégorie - Nouvelle catégorie".

'''transaltion'''
This tab is only visible if the [[Module Categories]] has been activated.
It classifies a patient in one or more categories. You decide which categories you create. Their creation is fair from the "Patient - Category - New Category" menu.

==== Onglet Antécédents/Traitements (Tab Background / Treatments) ====
To complete ...

==== Tab Notes ====
To complete

==== Onglet Documents (Tab Documents)====
* Cette page permet de joindre des pièces jointes (images de scanners, d'échographie, documents words, ...)
Mais elle permet aussi de générer des documents OpenOffice à partir d'un modèle. Le modèle courrier_consult.odt est fourni en example.
* Pour générer un document, il faut choisir le modèle, éventuellement la fiche Bio associée puis cliquer sur Générer.
Le modèle sera utilisé et toutes les balises variables seront remplacées par les infos du patient ou de la consultation.
* Pour faire son propre modèle de document, voir la page [[Créer un modèle de document ODT]].
Les balises suivantes sont disponibles en plus de celle standard de Dolibarr:
{{TagsOdtCabinetMed}}

'''translation'''
* This page allows you to attach attachments (image scanners, ultrasound, papers words ...)
But it also can generate OpenOffice documents from a model. The model is supplied in courrier_consult.odt example.
* To generate a document, choose the model, possibly associated Bio page and click Generate.
The model will be used and all variables tags will be replaced with the patient's information or consultation.
* To make your own document model, see the [[Create a template ODT]].
The following tags are available in addition to the standard Dolibarr:
{{TagsOdtCabinetMed}}

== Menu Bilan consultations ==
Choisir le menu Bilan consultations fait apparaitre un tableau affichant pour les 3 dernières années, les revenus avec le détail par mois.
En cliquant sur un mois, cela déroule le détail sur chaque jour du mois.
Il est aussi possible depuis cet écran d'exporter le détail dans un fichier Excel.

Copie d'écran exemple (cliquez sur l'image pour agrandir):

[[File:Dolimed screenshot report.png|200px]]

= Développement =
{{TemplateModNLTechnoEn}}

Module Medical Center

2015-06-07T08:09:32Z

Aikhan: /* Onglet Documents */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described a little later.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of staff soigant (doctor, nurse, midwife, physiotherapist, or secretary ...), and therefore u nutilisateur part of the firm brought in to consult or enter Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
{{ToTranslate}}
Les Correspondants sont les autres soignants ou médecins s'occupant ou s'étant occupé du Patient.
Choisir le menu "'''Correspondants'''" fait apparaitre un sous-menu gauche offrant les fonctions pour créer, ou ajouter un nouveau Correspondant.
* Pour créer un correspondant, il suffit de cliquer sur l'entrée "Nouveau correspondant" et de saisir les informations sur la fiche vierge puis Enregistrer.
* Lorsqu'on a choisi l'entrée du menu "Liste des correspondants", on voie la liste de tous les correspondants enregistrés. Si on clique sur le nom de l'un d'eux, sa fiche s'ouvre. Et il est possible de la modifier.
* Il est possible de rappeler la fiche d'un Correspondant rapidement en saisissant une partie de son nom dans la zone de recherche rapide sur le bandeau de gauche.

'''Temporary translation'''
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient et consultations (Patient records and consultations)===
Pour créer une fiche patient, cliquer sur le menu "'''Patient - Nouveau Patient'''". Une fois créée, une fiche Patient contient plusieurs onglets:
* Un onglet avec les informations générales (qui sont celles enregistrés lors de la création)
* Un onglet Agenda (si le module Agenda a été activé)
* Un onglet Catégories (si le module Catégorie a été activé)
* Un onglet Correspondants
* Un ognlet Antécedants/Traitements
* Un onglet Notes
* Un onglet Consultations
* Un onglet Bio
* Un onglet Exploration
* Un onglet Courriers/Fichiers

Exemple: Cliquer sur l'image pour l'agrandir

[[File:Dolimed screenshot patientcard.png|200px]]

Voici un description sur la manière d'utiliser chaque onglet.

'''Temporary translation'''
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

==== Onglet des informations générales (Tab general information)====
* Sur la fiche du Patient, il est possible de lui affecter un ou plusieurs utilisateurs (médecins particuliers du cabinet suivant le patient par exemple). Bien que tous soignant puisse voir la fiche du patient d'un autre, ceci est utile pour classifier les patients par soignant principal. Cela est utilisé aussi pour les statistiques.

'''translation'''
* On the Patient card, it is possible to assign one or more users (individual doctors cabinet following the patient for example). Although all caregivers can see the patient's chart of another, this is useful to classify patients by primary caregiver. It is also used for statistics.

==== Onglet Correspondans (tab for correspondents) ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.

(On this tab, you can associate all physicians treating the patient with or knowing their specialty.)

==== Onglet Agenda (tab agenda)====
Cet onglet n'est visible que si le [[Module Agenda]] a été activé.
Il offre une vue de type calendrier de certains évênements qui ont été enregistrés sur le patient (création de la fiche patient, rendez-vous, saisie d'une consultation).

'''translation'''
(This tab is only visible if the Calendar module has been activated.)
(It provides a calendar-type view of certain events that have been recorded on the patient (creation of the patient file, appointments, entering a consultation).)

==== Onglet Catégories (Tab for categories)====
Cet onglet n'est visible que si le [[Module Catégories]] a été activé.

Il permet de classer un patient dans une ou plusieurs catégories. A vous de décider les catégories que vous créez. Leur création se fair depuis le menu "Patient - Catégorie - Nouvelle catégorie".

'''transaltion'''
This tab is only visible if the [[Module Categories]] has been activated.
It classifies a patient in one or more categories. You decide which categories you create. Their creation is fair from the "Patient - Category - New Category" menu.

==== Onglet Antécédents/Traitements (Tab Background / Treatments) ====
To complete ...

==== Tab Notes ====
To complete

==== Onglet Documents (Tab Documents)====
* Cette page permet de joindre des pièces jointes (images de scanners, d'échographie, documents words, ...)
Mais elle permet aussi de générer des documents OpenOffice à partir d'un modèle. Le modèle courrier_consult.odt est fourni en example.
* Pour générer un document, il faut choisir le modèle, éventuellement la fiche Bio associée puis cliquer sur Générer.
Le modèle sera utilisé et toutes les balises variables seront remplacées par les infos du patient ou de la consultation.
* Pour faire son propre modèle de document, voir la page [[Créer un modèle de document ODT]].
Les balises suivantes sont disponibles en plus de celle standard de Dolibarr:
{{TagsOdtCabinetMed}}

'''translation'''
* This page allows you to attach attachments (image scanners, ultrasound, papers words ...)
But it also can generate OpenOffice documents from a model. The model is supplied in courrier_consult.odt example.
* To generate a document, choose the model, possibly associated Bio page and click Generate.
The model will be used and all variables tags will be replaced with the patient's information or consultation.
* To make your own document model, see the [[Create a template ODT]].
The following tags are available in addition to the standard Dolibarr:
{{TagsOdtCabinetMed}}

== Menu Bilan consultations ==
Choisir le menu Bilan consultations fait apparaitre un tableau affichant pour les 3 dernières années, les revenus avec le détail par mois.
En cliquant sur un mois, cela déroule le détail sur chaque jour du mois.
Il est aussi possible depuis cet écran d'exporter le détail dans un fichier Excel.

Copie d'écran exemple (cliquez sur l'image pour agrandir):

[[File:Dolimed screenshot report.png|200px]]

= Développement =
{{TemplateModNLTechnoEn}}

Module Medical Center

2015-06-07T08:08:22Z

Aikhan: /* Onglet Documents */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described a little later.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of staff soigant (doctor, nurse, midwife, physiotherapist, or secretary ...), and therefore u nutilisateur part of the firm brought in to consult or enter Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
{{ToTranslate}}
Les Correspondants sont les autres soignants ou médecins s'occupant ou s'étant occupé du Patient.
Choisir le menu "'''Correspondants'''" fait apparaitre un sous-menu gauche offrant les fonctions pour créer, ou ajouter un nouveau Correspondant.
* Pour créer un correspondant, il suffit de cliquer sur l'entrée "Nouveau correspondant" et de saisir les informations sur la fiche vierge puis Enregistrer.
* Lorsqu'on a choisi l'entrée du menu "Liste des correspondants", on voie la liste de tous les correspondants enregistrés. Si on clique sur le nom de l'un d'eux, sa fiche s'ouvre. Et il est possible de la modifier.
* Il est possible de rappeler la fiche d'un Correspondant rapidement en saisissant une partie de son nom dans la zone de recherche rapide sur le bandeau de gauche.

'''Temporary translation'''
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient et consultations (Patient records and consultations)===
Pour créer une fiche patient, cliquer sur le menu "'''Patient - Nouveau Patient'''". Une fois créée, une fiche Patient contient plusieurs onglets:
* Un onglet avec les informations générales (qui sont celles enregistrés lors de la création)
* Un onglet Agenda (si le module Agenda a été activé)
* Un onglet Catégories (si le module Catégorie a été activé)
* Un onglet Correspondants
* Un ognlet Antécedants/Traitements
* Un onglet Notes
* Un onglet Consultations
* Un onglet Bio
* Un onglet Exploration
* Un onglet Courriers/Fichiers

Exemple: Cliquer sur l'image pour l'agrandir

[[File:Dolimed screenshot patientcard.png|200px]]

Voici un description sur la manière d'utiliser chaque onglet.

'''Temporary translation'''
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

==== Onglet des informations générales (Tab general information)====
* Sur la fiche du Patient, il est possible de lui affecter un ou plusieurs utilisateurs (médecins particuliers du cabinet suivant le patient par exemple). Bien que tous soignant puisse voir la fiche du patient d'un autre, ceci est utile pour classifier les patients par soignant principal. Cela est utilisé aussi pour les statistiques.

'''translation'''
* On the Patient card, it is possible to assign one or more users (individual doctors cabinet following the patient for example). Although all caregivers can see the patient's chart of another, this is useful to classify patients by primary caregiver. It is also used for statistics.

==== Onglet Correspondans (tab for correspondents) ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.

(On this tab, you can associate all physicians treating the patient with or knowing their specialty.)

==== Onglet Agenda (tab agenda)====
Cet onglet n'est visible que si le [[Module Agenda]] a été activé.
Il offre une vue de type calendrier de certains évênements qui ont été enregistrés sur le patient (création de la fiche patient, rendez-vous, saisie d'une consultation).

'''translation'''
(This tab is only visible if the Calendar module has been activated.)
(It provides a calendar-type view of certain events that have been recorded on the patient (creation of the patient file, appointments, entering a consultation).)

==== Onglet Catégories (Tab for categories)====
Cet onglet n'est visible que si le [[Module Catégories]] a été activé.

Il permet de classer un patient dans une ou plusieurs catégories. A vous de décider les catégories que vous créez. Leur création se fair depuis le menu "Patient - Catégorie - Nouvelle catégorie".

'''transaltion'''
This tab is only visible if the [[Module Categories]] has been activated.
It classifies a patient in one or more categories. You decide which categories you create. Their creation is fair from the "Patient - Category - New Category" menu.

==== Onglet Antécédents/Traitements (Tab Background / Treatments) ====
To complete ...

==== Tab Notes ====
To complete

==== Onglet Documents ====
* Cette page permet de joindre des pièces jointes (images de scanners, d'échographie, documents words, ...)
Mais elle permet aussi de générer des documents OpenOffice à partir d'un modèle. Le modèle courrier_consult.odt est fourni en example.
* Pour générer un document, il faut choisir le modèle, éventuellement la fiche Bio associée puis cliquer sur Générer.
Le modèle sera utilisé et toutes les balises variables seront remplacées par les infos du patient ou de la consultation.
* Pour faire son propre modèle de document, voir la page [[Créer un modèle de document ODT]].
Les balises suivantes sont disponibles en plus de celle standard de Dolibarr:
{{TagsOdtCabinetMed}}

'''translation'''
* This page allows you to attach attachments (image scanners, ultrasound, papers words ...)
But it also can generate OpenOffice documents from a model. The model is supplied in courrier_consult.odt example.
* To generate a document, choose the model, possibly associated Bio page and click Generate.
The model will be used and all variables tags will be replaced with the patient's information or consultation.
* To make your own document model, see the [[Create a template ODT]].
The following tags are available in addition to the standard Dolibarr:
{{TagsOdtCabinetMed}}

== Menu Bilan consultations ==
Choisir le menu Bilan consultations fait apparaitre un tableau affichant pour les 3 dernières années, les revenus avec le détail par mois.
En cliquant sur un mois, cela déroule le détail sur chaque jour du mois.
Il est aussi possible depuis cet écran d'exporter le détail dans un fichier Excel.

Copie d'écran exemple (cliquez sur l'image pour agrandir):

[[File:Dolimed screenshot report.png|200px]]

= Développement =
{{TemplateModNLTechnoEn}}

Module Medical Center

2015-06-07T08:03:17Z

Aikhan: /* Onglet Notes */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described a little later.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of staff soigant (doctor, nurse, midwife, physiotherapist, or secretary ...), and therefore u nutilisateur part of the firm brought in to consult or enter Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
{{ToTranslate}}
Les Correspondants sont les autres soignants ou médecins s'occupant ou s'étant occupé du Patient.
Choisir le menu "'''Correspondants'''" fait apparaitre un sous-menu gauche offrant les fonctions pour créer, ou ajouter un nouveau Correspondant.
* Pour créer un correspondant, il suffit de cliquer sur l'entrée "Nouveau correspondant" et de saisir les informations sur la fiche vierge puis Enregistrer.
* Lorsqu'on a choisi l'entrée du menu "Liste des correspondants", on voie la liste de tous les correspondants enregistrés. Si on clique sur le nom de l'un d'eux, sa fiche s'ouvre. Et il est possible de la modifier.
* Il est possible de rappeler la fiche d'un Correspondant rapidement en saisissant une partie de son nom dans la zone de recherche rapide sur le bandeau de gauche.

'''Temporary translation'''
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient et consultations (Patient records and consultations)===
Pour créer une fiche patient, cliquer sur le menu "'''Patient - Nouveau Patient'''". Une fois créée, une fiche Patient contient plusieurs onglets:
* Un onglet avec les informations générales (qui sont celles enregistrés lors de la création)
* Un onglet Agenda (si le module Agenda a été activé)
* Un onglet Catégories (si le module Catégorie a été activé)
* Un onglet Correspondants
* Un ognlet Antécedants/Traitements
* Un onglet Notes
* Un onglet Consultations
* Un onglet Bio
* Un onglet Exploration
* Un onglet Courriers/Fichiers

Exemple: Cliquer sur l'image pour l'agrandir

[[File:Dolimed screenshot patientcard.png|200px]]

Voici un description sur la manière d'utiliser chaque onglet.

'''Temporary translation'''
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

==== Onglet des informations générales (Tab general information)====
* Sur la fiche du Patient, il est possible de lui affecter un ou plusieurs utilisateurs (médecins particuliers du cabinet suivant le patient par exemple). Bien que tous soignant puisse voir la fiche du patient d'un autre, ceci est utile pour classifier les patients par soignant principal. Cela est utilisé aussi pour les statistiques.

'''translation'''
* On the Patient card, it is possible to assign one or more users (individual doctors cabinet following the patient for example). Although all caregivers can see the patient's chart of another, this is useful to classify patients by primary caregiver. It is also used for statistics.

==== Onglet Correspondans (tab for correspondents) ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.

(On this tab, you can associate all physicians treating the patient with or knowing their specialty.)

==== Onglet Agenda (tab agenda)====
Cet onglet n'est visible que si le [[Module Agenda]] a été activé.
Il offre une vue de type calendrier de certains évênements qui ont été enregistrés sur le patient (création de la fiche patient, rendez-vous, saisie d'une consultation).

'''translation'''
(This tab is only visible if the Calendar module has been activated.)
(It provides a calendar-type view of certain events that have been recorded on the patient (creation of the patient file, appointments, entering a consultation).)

==== Onglet Catégories (Tab for categories)====
Cet onglet n'est visible que si le [[Module Catégories]] a été activé.

Il permet de classer un patient dans une ou plusieurs catégories. A vous de décider les catégories que vous créez. Leur création se fair depuis le menu "Patient - Catégorie - Nouvelle catégorie".

'''transaltion'''
This tab is only visible if the [[Module Categories]] has been activated.
It classifies a patient in one or more categories. You decide which categories you create. Their creation is fair from the "Patient - Category - New Category" menu.

==== Onglet Antécédents/Traitements (Tab Background / Treatments) ====
To complete ...

==== Tab Notes ====
To complete

==== Onglet Documents ====
* Cette page permet de joindre des pièces jointes (images de scanners, d'échographie, documents words, ...)
Mais elle permet aussi de générer des documents OpenOffice à partir d'un modèle. Le modèle courrier_consult.odt est fourni en example.
* Pour générer un document, il faut choisir le modèle, éventuellement la fiche Bio associée puis cliquer sur Générer.
Le modèle sera utilisé et toutes les balises variables seront remplacées par les infos du patient ou de la consultation.
* Pour faire son propre modèle de document, voir la page [[Créer un modèle de document ODT]].
Les balises suivantes sont disponibles en plus de celle standard de Dolibarr:
{{TagsOdtCabinetMed}}

== Menu Bilan consultations ==
Choisir le menu Bilan consultations fait apparaitre un tableau affichant pour les 3 dernières années, les revenus avec le détail par mois.
En cliquant sur un mois, cela déroule le détail sur chaque jour du mois.
Il est aussi possible depuis cet écran d'exporter le détail dans un fichier Excel.

Copie d'écran exemple (cliquez sur l'image pour agrandir):

[[File:Dolimed screenshot report.png|200px]]

= Développement =
{{TemplateModNLTechnoEn}}

Module Medical Center

2015-06-07T08:02:42Z

Aikhan: /* Onglet Antécédents/Traitements */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described a little later.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of staff soigant (doctor, nurse, midwife, physiotherapist, or secretary ...), and therefore u nutilisateur part of the firm brought in to consult or enter Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
{{ToTranslate}}
Les Correspondants sont les autres soignants ou médecins s'occupant ou s'étant occupé du Patient.
Choisir le menu "'''Correspondants'''" fait apparaitre un sous-menu gauche offrant les fonctions pour créer, ou ajouter un nouveau Correspondant.
* Pour créer un correspondant, il suffit de cliquer sur l'entrée "Nouveau correspondant" et de saisir les informations sur la fiche vierge puis Enregistrer.
* Lorsqu'on a choisi l'entrée du menu "Liste des correspondants", on voie la liste de tous les correspondants enregistrés. Si on clique sur le nom de l'un d'eux, sa fiche s'ouvre. Et il est possible de la modifier.
* Il est possible de rappeler la fiche d'un Correspondant rapidement en saisissant une partie de son nom dans la zone de recherche rapide sur le bandeau de gauche.

'''Temporary translation'''
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient et consultations (Patient records and consultations)===
Pour créer une fiche patient, cliquer sur le menu "'''Patient - Nouveau Patient'''". Une fois créée, une fiche Patient contient plusieurs onglets:
* Un onglet avec les informations générales (qui sont celles enregistrés lors de la création)
* Un onglet Agenda (si le module Agenda a été activé)
* Un onglet Catégories (si le module Catégorie a été activé)
* Un onglet Correspondants
* Un ognlet Antécedants/Traitements
* Un onglet Notes
* Un onglet Consultations
* Un onglet Bio
* Un onglet Exploration
* Un onglet Courriers/Fichiers

Exemple: Cliquer sur l'image pour l'agrandir

[[File:Dolimed screenshot patientcard.png|200px]]

Voici un description sur la manière d'utiliser chaque onglet.

'''Temporary translation'''
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

==== Onglet des informations générales (Tab general information)====
* Sur la fiche du Patient, il est possible de lui affecter un ou plusieurs utilisateurs (médecins particuliers du cabinet suivant le patient par exemple). Bien que tous soignant puisse voir la fiche du patient d'un autre, ceci est utile pour classifier les patients par soignant principal. Cela est utilisé aussi pour les statistiques.

'''translation'''
* On the Patient card, it is possible to assign one or more users (individual doctors cabinet following the patient for example). Although all caregivers can see the patient's chart of another, this is useful to classify patients by primary caregiver. It is also used for statistics.

==== Onglet Correspondans (tab for correspondents) ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.

(On this tab, you can associate all physicians treating the patient with or knowing their specialty.)

==== Onglet Agenda (tab agenda)====
Cet onglet n'est visible que si le [[Module Agenda]] a été activé.
Il offre une vue de type calendrier de certains évênements qui ont été enregistrés sur le patient (création de la fiche patient, rendez-vous, saisie d'une consultation).

'''translation'''
(This tab is only visible if the Calendar module has been activated.)
(It provides a calendar-type view of certain events that have been recorded on the patient (creation of the patient file, appointments, entering a consultation).)

==== Onglet Catégories (Tab for categories)====
Cet onglet n'est visible que si le [[Module Catégories]] a été activé.

Il permet de classer un patient dans une ou plusieurs catégories. A vous de décider les catégories que vous créez. Leur création se fair depuis le menu "Patient - Catégorie - Nouvelle catégorie".

'''transaltion'''
This tab is only visible if the [[Module Categories]] has been activated.
It classifies a patient in one or more categories. You decide which categories you create. Their creation is fair from the "Patient - Category - New Category" menu.

==== Onglet Antécédents/Traitements (Tab Background / Treatments) ====
To complete ...

==== Onglet Notes ====
A compléter

==== Onglet Documents ====
* Cette page permet de joindre des pièces jointes (images de scanners, d'échographie, documents words, ...)
Mais elle permet aussi de générer des documents OpenOffice à partir d'un modèle. Le modèle courrier_consult.odt est fourni en example.
* Pour générer un document, il faut choisir le modèle, éventuellement la fiche Bio associée puis cliquer sur Générer.
Le modèle sera utilisé et toutes les balises variables seront remplacées par les infos du patient ou de la consultation.
* Pour faire son propre modèle de document, voir la page [[Créer un modèle de document ODT]].
Les balises suivantes sont disponibles en plus de celle standard de Dolibarr:
{{TagsOdtCabinetMed}}

== Menu Bilan consultations ==
Choisir le menu Bilan consultations fait apparaitre un tableau affichant pour les 3 dernières années, les revenus avec le détail par mois.
En cliquant sur un mois, cela déroule le détail sur chaque jour du mois.
Il est aussi possible depuis cet écran d'exporter le détail dans un fichier Excel.

Copie d'écran exemple (cliquez sur l'image pour agrandir):

[[File:Dolimed screenshot report.png|200px]]

= Développement =
{{TemplateModNLTechnoEn}}

Module Medical Center

2015-06-07T08:01:03Z

Aikhan: /* Onglet des informations générales (Tab general information) */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described a little later.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of staff soigant (doctor, nurse, midwife, physiotherapist, or secretary ...), and therefore u nutilisateur part of the firm brought in to consult or enter Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
{{ToTranslate}}
Les Correspondants sont les autres soignants ou médecins s'occupant ou s'étant occupé du Patient.
Choisir le menu "'''Correspondants'''" fait apparaitre un sous-menu gauche offrant les fonctions pour créer, ou ajouter un nouveau Correspondant.
* Pour créer un correspondant, il suffit de cliquer sur l'entrée "Nouveau correspondant" et de saisir les informations sur la fiche vierge puis Enregistrer.
* Lorsqu'on a choisi l'entrée du menu "Liste des correspondants", on voie la liste de tous les correspondants enregistrés. Si on clique sur le nom de l'un d'eux, sa fiche s'ouvre. Et il est possible de la modifier.
* Il est possible de rappeler la fiche d'un Correspondant rapidement en saisissant une partie de son nom dans la zone de recherche rapide sur le bandeau de gauche.

'''Temporary translation'''
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient et consultations (Patient records and consultations)===
Pour créer une fiche patient, cliquer sur le menu "'''Patient - Nouveau Patient'''". Une fois créée, une fiche Patient contient plusieurs onglets:
* Un onglet avec les informations générales (qui sont celles enregistrés lors de la création)
* Un onglet Agenda (si le module Agenda a été activé)
* Un onglet Catégories (si le module Catégorie a été activé)
* Un onglet Correspondants
* Un ognlet Antécedants/Traitements
* Un onglet Notes
* Un onglet Consultations
* Un onglet Bio
* Un onglet Exploration
* Un onglet Courriers/Fichiers

Exemple: Cliquer sur l'image pour l'agrandir

[[File:Dolimed screenshot patientcard.png|200px]]

Voici un description sur la manière d'utiliser chaque onglet.

'''Temporary translation'''
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

==== Onglet des informations générales (Tab general information)====
* Sur la fiche du Patient, il est possible de lui affecter un ou plusieurs utilisateurs (médecins particuliers du cabinet suivant le patient par exemple). Bien que tous soignant puisse voir la fiche du patient d'un autre, ceci est utile pour classifier les patients par soignant principal. Cela est utilisé aussi pour les statistiques.

'''translation'''
* On the Patient card, it is possible to assign one or more users (individual doctors cabinet following the patient for example). Although all caregivers can see the patient's chart of another, this is useful to classify patients by primary caregiver. It is also used for statistics.

==== Onglet Correspondans (tab for correspondents) ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.

(On this tab, you can associate all physicians treating the patient with or knowing their specialty.)

==== Onglet Agenda (tab agenda)====
Cet onglet n'est visible que si le [[Module Agenda]] a été activé.
Il offre une vue de type calendrier de certains évênements qui ont été enregistrés sur le patient (création de la fiche patient, rendez-vous, saisie d'une consultation).

'''translation'''
(This tab is only visible if the Calendar module has been activated.)
(It provides a calendar-type view of certain events that have been recorded on the patient (creation of the patient file, appointments, entering a consultation).)

==== Onglet Catégories (Tab for categories)====
Cet onglet n'est visible que si le [[Module Catégories]] a été activé.

Il permet de classer un patient dans une ou plusieurs catégories. A vous de décider les catégories que vous créez. Leur création se fair depuis le menu "Patient - Catégorie - Nouvelle catégorie".

'''transaltion'''
This tab is only visible if the [[Module Categories]] has been activated.
It classifies a patient in one or more categories. You decide which categories you create. Their creation is fair from the "Patient - Category - New Category" menu.

==== Onglet Antécédents/Traitements ====
A compléter

==== Onglet Notes ====
A compléter

==== Onglet Documents ====
* Cette page permet de joindre des pièces jointes (images de scanners, d'échographie, documents words, ...)
Mais elle permet aussi de générer des documents OpenOffice à partir d'un modèle. Le modèle courrier_consult.odt est fourni en example.
* Pour générer un document, il faut choisir le modèle, éventuellement la fiche Bio associée puis cliquer sur Générer.
Le modèle sera utilisé et toutes les balises variables seront remplacées par les infos du patient ou de la consultation.
* Pour faire son propre modèle de document, voir la page [[Créer un modèle de document ODT]].
Les balises suivantes sont disponibles en plus de celle standard de Dolibarr:
{{TagsOdtCabinetMed}}

== Menu Bilan consultations ==
Choisir le menu Bilan consultations fait apparaitre un tableau affichant pour les 3 dernières années, les revenus avec le détail par mois.
En cliquant sur un mois, cela déroule le détail sur chaque jour du mois.
Il est aussi possible depuis cet écran d'exporter le détail dans un fichier Excel.

Copie d'écran exemple (cliquez sur l'image pour agrandir):

[[File:Dolimed screenshot report.png|200px]]

= Développement =
{{TemplateModNLTechnoEn}}

Module Medical Center

2015-06-07T07:59:59Z

Aikhan: /* Onglet Agenda */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described a little later.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of staff soigant (doctor, nurse, midwife, physiotherapist, or secretary ...), and therefore u nutilisateur part of the firm brought in to consult or enter Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
{{ToTranslate}}
Les Correspondants sont les autres soignants ou médecins s'occupant ou s'étant occupé du Patient.
Choisir le menu "'''Correspondants'''" fait apparaitre un sous-menu gauche offrant les fonctions pour créer, ou ajouter un nouveau Correspondant.
* Pour créer un correspondant, il suffit de cliquer sur l'entrée "Nouveau correspondant" et de saisir les informations sur la fiche vierge puis Enregistrer.
* Lorsqu'on a choisi l'entrée du menu "Liste des correspondants", on voie la liste de tous les correspondants enregistrés. Si on clique sur le nom de l'un d'eux, sa fiche s'ouvre. Et il est possible de la modifier.
* Il est possible de rappeler la fiche d'un Correspondant rapidement en saisissant une partie de son nom dans la zone de recherche rapide sur le bandeau de gauche.

'''Temporary translation'''
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient et consultations (Patient records and consultations)===
Pour créer une fiche patient, cliquer sur le menu "'''Patient - Nouveau Patient'''". Une fois créée, une fiche Patient contient plusieurs onglets:
* Un onglet avec les informations générales (qui sont celles enregistrés lors de la création)
* Un onglet Agenda (si le module Agenda a été activé)
* Un onglet Catégories (si le module Catégorie a été activé)
* Un onglet Correspondants
* Un ognlet Antécedants/Traitements
* Un onglet Notes
* Un onglet Consultations
* Un onglet Bio
* Un onglet Exploration
* Un onglet Courriers/Fichiers

Exemple: Cliquer sur l'image pour l'agrandir

[[File:Dolimed screenshot patientcard.png|200px]]

Voici un description sur la manière d'utiliser chaque onglet.

'''Temporary translation'''
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

==== Onglet des informations générales (Tab general information)====
* Sur la fiche du Patient, il est possible de lui affecter un ou plusieurs utilisateurs (médecins particuliers du cabinet suivant le patient par exemple). Bien que tous soignant puisse voir la fiche du patient d'un autre, ceci est utile pour classifier les patients par soignant principal. Cela est utilisé aussi pour les statistiques.

'''Temporary translation'''
* On the Patient card, it is possible to assign one or more users (individual doctors cabinet following the patient for example). Although all caregivers can see the patient's chart of another, this is useful to classify patients by primary caregiver. It is also used for statistics.

==== Onglet Correspondans (tab for correspondents) ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.

(On this tab, you can associate all physicians treating the patient with or knowing their specialty.)

==== Onglet Agenda (tab agenda)====
Cet onglet n'est visible que si le [[Module Agenda]] a été activé.
Il offre une vue de type calendrier de certains évênements qui ont été enregistrés sur le patient (création de la fiche patient, rendez-vous, saisie d'une consultation).

'''translation'''
(This tab is only visible if the Calendar module has been activated.)
(It provides a calendar-type view of certain events that have been recorded on the patient (creation of the patient file, appointments, entering a consultation).)

==== Onglet Catégories (Tab for categories)====
Cet onglet n'est visible que si le [[Module Catégories]] a été activé.

Il permet de classer un patient dans une ou plusieurs catégories. A vous de décider les catégories que vous créez. Leur création se fair depuis le menu "Patient - Catégorie - Nouvelle catégorie".

'''transaltion'''
This tab is only visible if the [[Module Categories]] has been activated.
It classifies a patient in one or more categories. You decide which categories you create. Their creation is fair from the "Patient - Category - New Category" menu.

==== Onglet Antécédents/Traitements ====
A compléter

==== Onglet Notes ====
A compléter

==== Onglet Documents ====
* Cette page permet de joindre des pièces jointes (images de scanners, d'échographie, documents words, ...)
Mais elle permet aussi de générer des documents OpenOffice à partir d'un modèle. Le modèle courrier_consult.odt est fourni en example.
* Pour générer un document, il faut choisir le modèle, éventuellement la fiche Bio associée puis cliquer sur Générer.
Le modèle sera utilisé et toutes les balises variables seront remplacées par les infos du patient ou de la consultation.
* Pour faire son propre modèle de document, voir la page [[Créer un modèle de document ODT]].
Les balises suivantes sont disponibles en plus de celle standard de Dolibarr:
{{TagsOdtCabinetMed}}

== Menu Bilan consultations ==
Choisir le menu Bilan consultations fait apparaitre un tableau affichant pour les 3 dernières années, les revenus avec le détail par mois.
En cliquant sur un mois, cela déroule le détail sur chaque jour du mois.
Il est aussi possible depuis cet écran d'exporter le détail dans un fichier Excel.

Copie d'écran exemple (cliquez sur l'image pour agrandir):

[[File:Dolimed screenshot report.png|200px]]

= Développement =
{{TemplateModNLTechnoEn}}

Module Medical Center

2015-06-07T07:58:15Z

Aikhan: /* Onglet Catégories */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described a little later.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of staff soigant (doctor, nurse, midwife, physiotherapist, or secretary ...), and therefore u nutilisateur part of the firm brought in to consult or enter Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
{{ToTranslate}}
Les Correspondants sont les autres soignants ou médecins s'occupant ou s'étant occupé du Patient.
Choisir le menu "'''Correspondants'''" fait apparaitre un sous-menu gauche offrant les fonctions pour créer, ou ajouter un nouveau Correspondant.
* Pour créer un correspondant, il suffit de cliquer sur l'entrée "Nouveau correspondant" et de saisir les informations sur la fiche vierge puis Enregistrer.
* Lorsqu'on a choisi l'entrée du menu "Liste des correspondants", on voie la liste de tous les correspondants enregistrés. Si on clique sur le nom de l'un d'eux, sa fiche s'ouvre. Et il est possible de la modifier.
* Il est possible de rappeler la fiche d'un Correspondant rapidement en saisissant une partie de son nom dans la zone de recherche rapide sur le bandeau de gauche.

'''Temporary translation'''
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient et consultations (Patient records and consultations)===
Pour créer une fiche patient, cliquer sur le menu "'''Patient - Nouveau Patient'''". Une fois créée, une fiche Patient contient plusieurs onglets:
* Un onglet avec les informations générales (qui sont celles enregistrés lors de la création)
* Un onglet Agenda (si le module Agenda a été activé)
* Un onglet Catégories (si le module Catégorie a été activé)
* Un onglet Correspondants
* Un ognlet Antécedants/Traitements
* Un onglet Notes
* Un onglet Consultations
* Un onglet Bio
* Un onglet Exploration
* Un onglet Courriers/Fichiers

Exemple: Cliquer sur l'image pour l'agrandir

[[File:Dolimed screenshot patientcard.png|200px]]

Voici un description sur la manière d'utiliser chaque onglet.

'''Temporary translation'''
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

==== Onglet des informations générales (Tab general information)====
* Sur la fiche du Patient, il est possible de lui affecter un ou plusieurs utilisateurs (médecins particuliers du cabinet suivant le patient par exemple). Bien que tous soignant puisse voir la fiche du patient d'un autre, ceci est utile pour classifier les patients par soignant principal. Cela est utilisé aussi pour les statistiques.

'''Temporary translation'''
* On the Patient card, it is possible to assign one or more users (individual doctors cabinet following the patient for example). Although all caregivers can see the patient's chart of another, this is useful to classify patients by primary caregiver. It is also used for statistics.

==== Onglet Correspondans (tab for correspondents) ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.

(On this tab, you can associate all physicians treating the patient with or knowing their specialty.)

==== Onglet Agenda ====
Cet onglet n'est visible que si le [[Module Agenda]] a été activé.
(This tab is only visible if the Calendar module has been activated.)

Il offre une vue de type calendrier de certains évênements qui ont été enregistrés sur le patient (création de la fiche patient, rendez-vous, saisie d'une consultation).
(It provides a calendar-type view of certain events that have been recorded on the patient (creation of the patient file, appointments, entering a consultation).)

==== Onglet Catégories (Tab for categories)====
Cet onglet n'est visible que si le [[Module Catégories]] a été activé.

Il permet de classer un patient dans une ou plusieurs catégories. A vous de décider les catégories que vous créez. Leur création se fair depuis le menu "Patient - Catégorie - Nouvelle catégorie".

'''transaltion'''
This tab is only visible if the [[Module Categories]] has been activated.
It classifies a patient in one or more categories. You decide which categories you create. Their creation is fair from the "Patient - Category - New Category" menu.

==== Onglet Antécédents/Traitements ====
A compléter

==== Onglet Notes ====
A compléter

==== Onglet Documents ====
* Cette page permet de joindre des pièces jointes (images de scanners, d'échographie, documents words, ...)
Mais elle permet aussi de générer des documents OpenOffice à partir d'un modèle. Le modèle courrier_consult.odt est fourni en example.
* Pour générer un document, il faut choisir le modèle, éventuellement la fiche Bio associée puis cliquer sur Générer.
Le modèle sera utilisé et toutes les balises variables seront remplacées par les infos du patient ou de la consultation.
* Pour faire son propre modèle de document, voir la page [[Créer un modèle de document ODT]].
Les balises suivantes sont disponibles en plus de celle standard de Dolibarr:
{{TagsOdtCabinetMed}}

== Menu Bilan consultations ==
Choisir le menu Bilan consultations fait apparaitre un tableau affichant pour les 3 dernières années, les revenus avec le détail par mois.
En cliquant sur un mois, cela déroule le détail sur chaque jour du mois.
Il est aussi possible depuis cet écran d'exporter le détail dans un fichier Excel.

Copie d'écran exemple (cliquez sur l'image pour agrandir):

[[File:Dolimed screenshot report.png|200px]]

= Développement =
{{TemplateModNLTechnoEn}}

Module Medical Center

2015-06-07T07:56:07Z

Aikhan: /* Onglet Correspondans (tab for correspondents) */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described a little later.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of staff soigant (doctor, nurse, midwife, physiotherapist, or secretary ...), and therefore u nutilisateur part of the firm brought in to consult or enter Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
{{ToTranslate}}
Les Correspondants sont les autres soignants ou médecins s'occupant ou s'étant occupé du Patient.
Choisir le menu "'''Correspondants'''" fait apparaitre un sous-menu gauche offrant les fonctions pour créer, ou ajouter un nouveau Correspondant.
* Pour créer un correspondant, il suffit de cliquer sur l'entrée "Nouveau correspondant" et de saisir les informations sur la fiche vierge puis Enregistrer.
* Lorsqu'on a choisi l'entrée du menu "Liste des correspondants", on voie la liste de tous les correspondants enregistrés. Si on clique sur le nom de l'un d'eux, sa fiche s'ouvre. Et il est possible de la modifier.
* Il est possible de rappeler la fiche d'un Correspondant rapidement en saisissant une partie de son nom dans la zone de recherche rapide sur le bandeau de gauche.

'''Temporary translation'''
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient et consultations (Patient records and consultations)===
Pour créer une fiche patient, cliquer sur le menu "'''Patient - Nouveau Patient'''". Une fois créée, une fiche Patient contient plusieurs onglets:
* Un onglet avec les informations générales (qui sont celles enregistrés lors de la création)
* Un onglet Agenda (si le module Agenda a été activé)
* Un onglet Catégories (si le module Catégorie a été activé)
* Un onglet Correspondants
* Un ognlet Antécedants/Traitements
* Un onglet Notes
* Un onglet Consultations
* Un onglet Bio
* Un onglet Exploration
* Un onglet Courriers/Fichiers

Exemple: Cliquer sur l'image pour l'agrandir

[[File:Dolimed screenshot patientcard.png|200px]]

Voici un description sur la manière d'utiliser chaque onglet.

'''Temporary translation'''
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

==== Onglet des informations générales (Tab general information)====
* Sur la fiche du Patient, il est possible de lui affecter un ou plusieurs utilisateurs (médecins particuliers du cabinet suivant le patient par exemple). Bien que tous soignant puisse voir la fiche du patient d'un autre, ceci est utile pour classifier les patients par soignant principal. Cela est utilisé aussi pour les statistiques.

'''Temporary translation'''
* On the Patient card, it is possible to assign one or more users (individual doctors cabinet following the patient for example). Although all caregivers can see the patient's chart of another, this is useful to classify patients by primary caregiver. It is also used for statistics.

==== Onglet Correspondans (tab for correspondents) ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.

(On this tab, you can associate all physicians treating the patient with or knowing their specialty.)

==== Onglet Agenda ====
Cet onglet n'est visible que si le [[Module Agenda]] a été activé.
(This tab is only visible if the Calendar module has been activated.)

Il offre une vue de type calendrier de certains évênements qui ont été enregistrés sur le patient (création de la fiche patient, rendez-vous, saisie d'une consultation).
(It provides a calendar-type view of certain events that have been recorded on the patient (creation of the patient file, appointments, entering a consultation).)

==== Onglet Catégories ====
Cet onglet n'est visible que si le [[Module Catégories]] a été activé.

Il permet de classer un patient dans une ou plusieurs catégories. A vous de décider les catégories que vous créez. Leur création se fair depuis le menu "Patient - Catégorie - Nouvelle catégorie".

==== Onglet Antécédents/Traitements ====
A compléter

==== Onglet Notes ====
A compléter

==== Onglet Documents ====
* Cette page permet de joindre des pièces jointes (images de scanners, d'échographie, documents words, ...)
Mais elle permet aussi de générer des documents OpenOffice à partir d'un modèle. Le modèle courrier_consult.odt est fourni en example.
* Pour générer un document, il faut choisir le modèle, éventuellement la fiche Bio associée puis cliquer sur Générer.
Le modèle sera utilisé et toutes les balises variables seront remplacées par les infos du patient ou de la consultation.
* Pour faire son propre modèle de document, voir la page [[Créer un modèle de document ODT]].
Les balises suivantes sont disponibles en plus de celle standard de Dolibarr:
{{TagsOdtCabinetMed}}

== Menu Bilan consultations ==
Choisir le menu Bilan consultations fait apparaitre un tableau affichant pour les 3 dernières années, les revenus avec le détail par mois.
En cliquant sur un mois, cela déroule le détail sur chaque jour du mois.
Il est aussi possible depuis cet écran d'exporter le détail dans un fichier Excel.

Copie d'écran exemple (cliquez sur l'image pour agrandir):

[[File:Dolimed screenshot report.png|200px]]

= Développement =
{{TemplateModNLTechnoEn}}

Module Medical Center

2015-06-07T07:55:02Z

Aikhan: /* Onglet Agenda */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described a little later.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of staff soigant (doctor, nurse, midwife, physiotherapist, or secretary ...), and therefore u nutilisateur part of the firm brought in to consult or enter Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
{{ToTranslate}}
Les Correspondants sont les autres soignants ou médecins s'occupant ou s'étant occupé du Patient.
Choisir le menu "'''Correspondants'''" fait apparaitre un sous-menu gauche offrant les fonctions pour créer, ou ajouter un nouveau Correspondant.
* Pour créer un correspondant, il suffit de cliquer sur l'entrée "Nouveau correspondant" et de saisir les informations sur la fiche vierge puis Enregistrer.
* Lorsqu'on a choisi l'entrée du menu "Liste des correspondants", on voie la liste de tous les correspondants enregistrés. Si on clique sur le nom de l'un d'eux, sa fiche s'ouvre. Et il est possible de la modifier.
* Il est possible de rappeler la fiche d'un Correspondant rapidement en saisissant une partie de son nom dans la zone de recherche rapide sur le bandeau de gauche.

'''Temporary translation'''
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient et consultations (Patient records and consultations)===
Pour créer une fiche patient, cliquer sur le menu "'''Patient - Nouveau Patient'''". Une fois créée, une fiche Patient contient plusieurs onglets:
* Un onglet avec les informations générales (qui sont celles enregistrés lors de la création)
* Un onglet Agenda (si le module Agenda a été activé)
* Un onglet Catégories (si le module Catégorie a été activé)
* Un onglet Correspondants
* Un ognlet Antécedants/Traitements
* Un onglet Notes
* Un onglet Consultations
* Un onglet Bio
* Un onglet Exploration
* Un onglet Courriers/Fichiers

Exemple: Cliquer sur l'image pour l'agrandir

[[File:Dolimed screenshot patientcard.png|200px]]

Voici un description sur la manière d'utiliser chaque onglet.

'''Temporary translation'''
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

==== Onglet des informations générales (Tab general information)====
* Sur la fiche du Patient, il est possible de lui affecter un ou plusieurs utilisateurs (médecins particuliers du cabinet suivant le patient par exemple). Bien que tous soignant puisse voir la fiche du patient d'un autre, ceci est utile pour classifier les patients par soignant principal. Cela est utilisé aussi pour les statistiques.

'''Temporary translation'''
* On the Patient card, it is possible to assign one or more users (individual doctors cabinet following the patient for example). Although all caregivers can see the patient's chart of another, this is useful to classify patients by primary caregiver. It is also used for statistics.

==== Onglet Correspondans (tab for correspondents) ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.
(On this tab, you can associate all physicians treating the patient with or knowing their specialty.)

==== Onglet Agenda ====
Cet onglet n'est visible que si le [[Module Agenda]] a été activé.
(This tab is only visible if the Calendar module has been activated.)

Il offre une vue de type calendrier de certains évênements qui ont été enregistrés sur le patient (création de la fiche patient, rendez-vous, saisie d'une consultation).
(It provides a calendar-type view of certain events that have been recorded on the patient (creation of the patient file, appointments, entering a consultation).)

==== Onglet Catégories ====
Cet onglet n'est visible que si le [[Module Catégories]] a été activé.

Il permet de classer un patient dans une ou plusieurs catégories. A vous de décider les catégories que vous créez. Leur création se fair depuis le menu "Patient - Catégorie - Nouvelle catégorie".

==== Onglet Antécédents/Traitements ====
A compléter

==== Onglet Notes ====
A compléter

==== Onglet Documents ====
* Cette page permet de joindre des pièces jointes (images de scanners, d'échographie, documents words, ...)
Mais elle permet aussi de générer des documents OpenOffice à partir d'un modèle. Le modèle courrier_consult.odt est fourni en example.
* Pour générer un document, il faut choisir le modèle, éventuellement la fiche Bio associée puis cliquer sur Générer.
Le modèle sera utilisé et toutes les balises variables seront remplacées par les infos du patient ou de la consultation.
* Pour faire son propre modèle de document, voir la page [[Créer un modèle de document ODT]].
Les balises suivantes sont disponibles en plus de celle standard de Dolibarr:
{{TagsOdtCabinetMed}}

== Menu Bilan consultations ==
Choisir le menu Bilan consultations fait apparaitre un tableau affichant pour les 3 dernières années, les revenus avec le détail par mois.
En cliquant sur un mois, cela déroule le détail sur chaque jour du mois.
Il est aussi possible depuis cet écran d'exporter le détail dans un fichier Excel.

Copie d'écran exemple (cliquez sur l'image pour agrandir):

[[File:Dolimed screenshot report.png|200px]]

= Développement =
{{TemplateModNLTechnoEn}}

Module Medical Center

2015-06-07T07:53:12Z

Aikhan: /* Onglet Correspondans */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described a little later.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of staff soigant (doctor, nurse, midwife, physiotherapist, or secretary ...), and therefore u nutilisateur part of the firm brought in to consult or enter Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
{{ToTranslate}}
Les Correspondants sont les autres soignants ou médecins s'occupant ou s'étant occupé du Patient.
Choisir le menu "'''Correspondants'''" fait apparaitre un sous-menu gauche offrant les fonctions pour créer, ou ajouter un nouveau Correspondant.
* Pour créer un correspondant, il suffit de cliquer sur l'entrée "Nouveau correspondant" et de saisir les informations sur la fiche vierge puis Enregistrer.
* Lorsqu'on a choisi l'entrée du menu "Liste des correspondants", on voie la liste de tous les correspondants enregistrés. Si on clique sur le nom de l'un d'eux, sa fiche s'ouvre. Et il est possible de la modifier.
* Il est possible de rappeler la fiche d'un Correspondant rapidement en saisissant une partie de son nom dans la zone de recherche rapide sur le bandeau de gauche.

'''Temporary translation'''
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient et consultations (Patient records and consultations)===
Pour créer une fiche patient, cliquer sur le menu "'''Patient - Nouveau Patient'''". Une fois créée, une fiche Patient contient plusieurs onglets:
* Un onglet avec les informations générales (qui sont celles enregistrés lors de la création)
* Un onglet Agenda (si le module Agenda a été activé)
* Un onglet Catégories (si le module Catégorie a été activé)
* Un onglet Correspondants
* Un ognlet Antécedants/Traitements
* Un onglet Notes
* Un onglet Consultations
* Un onglet Bio
* Un onglet Exploration
* Un onglet Courriers/Fichiers

Exemple: Cliquer sur l'image pour l'agrandir

[[File:Dolimed screenshot patientcard.png|200px]]

Voici un description sur la manière d'utiliser chaque onglet.

'''Temporary translation'''
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

==== Onglet des informations générales (Tab general information)====
* Sur la fiche du Patient, il est possible de lui affecter un ou plusieurs utilisateurs (médecins particuliers du cabinet suivant le patient par exemple). Bien que tous soignant puisse voir la fiche du patient d'un autre, ceci est utile pour classifier les patients par soignant principal. Cela est utilisé aussi pour les statistiques.

'''Temporary translation'''
* On the Patient card, it is possible to assign one or more users (individual doctors cabinet following the patient for example). Although all caregivers can see the patient's chart of another, this is useful to classify patients by primary caregiver. It is also used for statistics.

==== Onglet Correspondans (tab for correspondents) ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.
(On this tab, you can associate all physicians treating the patient with or knowing their specialty.)

==== Onglet Agenda ====
Cet onglet n'est visible que si le [[Module Agenda]] a été activé.

Il offre une vue de type calendrier de certains évênements qui ont été enregistrés sur le patient (création de la fiche patient, rendez-vous, saisie d'une consultation).

==== Onglet Catégories ====
Cet onglet n'est visible que si le [[Module Catégories]] a été activé.

Il permet de classer un patient dans une ou plusieurs catégories. A vous de décider les catégories que vous créez. Leur création se fair depuis le menu "Patient - Catégorie - Nouvelle catégorie".

==== Onglet Antécédents/Traitements ====
A compléter

==== Onglet Notes ====
A compléter

==== Onglet Documents ====
* Cette page permet de joindre des pièces jointes (images de scanners, d'échographie, documents words, ...)
Mais elle permet aussi de générer des documents OpenOffice à partir d'un modèle. Le modèle courrier_consult.odt est fourni en example.
* Pour générer un document, il faut choisir le modèle, éventuellement la fiche Bio associée puis cliquer sur Générer.
Le modèle sera utilisé et toutes les balises variables seront remplacées par les infos du patient ou de la consultation.
* Pour faire son propre modèle de document, voir la page [[Créer un modèle de document ODT]].
Les balises suivantes sont disponibles en plus de celle standard de Dolibarr:
{{TagsOdtCabinetMed}}

== Menu Bilan consultations ==
Choisir le menu Bilan consultations fait apparaitre un tableau affichant pour les 3 dernières années, les revenus avec le détail par mois.
En cliquant sur un mois, cela déroule le détail sur chaque jour du mois.
Il est aussi possible depuis cet écran d'exporter le détail dans un fichier Excel.

Copie d'écran exemple (cliquez sur l'image pour agrandir):

[[File:Dolimed screenshot report.png|200px]]

= Développement =
{{TemplateModNLTechnoEn}}

Module Medical Center

2015-06-07T07:51:08Z

Aikhan: /* Onglet des informations générales */

[[Category:Complementary modules]]
[[Category:CabinetMed]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Medical Center
|editor=NLTechno
|web=[http://www.nltechno.com www.nltechno.com]
|webbuy={{LinkToPluginDownloadDoliStore|keyword=medical}}
|status=stable
|prerequisites=
|minversion=3.5.3
|note=
}}

= Features =
Can turn your Dolibarr into a medical office manager (dictionaries of pathology, patient management, history, directory of referents doctors, following consultations, examinations/radios, generation of consultation documents, statistics of your consultations, monitoring money input, check receipts, etc ...).

How to use module is described a little later.

= Installation =
{{InstallModuleDoliStoreEn}}

= Setup =
{{ActivationModuleEn}}

'''Setup page specific to module:'''

Into setup page dedicated to module, you can also define:
* Feature related to rhumatology.
* Enable or not standard menu Thirdparies of yo have to manage thirdparies that are not patient.

'''Other options:'''

Into menu 'Home - Setup - Other', you can also add constant "'''CABINETMED_DELAY_TO_LOCK_RECORD'''" to a number of day. This means all consultation recorded could not be modified 2 days Iafter they were recorded.

By default, professional ID fields are not visible when you are on a patient card. You can however decide to make them visible by adding the constant '''CABINETMED_SHOW_PROFIDx''' to 1 (where x is a number between 1 and 6 to define which professional ID you want to see. Add several constants, if you need several professional ID).

= Usage =
Activating this module will add the following new top menu entries:
* Patients
* Contacts (the other doctors)
* Consultation summary (show entry/output for a year, month or day of revenus)

== Users ==
Quand le module est activé, un utilisateur Dolibarr est en fait un membre du personnel soigant (médecin, infirmière, sage-femme, kiné, ou encore secrétaire...), et donc u nutilisateur faisant partie du cabinet amené à consulter ou saisir dans Dolibarr. Il peut n'y avoir qu'un seul utilisateur dans le cas d'un médecin ou soignant exerçant seul. Un utilisateur peut aussi être une personne du secrétariat téléphonique du cabinet.

'''Temporary translation'''
When the module is activated, a Dolibarr user is actually a member of staff soigant (doctor, nurse, midwife, physiotherapist, or secretary ...), and therefore u nutilisateur part of the firm brought in to consult or enter Dolibarr. There may be only one user in the case of a sole practitioner physician or caregiver. A user can also be a person answering service firm.

== Care givers contacts ==
{{ToTranslate}}
Les Correspondants sont les autres soignants ou médecins s'occupant ou s'étant occupé du Patient.
Choisir le menu "'''Correspondants'''" fait apparaitre un sous-menu gauche offrant les fonctions pour créer, ou ajouter un nouveau Correspondant.
* Pour créer un correspondant, il suffit de cliquer sur l'entrée "Nouveau correspondant" et de saisir les informations sur la fiche vierge puis Enregistrer.
* Lorsqu'on a choisi l'entrée du menu "Liste des correspondants", on voie la liste de tous les correspondants enregistrés. Si on clique sur le nom de l'un d'eux, sa fiche s'ouvre. Et il est possible de la modifier.
* Il est possible de rappeler la fiche d'un Correspondant rapidement en saisissant une partie de son nom dans la zone de recherche rapide sur le bandeau de gauche.

'''Temporary translation'''
Correspondents are other caregivers or doctors attending or being occupied Patient. Select the menu "Correspondents" brings up a submenu with the left functions to create, or add a new correspondent.
* To create a contact, just click on the entry "New correspondent" and enter information on the blank page and select Save.
* When selected the menu entry "List all", it means the list of all registered correspondents. If you click on the name of one of them, its card opens. And it is possible to change it.
* It is possible to recall a detail Corresponding quickly by typing part of its name in the quick search box on the left panel.

== Patients ==
Select the top menu "'' ''' Patients", brings up an offering functions to create a new patient list patients or past consultations submenu.

* To create a new patient, simply click on the "New Patient" entry and enter the information on the blank sheet and then Save.
* When you have selected the menu entry "Patient List" is the track list of all registered patients. If you click on the name of one of them, his record opens. And it is possible to change it.
* It is also possible to recall the record of a patient quickly by typing part of its name in the quick search box on the left banner.

=== Fiches Patient et consultations (Patient records and consultations)===
Pour créer une fiche patient, cliquer sur le menu "'''Patient - Nouveau Patient'''". Une fois créée, une fiche Patient contient plusieurs onglets:
* Un onglet avec les informations générales (qui sont celles enregistrés lors de la création)
* Un onglet Agenda (si le module Agenda a été activé)
* Un onglet Catégories (si le module Catégorie a été activé)
* Un onglet Correspondants
* Un ognlet Antécedants/Traitements
* Un onglet Notes
* Un onglet Consultations
* Un onglet Bio
* Un onglet Exploration
* Un onglet Courriers/Fichiers

Exemple: Cliquer sur l'image pour l'agrandir

[[File:Dolimed screenshot patientcard.png|200px]]

Voici un description sur la manière d'utiliser chaque onglet.

'''Temporary translation'''
To create a patient file, click on the menu '' '' Patient - New Patient '' ''. Once created, a Patient card contains several tabs:
* A tab with general information (which are those recorded during the creation)
* A Calendar tab (if the Calendar module has been enabled)
* A Categories tab (if the Category module has been enabled)
* A Correspondence tab
* A history tab / Treatments
* A Notes tab
* A consultation tab
* A Bio tab
* A exploration tab
* A Couriers tab / Files

==== Onglet des informations générales (Tab general information)====
* Sur la fiche du Patient, il est possible de lui affecter un ou plusieurs utilisateurs (médecins particuliers du cabinet suivant le patient par exemple). Bien que tous soignant puisse voir la fiche du patient d'un autre, ceci est utile pour classifier les patients par soignant principal. Cela est utilisé aussi pour les statistiques.

'''Temporary translation'''
* On the Patient card, it is possible to assign one or more users (individual doctors cabinet following the patient for example). Although all caregivers can see the patient's chart of another, this is useful to classify patients by primary caregiver. It is also used for statistics.

==== Onglet Correspondans ====
Sur cet onglet, vous pouvez associer tous les médecins traitant ou connaissant le patient avec leur spécialité.

==== Onglet Agenda ====
Cet onglet n'est visible que si le [[Module Agenda]] a été activé.

Il offre une vue de type calendrier de certains évênements qui ont été enregistrés sur le patient (création de la fiche patient, rendez-vous, saisie d'une consultation).

==== Onglet Catégories ====
Cet onglet n'est visible que si le [[Module Catégories]] a été activé.

Il permet de classer un patient dans une ou plusieurs catégories. A vous de décider les catégories que vous créez. Leur création se fair depuis le menu "Patient - Catégorie - Nouvelle catégorie".

==== Onglet Antécédents/Traitements ====
A compléter

==== Onglet Notes ====
A compléter

==== Onglet Documents ====
* Cette page permet de joindre des pièces jointes (images de scanners, d'échographie, documents words, ...)
Mais elle permet aussi de générer des documents OpenOffice à partir d'un modèle. Le modèle courrier_consult.odt est fourni en example.
* Pour générer un document, il faut choisir le modèle, éventuellement la fiche Bio associée puis cliquer sur Générer.
Le modèle sera utilisé et toutes les balises variables seront remplacées par les infos du patient ou de la consultation.
* Pour faire son propre modèle de document, voir la page [[Créer un modèle de document ODT]].
Les balises suivantes sont disponibles en plus de celle standard de Dolibarr:
{{TagsOdtCabinetMed}}

== Menu Bilan consultations ==
Choisir le menu Bilan consultations fait apparaitre un tableau affichant pour les 3 dernières années, les revenus avec le détail par mois.
En cliquant sur un mois, cela déroule le détail sur chaque jour du mois.
Il est aussi possible depuis cet écran d'exporter le détail dans un fichier Excel.

Copie d'écran exemple (cliquez sur l'image pour agrandir):

[[File:Dolimed screenshot report.png|200px]]

= Développement =
{{TemplateModNLTechnoEn}}