Developer documentation

From Dolibarr ERP CRM Wiki
Revision as of 21:45, 7 January 2009 by Eldy (talk | contribs)
Jump to navigation Jump to search

Global informations

This chapter contains global informations that must be read before to start any development on Dolibarr.

  1. To known before to start
  2. Environment and development tools
  3. Dependencies and external libraries
  4. Langage and development rules
  5. Get a version from CVS

Technical setup of Dolibarr

Dolibarr setup (authentication mode, database logins and storage area for files) are defined in only one setup file conf/conf.php. See Configuration file for more information.

Database

  1. Naming rules
  2. List of tables
  3. Database structure update

Understand an existing module

Documentations, for developers, for a standard business modules, are defined on page ModulesEn.

List of other modules is defined on page [1]

To developper a new module/addon for GUI (new screens)

This section describe how to develop a new module on Dolibarr graphic user interfaces (GUI). A GUI module can contains its own screens, its own data and its own CSS stylesheet. Script development is not included in this section (this is described in next chapter). Numbering modules, modules for documents generation, skins or triggers are also described in other following chapters.

To develop you own GUI extension, go on tutorial: Module developement

To develop a batch or command line script

Cette section décrit la procédure pour développer son propre script batch afin de réaliser des traitements dans Dolibarr (lecture, eccriture, etc...). La réalisation de modification sur l'interface utilisateur (IHM) ne rentre pas dans ce périmètre. Voir le chapitre précédent pour cela.

Pour développer un script quel qu'il soit, comme un script de traitement cron ou encore un script d'import de données issus d'un autre système, se référer à la page: Developpement script

Setup system

There is 2 area for Dolibarr parameters.

See page Constants

Menus system

See page Menus system

Skins system

See page Skins

Box system

See page Box system

Authentication system

See page Authentication

Permission system

See page PermissionsEn

Trnaslation system

See page Translation system

Error management

See page Error reporting

Numbering modules

Pour chaque entité crée dans l'application, Dolibarr attribue une référence. Afin de pouvoir adapter cette référence à toute utilisation, Dolibarr utilise des modules pour définir la règle de génération de cette référence. Des modules sont fournis en standard donc certains sont génériques et permettent de définir le masque de numérotation (nombre sur x caractère, avec ou sans prefix, incluant la date ou pas, etc), ce qui permet de répondre à la plupart des besoins. Toutefois, il existe toujours des cas où le module fourni en standard ne répond pas au besoin. Dans ce cas il est nécessaire de développer son propre module de numérotation. Plus d'information sur la page Créer un module de numérotation

Les modèles et la géneration de documents

Plus de documentation au sujet de la génération de documents depuis des modèles est disponible sur la page Creer un modele de document

Files/Documents storage management

See pagee Generated documents

Mass exports/imports

  1. Mass imports
  2. Mass exports

Interfaces and links with other applications

  1. Interfaces Dolibarr toward foreign systems (Dolibarr Triggers)
  2. Interfaces from foreign systems toward Dolibarr
  3. Web services

FAQ

  1. Developer FAQ