Dolibarr ERP CRM Wiki - User contributions [en]

Créer un modèle de document PDF

2023-03-25T17:57:40Z

Techsc: Vidéos ajoutées par TechSC

[[en:Create_a_PDF_document_template]]
[[es:Crear_un_modelo_de_documento_PDF]]
[[zh:创建PDF模板]]


{{TemplateDocDev}}
Ce document décrit comment créer son propre modèle de génération de document PDF afin de personnaliser ses documents (propales, factures, etc...)
Il se base sur les propositions commerciales comme exemple mais s'applique à tout type de document.

Pour savoir comment générer un modèle de document ODT, voir la page [[Créer un modèle de document ODT]].
Créer un modèle PDF requiert des connaissances en programmation PHP mais pas la création de modèles ODT.

=Prérequis=

*Dolibarr: 3.0+
*Connaissance en PHP

=Trouver le modèle existant le plus proche=
Dans Dolibarr, tester les modèles existants en allant dans la configuration du module puis en consultant l'aperçu en cliquant le picto "Aperçu" en fin de ligne du modèle. Consulter chacun des modèles disponibles.

Parmi ceux existant, noter le modèle le plus proche de vos besoins. Dans cet exemple, c'est le modèle azur (correspondant au fichier pdf_propale_azur.modules.php).

Pour info, tous les modèles sont dans '''htdocs/core/modules''' puis le sous-répertoire propale pour les propositions commerciales, facture pour les factures, commandes pour les commandes, etc... et enfin '''doc'''.
Par exemple, un modèle personnalisé de proposition sera dans '''...core/modules/propale/doc/''' pour un modèle personnalisé de facture ce sera dans '''...core/modules/facture/doc/''' ,etc ...

=Créer le nouveau modèle=
Par sécurité, on conservera les modèles d'origine. Pour l'exemple, on part du principe qu'on crée un nouveau module de proposition commerciale qu'on nommera 'masocietebleu' et qui s'inspire du module 'azur':

*Copier le fichier pdf_propale_azur.modules.php
*Renommer la copie en pdf_propale_masocietebleu.modules.php
*L'éditer et faire les modifs suivantes dans le code:

#Renommer “''Class pdf_propale_azur {''” en “''Class pdf_propale_masocietebleu {''” (important : le nom de la classe et celui du fichier doivent correspondre)
#Renommer la variable $this->name pour refléter le nouveau nom. Par exemple pour le modèle 'azur', changer la ligne '$this->name = "azur";' en '$this->name = "masocietebleu";'.
#Sauvegarder : le modèle 'masocietebleu' est disponible dans la liste des modèles de propales de Dolibarr

*Tester ce modèle en l'activant dans la page de configuration du module en rapport avec le modèle (donc la page de configuration du module des Propositions commerciales dans notre exemple) et en affichant l'aperçu...

=Personnaliser votre nouveau modèle=
Personnaliser le modèle créé en modifiant le code:

Toujours dans pdf_propale_masocietebleu.modules.php, chercher la fonction '_pagehead()'. C'est elle qui gère l'affichage de l'entête.

Chercher la fonction '_pagefooter()'. C'est elle qui gère l'affichage du pied de page.

Chercher la fonction 'write_file()'. C'est elle qui affiche le corps du PDF.

==Librairie de manipulation de PDF==
La librairie utilisée pour la création de documents en PDF se nomme TCPDF et peut être trouvée dans htdocs/includes/tcpdf/tcpdf.class.php. C'est également dans cette classe que l'on trouve les nombreuses méthodes utilisées pour générer les différents éléments des documents.

Les modèles de génération de pdf instancient un objet pdf par appel de pdf_getInstance() et utilisent ensuite ses méthodes, combinées avec les données d'une facture, d'une commande ou d'autres objets.

On retrouve généralement les appels suivants dans les scripts de création de documents:

*$pdf->SetFont() - ''Désigne la fonte à utiliser pour le texte qui suivra''
*$pdf->SetXY() - ''Désigne le point de départ pour dessiner le prochain texte en coordonnées X,Y qui sont exprimées en millimètres de la page''
*$pdf->MultiCell() - ''Dessine une boîte pouvant contenir du texte, et dont on doit d'abord donner la largeur et la hauteur - très utilisée''
*$pdf->GetY() - ''Renvoie la position courante en Y''
*$pdf->SetDrawColor() - ''Désigne la couleur à utiliser pour le prochain texte à écrire - généralement noir (0,0,0) ou blanc (255,255,255)''
*$pdf->Rect() - ''Dessine un rectangle dont le coin supérieur gauche est au point indiqué par les deux premiers paramètres et le coin inférieur droit utilise les deux derniers paramètres en mode relatif aux deux premiers''

==Structure des scripts==
Les scripts de génération des documents PDF, disposent des méthodes suivantes (prenant pour exemple le modèle "crabe") au sein de la classe du modèle:

*__construct() - ''Constructeur de l'objet PDF''
*write_pdf_file() - ''Méthode générale pour la génération du fichier. Cette méthode appelle toute les suivantes après avoir initialisé quelques variables''
*_pagehead() - ''Méthode de dessin de l'en-tête du document, incluant généralement le logo, le titre du document (et la date) ainsi que les cadres de l'émetteur et du destinataire du document''
*_tableau() - ''Méthode de dessin du tableau de détails (produits, services, etc)''
*_tableau_info() - ''Méthode de dessin du tableau reprenant une liste d'informations sur la facture''
*_tableau_tot() - ''Méthode de dessin du tableau des totaux''
*_tableau_versement() - ''Méthode de dessin du tableau des règles de versement''
*_pagefoot() - ''Méthode de dessin du pied de page''

==Example de personnalisation==
===Insertion d'un logo===

*Ajouter l'instruction :

<syntaxhighlight lang="PHP">
$pdf->Image(DOL_DOCUMENT_ROOT.'\societe\logo.jpg', 10, 5, 60.00);
</syntaxhighlight>
Avec dans l'exemple : 10=abscisse, 5=ordonnée, 60=largeur logo

*Si le logo se trouve par dessous ou dessus du texte existant, supprimer le texte existant en commentant le code qui affiche l'information ou en modifiant sa position.

===Insertion d'une signature ou autre en bas de page facture===

*ouvrir le fichier .php à modifier et insérer

<syntaxhighlight lang="PHP">
$pdf->Image(DOL_DOCUMENT_ROOT.'/mydir/signature.jpg',120,250,74);
</syntaxhighlight>
l'image (largeur 74mm) est affichée colonne de droite juste avant le pied de page.

*copier l'image dans le répertoire. il semble qu'une image png avec transparence pose problème.
*générer le PDF, la signature apparaît.

===Insertion de texte===
Principales fonctions utilisées
<syntaxhighlight lang="PHP">
$pdf->setX(float a); // fixe la position x courante
$pdf->setY(float b); // fixe la position y courante
$pdf->setXY(float a,float b); // fixe les positions x et y courantes
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne
</syntaxhighlight>
Rappel : l'origine des fonctions setXY est le coin supérieur gauche de la page

==Pour plus d'infos==

*Liste des méthodes TCPDF: https://tcpdf.org/docs/srcdoc/

=Proposer son modèle via un module=
Si le modèle fabriqué est destiné à être livré via un module extension de Dolibarr (voir la doc pour faire un module Dolibarr), le fichier modèle ne sera pas dans le même répertoire que les autres, et ne sera donc pas détecté automatiquement. Pour le rendre détectable vous devrez ajouter cette ligne dans la fonction d'initialisation de votre module externe :

<syntaxhighlight lang="PHP">
sql=array("INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$MODELNAME."','".$MODEL_TARGET_MODULE."',".$conf->entity." )");
</syntaxhighlight>

avant

<syntaxhighlight lang="PHP"> return $this->_init($sql,$option);</syntaxhighlight>

Puis

Dans Accueil => Configuration => Modules => Module sur lequel porte le modèle => Configurer

*activer votre module qui doit apparaître parmi ceux disponible
*éventuellement le mettre en modèle proposé par défaut.

=Vidéos sur le sujet=
<youtube width="200" height="120">dEC8hFcT71U</youtube>
<youtube width="200" height="120">LtXPBz9fWQE</youtube>

Module Web Services API REST (développeur)

2023-03-03T17:02:03Z

Techsc: /* Vidéos sur le sujet */ Ajout vidéo par Techsc

[[en:Module_Web_Services_API_REST_(developer)]]


{{TemplateDocDevFr}}
{{TemplateModFR}}
[[Category:Liste des Modules (développeur)]]
{{BasculeDevUser|
nom=Web services|
num=2610|
devdoc=Cette page|
userdoc=Non applicable|}}

= Fonction =
Quand ce module est activé, vous activez l'utilisation des Webservices fournis par Dolibarr. Vous pouvez alors faire des appels REST sur différents Webservices fournis par Dolibarr.

= Installation =

Pour l'installer, ouvrez la page des modules et activez le module "API REST".

Une fois que le module Web services REST est activé, Dolibarr devient également un serveur de Web services REST. Vous pouvez alors envoyer vos propres requêtes sur l'url relative :
'''/api/index.php/xxx''' où xxx est l'API à appeler.

= Liste des services fournis =
Seuls quelques services sont disponibles. À compter de la version 5.0 de Dolibarr, vous pouvez consulter la liste complète des web services proposés en appelant l'explorer à cette adresse :

'''http://yourdolibarrurl/api/index.php/explorer'''.

Par exemple, vous pouvez essayer l'explorateur sur l'instance de démonstration à l'adresse suivante :

'''https://demo.dolibarr.org/api/index.php/explorer'''

Dans le coin supérieur droit, collez le <token> de l'utilisateur que vous souhaitez utiliser pour appeler l'API, puis cliquez sur le bouton "explorer". Remarque: Le jeton de chaque utilisateur peut être défini sur la page d'enregistrement de l'utilisateur.

Vous pouvez aussi préférer faire un premier appel au service '''login''' pour obtenir le jeton API. Vous aurez en réponse le jeton à utiliser pour obtenir et appeler la liste des services proposés.

Après avoir saisi le jeton et cliqué sur "Explore", vous devriez voir toutes les actions disponibles avec ce jeton. Si vous n'avez pas beaucoup d'actions, c'est probablement parce que les modules correspondants ne sont pas activés. Si vous voulez voir les factures, vous devez activer le module Factures dans la configuration de Dolibarr. Même chose pour les Produits, les Tiers, etc.

Vous pouvez ensuite tester directement à partir de cet explorateur n'importe quelle API. Ceci est la solution recommandée pour tester toute API Dolibarr, car toutes les API et paramètres sont documentés ici. À la suite d'un test, vous obtiendrez la réponse, mais également un exemple sur la façon d'appeler l'API à partir de la ligne de commande à l'aide de curl.

Sur cette page d'exploration de l'API, vous pouvez faire beaucoup de tests. Lire des données de Dolibarr et écrire, modifier et supprimer également. Attention: les données sont vraiment modifiées dans votre base de données.

= Utilisation =

Grosso modo, pour utiliser REST, il faut appeler une url du genre suivant <nowiki>http://<mon_serveur>/api/index.php/<action></nowiki> 
avec une des 4 méthodes : GET, POST, PUT, DELETE, en remplaçant <action> par l'action sur laquelle vous voulez intervenir. Ex : <nowiki>http://<mon_serveur>/api/index.php/invoices</nowiki>

Avant d'utiliser une API, vous devez d'abord obtenir une clé API personnalisée. Vous devez créer un nouvel utilisateur et générer ou définir sa "clé pour l'API".

[[File:Dolibarr user for api.png|400px]]

Vous devrez utiliser cette clé API dans n'importe lequel de vos programmes clients devant appeler une API Dolibarr.

Pour ce faire, il existe plusieurs méthodes. Voici un morceau de code opérationnel pour appeler une API, mais il existe également des librairies qui simplifie le travail, telles que phphttpclient.com.

<syntaxHighlight lang="php">
function CallAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}
</syntaxHighlight>

Ce n'est qu'un exemple, ce n'est pas sécurisé, cela ne prend pas en compte les codes erreurs mais vous pouvez le modifier et l'adapter à vos besoins.
la fonction prend 4 paramètres :
* $method : string "GET", "POST", "PUT", "DELETE"
* $apikey : string "votre <token> généré plus haut"
* $url : string l'url à appeler. Ex : "<nowiki>http://<mon_serveur>/api/index.php/invoices</nowiki>"
* $data : string flux au format json. Ce champ est requis pour les appels POST ou PUT.

= Exemples avec PHP =

Maintenant, quelques exemples opérationnels pour différents cas d'utilisation. 

Dans tous les cas, on a :
* $apiKey = "<mon token>";
* $apiUrl = "<nowiki>http://<mon_serveur>/api/index.php/</nowiki>";

<syntaxHighlight lang="php">
// Récupérer la liste des produits
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</syntaxHighlight>
Commentaires :
* récupérer les 10'000 premiers produits triés par leur id dans la base
* html_entity_decode est nécessaire car les apostrophes sont encodés
* il est facile d'utiliser la même méthode (en remplaçant products par dictionnarycountries) pour récupérer la liste des pays

<syntaxHighlight lang="php">
// Créer un produit
$ref = "ma_reference_produit_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</syntaxHighlight>
Commentaires :
* avant de créer un produit, il peut être sage de vérifier qu'il existe. En reprenant le premier exemple, cela fait :

<syntaxHighlight lang="php">
// ma référence
$ref = "ma_reference_produit_X203ZZ";
// existe-t-elle dans mon tableau
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// oui
$fk_product = $produitKey;
} else {
// non
// Créer un produit
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// il y a eu une erreur
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// tout va bien
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</syntaxHighlight>
Commentaires :
* je regarde si la référence de mon article existe dans le tableau créé dans le premier exemple.
* si elle existe, j'utilise sa clé dans le tableau comme id
* si elle n'existe pas, je crée l'article puis le j'ajoute à mon tableau pour les prochaines fois et je récupère l'id créé
* cette méthode permet de limiter les appels API quand on doit importer 500 commandes par exemple. Récupérer une fois la liste des produits au début au lieu de chercher à chaque fois dans Dolibarr.

<syntaxHighlight lang="php">
// créer une commande avec 2 articles

// le tableau qui contiendra toutes les lignes d'articles de la commande
$newCommandeLine = [];

// article 1
$ref1 = "ma_reference_produit_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// article 2
$ref2 = "ma_reference_produit_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "Commande importée automatiquement depuis l'application",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</syntaxHighlight>
Commentaires :
* $clientDoliId vaut l'id du client dans la base doli. Soit vous le connaissez, soit vous pouvez le chercher auparavant
* type => 0, c'est une commande client (par opposition à 1 = commande fournisseur)

<syntaxHighlight lang="php">
// Valider une commande
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);
</syntaxHighlight>
Commentaires :
* on voit dans cet exemple, en avant dernière lignes, on a : $apiUrl."orders/".$newCommandeResult."/validate". 
$newCommandeResult est l'id de la commande crée (récupéré dans l'exemple précédent)

<syntaxHighlight lang="php">
// chercher si le client existe dans la base
$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$nom_client."')"
)
), true);
</syntaxHighlight>
Commentaires :
* limit => 1 pour ne renvoyer que 1 client
* mode => 1 car on cherche un client (on aurait aussi pu chercher un fournisseur qui est aussi un tiers mais avec un statut différent)
* sqlfilters syntaxe un peu particulière mais il y a qq autres exemples sur la page d'explorer d'API

<syntaxHighlight lang="php">
//client n'existe pas. le crée puis on récupère son id
$newClient = [
"name" => "nom société client",
"email" => "email société client",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</syntaxHighlight>
Commentaires :
* client => 1 car c'est un client (et pas un fournisseur)
* code_client => -1 pour que le code client soit généré automatiquement.
* on récupère l'id du client dans $clientDoliId

= Développer un nouveau service / sa propre API =

Ajouter un nouveau service est aussi facile qu'ajouter un fichier nommé '''api_monmoduleobject.class.php''' dans le dossier '''htdocs/monmodule/class'''.
Si vous utilisez le "modulebuilder" pour développer sur Dolibarr, cette API avec les méthode CRUD pourra même être générée pour vous.
Sinon, un copié-collé d'un fichier API existant fera l'affaire. Vous pouvez prendre comme exemple le fichier dans '''htdocs/commande/class/api_orders.class.php''' et l'adapter à votre classe / besoin.

Le framework détecte automatiquement les API et elle devrait être visible dans l'explorateur.

Les méthodes et paramètres sont détectées en fonction de l'introspection réalisée dans les classes PHP de l'objet ('''htdocs/monmodule/class/object.class.php''') en utilisant les '''annotations''' trouvées dans la classe.

Pour une documentation à propos des annotations : https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

Vous trouverez pas mal d'autres informations dans le code de Dolibarr. Vous trouverez tous les fichiers API de Dolibarr sous le nom '''htdocs/<dossier>/class/api_xxx_class.php'''

= Vidéos sur le sujet =
<youtube width="200" height="180">WHV22L8enWw</youtube>
<youtube width="200" height="180">RPUcoweeuR8</youtube>
<youtube width="200" height="180">ZwssM-viocM</youtube>

EvenementTacheJournal

2023-02-08T22:37:06Z

Techsc: /* Les évènements et rendez-vous (event) */ suppression de "ou un durée (Dans la norme ical: duration) mais l'un ou l'autre et pas les deux." car sur la V16.0.3 il n'y a pas la notion de durée

[[en:Events-Todo-Journal]]
[[es:EventoTareaDiario]]
[[pt:EventoTarefaDiario]]


{{TemplateDocUtil}}
[[Category:Agenda]]
=Introduction=
Les applications de gestion de taches/plannings/agenda tel outlook, lightning, webcalendar, etc gèrent 3 notions différentes (normées dans la norme RFC2445) qui sont:

*Les évènements ('''event''' en anglais dans la norme)
*Les taches ('''to-do''' en anglais dans la norme)
*Les journaux ('''journal''' en anglais dans la norme)

ces notions sont très proches mais restent destinés à des vocations différentes. Cette page décrit ces nuances.

=Les évènements et rendez-vous (event)=
Un évènement (event en langage normé), est une notion qui caractérise une action instantanée ou de longue durée qui a eu dans le passé ou doit avoir lieu dans le futur.

Il a les caractéristiques suivantes:

*Un libellé (Dans la norme ical: summary)
*Une description (Dans la norme ical: description)
*Une date début (Dans la norme ical: dtstart)
*Une date de fin (Dans la norme ical: dtend) ou une durée (Dans la norme ical: duration) mais c'est l'un ou l'autre et pas les deux.
*Un lieu, comme un nom de salle par exemple (Dans la norme ical: location)
*Une priorité (Dans la norme ical: priority)
*La transparence (dans la norme ical: transp) qui dit si les acteurs sont rendus indisponibles par cette tache.
*Un statut (tentative, confirmé ou annulé), rarement utilisé.
*D'autres informations moins structurantes.

'''Exemple d'utilisation''':
Cela correspond aux informations que l'on voit dans les calendrier Outlook (onglet Calendrier), Evolution ou Thunderbird/Lightning
On utilise les "events" pour stocker les rendez-vous par exemple, mais peut aussi être utilisé pour stocker
un travail à faire dans une plage de date donnée.

'''Dans Dolibarr''':
Cette notion est gérée par le [[Module Agenda]].
Dolibarr y a ajouté la notion de pourcentage d'avancement. Il y a aussi une option dans le module pour ajouter un champ type.

=Les taches (to-do)=
Une tache a les caractéristiques suivantes

*Un libellé (Dans la norme ical: summary)
*Une description (Dans la norme ical: description)
*Une date de début (Dans la norme ical: dtstart)
*Une date de fin (Dans la norme ical: due)
*Un pourcentage d'état d'avancement (Dans la norme ical: percent-complete).
*Une priorité (Dans la norme ical: priority).
*Un statut (en cours, confirmé ou annulé)
*D'autres informations moins structurantes.

'''Exemple d'utilisation''':
Cela correspond aux tâches que l'on trouve sous Outlook (onglet Taches), Evolution ou Thunderbird/Lightning.
On s'en sert en général pour définir les tâches d'un projet.

'''Dans Dolibarr''':
Cette notion est gérée par le [[Module Projet]].

=Les journaux (journal)=
Une entrée journal est une information. Elle a les caractéristiques suivantes:

*Un libellé
*Une description
*Une date de l'information
*Un lieu
*Un statut (brouillon, confirmé, effacé).
*D'autres informations moins structurantes.

'''Exemple d'utilisation''':
Gérer un journal de bord.

'''Dans Dolibarr''':
Cette notion n'existe pas dans aucun module fourni en standard avec Dolibarr.

Module Web Services API REST (développeur)

2023-01-24T08:35:46Z

Techsc: /* Vidéos sur le sujet (documentation utilisateurs) */ Mise en page

[[en:Module_Web_Services_API_REST_(developer)]]


{{TemplateDocDevFr}}
{{TemplateModFR}}
[[Category:Liste des Modules (développeur)]]
{{BasculeDevUser|
nom=Web services|
num=2610|
devdoc=Cette page|
userdoc=Non applicable|}}

= Fonction =
Quand ce module est activé, vous activez l'utilisation des Webservices fournis par Dolibarr. Vous pouvez alors faire des appels REST sur différents Webservices fournis par Dolibarr.

= Installation =

Pour l'installer, ouvrez la page des modules et activez le module "API REST".

Une fois que le module Web services REST est activé, Dolibarr devient également un serveur de Web services REST. Vous pouvez alors envoyer vos propres requêtes sur l'url relative :
'''/api/index.php/xxx''' où xxx est l'API à appeler.

= Liste des services fournis =
Seuls quelques services sont disponibles. À compter de la version 5.0 de Dolibarr, vous pouvez consulter la liste complète des web services proposés en appelant l'explorer à cette adresse :

'''http://yourdolibarrurl/api/index.php/explorer'''.

Par exemple, vous pouvez essayer l'explorateur sur l'instance de démonstration à l'adresse suivante :

'''https://demo.dolibarr.org/api/index.php/explorer'''

Dans le coin supérieur droit, collez le <token> de l'utilisateur que vous souhaitez utiliser pour appeler l'API, puis cliquez sur le bouton "explorer". Remarque: Le jeton de chaque utilisateur peut être défini sur la page d'enregistrement de l'utilisateur.

Vous pouvez aussi préférer faire un premier appel au service '''login''' pour obtenir le jeton API. Vous aurez en réponse le jeton à utiliser pour obtenir et appeler la liste des services proposés.

Après avoir saisi le jeton et cliqué sur "Explore", vous devriez voir toutes les actions disponibles avec ce jeton. Si vous n'avez pas beaucoup d'actions, c'est probablement parce que les modules correspondants ne sont pas activés. Si vous voulez voir les factures, vous devez activer le module Factures dans la configuration de Dolibarr. Même chose pour les Produits, les Tiers, etc.

Vous pouvez ensuite tester directement à partir de cet explorateur n'importe quelle API. Ceci est la solution recommandée pour tester toute API Dolibarr, car toutes les API et paramètres sont documentés ici. À la suite d'un test, vous obtiendrez la réponse, mais également un exemple sur la façon d'appeler l'API à partir de la ligne de commande à l'aide de curl.

Sur cette page d'exploration de l'API, vous pouvez faire beaucoup de tests. Lire des données de Dolibarr et écrire, modifier et supprimer également. Attention: les données sont vraiment modifiées dans votre base de données.

= Utilisation =

Grosso modo, pour utiliser REST, il faut appeler une url du genre suivant <nowiki>http://<mon_serveur>/api/index.php/<action></nowiki> 
avec une des 4 méthodes : GET, POST, PUT, DELETE, en remplaçant <action> par l'action sur laquelle vous voulez intervenir. Ex : <nowiki>http://<mon_serveur>/api/index.php/invoices</nowiki>

Avant d'utiliser une API, vous devez d'abord obtenir une clé API personnalisée. Vous devez créer un nouvel utilisateur et générer ou définir sa "clé pour l'API".

[[File:Dolibarr user for api.png|400px]]

Vous devrez utiliser cette clé API dans n'importe lequel de vos programmes clients devant appeler une API Dolibarr.

Pour ce faire, il existe plusieurs méthodes. Voici un morceau de code opérationnel pour appeler une API, mais il existe également des librairies qui simplifie le travail, telles que phphttpclient.com.

<source lang="php">
function CallAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}
</source>

Ce n'est qu'un exemple, ce n'est pas sécurisé, cela ne prend pas en compte les codes erreurs mais vous pouvez le modifier et l'adapter à vos besoins.
la fonction prend 4 paramètres :
* $method : string "GET", "POST", "PUT", "DELETE"
* $apikey : string "votre <token> généré plus haut"
* $url : string l'url à appeler. Ex : "<nowiki>http://<mon_serveur>/api/index.php/invoices</nowiki>"
* $data : string flux au format json. Ce champ est requis pour les appels POST ou PUT.

= Exemples avec PHP =

Maintenant, quelques exemples opérationnels pour différents cas d'utilisation. 

Dans tous les cas, on a :
* $apiKey = "<mon token>";
* $apiUrl = "<nowiki>http://<mon_serveur>/api/index.php/</nowiki>";

<source lang="php">
// Récupérer la liste des produits
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</source>
Commentaires :
* récupérer les 10'000 premiers produits triés par leur id dans la base
* html_entity_decode est nécessaire car les apostrophes sont encodés
* il est facile d'utiliser la même méthode (en remplaçant products par dictionnarycountries) pour récupérer la liste des pays

<source lang="php">
// Créer un produit
$ref = "ma_reference_produit_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</source>
Commentaires :
* avant de créer un produit, il peut être sage de vérifier qu'il existe. En reprenant le premier exemple, cela fait :

<source lang="php">
// ma référence
$ref = "ma_reference_produit_X203ZZ";
// existe-t-elle dans mon tableau
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// oui
$fk_product = $produitKey;
} else {
// non
// Créer un produit
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// il y a eu une erreur
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// tout va bien
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</source>
Commentaires :
* je regarde si la référence de mon article existe dans le tableau créé dans le premier exemple.
* si elle existe, j'utilise sa clé dans le tableau comme id
* si elle n'existe pas, je crée l'article puis le j'ajoute à mon tableau pour les prochaines fois et je récupère l'id créé
* cette méthode permet de limiter les appels API quand on doit importer 500 commandes par exemple. Récupérer une fois la liste des produits au début au lieu de chercher à chaque fois dans Dolibarr.

<source lang="php">
// créer une commande avec 2 articles

// le tableau qui contiendra toutes les lignes d'articles de la commande
$newCommandeLine = [];

// article 1
$ref1 = "ma_reference_produit_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// article 2
$ref2 = "ma_reference_produit_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "Commande importée automatiquement depuis l'application",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</source>
Commentaires :
* $clientDoliId vaut l'id du client dans la base doli. Soit vous le connaissez, soit vous pouvez le chercher auparavant
* type => 0, c'est une commande client (par opposition à 1 = commande fournisseur)

<source lang="php">
// Valider une commande
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);
</source>
Commentaires :
* on voit dans cet exemple, en avant dernière lignes, on a : $apiUrl."orders/".$newCommandeResult."/validate". 
$newCommandeResult est l'id de la commande crée (récupéré dans l'exemple précédent)

<source lang="php">
// chercher si le client existe dans la base
$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$nom_client."')"
)
), true);
</source>
Commentaires :
* limit => 1 pour ne renvoyer que 1 client
* mode => 1 car on cherche un client (on aurait aussi pu chercher un fournisseur qui est aussi un tiers mais avec un statut différent)
* sqlfilters syntaxe un peu particulière mais il y a qq autres exemples sur la page d'explorer d'API

<source lang="php">
//client n'existe pas. le crée puis on récupère son id
$newClient = [
"name" => "nom société client",
"email" => "email société client",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</source>
Commentaires :
* client => 1 car c'est un client (et pas un fournisseur)
* code_client => -1 pour que le code client soit généré automatiquement.
* on récupère l'id du client dans $clientDoliId

= Développer un nouveau service / sa propre API =

Ajouter un nouveau service est aussi facile qu'ajouter un fichier nommé '''api_monmoduleobject.class.php''' dans le dossier '''htdocs/monmodule/class'''.
Si vous utilisez le "modulebuilder" pour développer sur Dolibarr, cette API avec les méthode CRUD pourra même être générée pour vous.
Sinon, un copié-collé d'un fichier API existant fera l'affaire. Vous pouvez prendre comme exemple le fichier dans '''htdocs/commande/class/api_orders.class.php''' et l'adapter à votre classe / besoin.

Le framework détecte automatiquement les API et elle devrait être visible dans l'explorateur.

Les méthodes et paramètres sont détectées en fonction de l'introspection réalisée dans les classes PHP de l'objet ('''htdocs/monmodule/class/object.class.php''') en utilisant les '''annotations''' trouvées dans la classe.

Pour une documentation à propos des annotations : https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

Vous trouverez pas mal d'autres informations dans le code de Dolibarr, en regardant dans '''htdocs/<dossier>/class/api_xxx_class.php''' 
Ex pour les tiers: htdocs/societe/class/api_thirdparties.class.php pour les tiers. 
Ex pour les factures: htdocs/compta/facture/class/api_invoices.class.php 
...

= Vidéos sur le sujet (documentation utilisateurs) =
<youtube width="200" height="180">WHV22L8enWw</youtube>
<youtube width="200" height="180">RPUcoweeuR8</youtube>

(Si un contributeur avec les droits nécessaires peut créer la page pour les utilisateurs de ce module, je transférerai les vidéos)

Module Web Services API REST (développeur)

2023-01-24T08:35:19Z

Techsc: /* Vidéos sur le sujet (documentation utilisateurs) */ Ajout vidéo par TechSC

[[en:Module_Web_Services_API_REST_(developer)]]


{{TemplateDocDevFr}}
{{TemplateModFR}}
[[Category:Liste des Modules (développeur)]]
{{BasculeDevUser|
nom=Web services|
num=2610|
devdoc=Cette page|
userdoc=Non applicable|}}

= Fonction =
Quand ce module est activé, vous activez l'utilisation des Webservices fournis par Dolibarr. Vous pouvez alors faire des appels REST sur différents Webservices fournis par Dolibarr.

= Installation =

Pour l'installer, ouvrez la page des modules et activez le module "API REST".

Une fois que le module Web services REST est activé, Dolibarr devient également un serveur de Web services REST. Vous pouvez alors envoyer vos propres requêtes sur l'url relative :
'''/api/index.php/xxx''' où xxx est l'API à appeler.

= Liste des services fournis =
Seuls quelques services sont disponibles. À compter de la version 5.0 de Dolibarr, vous pouvez consulter la liste complète des web services proposés en appelant l'explorer à cette adresse :

'''http://yourdolibarrurl/api/index.php/explorer'''.

Par exemple, vous pouvez essayer l'explorateur sur l'instance de démonstration à l'adresse suivante :

'''https://demo.dolibarr.org/api/index.php/explorer'''

Dans le coin supérieur droit, collez le <token> de l'utilisateur que vous souhaitez utiliser pour appeler l'API, puis cliquez sur le bouton "explorer". Remarque: Le jeton de chaque utilisateur peut être défini sur la page d'enregistrement de l'utilisateur.

Vous pouvez aussi préférer faire un premier appel au service '''login''' pour obtenir le jeton API. Vous aurez en réponse le jeton à utiliser pour obtenir et appeler la liste des services proposés.

Après avoir saisi le jeton et cliqué sur "Explore", vous devriez voir toutes les actions disponibles avec ce jeton. Si vous n'avez pas beaucoup d'actions, c'est probablement parce que les modules correspondants ne sont pas activés. Si vous voulez voir les factures, vous devez activer le module Factures dans la configuration de Dolibarr. Même chose pour les Produits, les Tiers, etc.

Vous pouvez ensuite tester directement à partir de cet explorateur n'importe quelle API. Ceci est la solution recommandée pour tester toute API Dolibarr, car toutes les API et paramètres sont documentés ici. À la suite d'un test, vous obtiendrez la réponse, mais également un exemple sur la façon d'appeler l'API à partir de la ligne de commande à l'aide de curl.

Sur cette page d'exploration de l'API, vous pouvez faire beaucoup de tests. Lire des données de Dolibarr et écrire, modifier et supprimer également. Attention: les données sont vraiment modifiées dans votre base de données.

= Utilisation =

Grosso modo, pour utiliser REST, il faut appeler une url du genre suivant <nowiki>http://<mon_serveur>/api/index.php/<action></nowiki> 
avec une des 4 méthodes : GET, POST, PUT, DELETE, en remplaçant <action> par l'action sur laquelle vous voulez intervenir. Ex : <nowiki>http://<mon_serveur>/api/index.php/invoices</nowiki>

Avant d'utiliser une API, vous devez d'abord obtenir une clé API personnalisée. Vous devez créer un nouvel utilisateur et générer ou définir sa "clé pour l'API".

[[File:Dolibarr user for api.png|400px]]

Vous devrez utiliser cette clé API dans n'importe lequel de vos programmes clients devant appeler une API Dolibarr.

Pour ce faire, il existe plusieurs méthodes. Voici un morceau de code opérationnel pour appeler une API, mais il existe également des librairies qui simplifie le travail, telles que phphttpclient.com.

<source lang="php">
function CallAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}
</source>

Ce n'est qu'un exemple, ce n'est pas sécurisé, cela ne prend pas en compte les codes erreurs mais vous pouvez le modifier et l'adapter à vos besoins.
la fonction prend 4 paramètres :
* $method : string "GET", "POST", "PUT", "DELETE"
* $apikey : string "votre <token> généré plus haut"
* $url : string l'url à appeler. Ex : "<nowiki>http://<mon_serveur>/api/index.php/invoices</nowiki>"
* $data : string flux au format json. Ce champ est requis pour les appels POST ou PUT.

= Exemples avec PHP =

Maintenant, quelques exemples opérationnels pour différents cas d'utilisation. 

Dans tous les cas, on a :
* $apiKey = "<mon token>";
* $apiUrl = "<nowiki>http://<mon_serveur>/api/index.php/</nowiki>";

<source lang="php">
// Récupérer la liste des produits
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</source>
Commentaires :
* récupérer les 10'000 premiers produits triés par leur id dans la base
* html_entity_decode est nécessaire car les apostrophes sont encodés
* il est facile d'utiliser la même méthode (en remplaçant products par dictionnarycountries) pour récupérer la liste des pays

<source lang="php">
// Créer un produit
$ref = "ma_reference_produit_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</source>
Commentaires :
* avant de créer un produit, il peut être sage de vérifier qu'il existe. En reprenant le premier exemple, cela fait :

<source lang="php">
// ma référence
$ref = "ma_reference_produit_X203ZZ";
// existe-t-elle dans mon tableau
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// oui
$fk_product = $produitKey;
} else {
// non
// Créer un produit
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// il y a eu une erreur
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// tout va bien
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</source>
Commentaires :
* je regarde si la référence de mon article existe dans le tableau créé dans le premier exemple.
* si elle existe, j'utilise sa clé dans le tableau comme id
* si elle n'existe pas, je crée l'article puis le j'ajoute à mon tableau pour les prochaines fois et je récupère l'id créé
* cette méthode permet de limiter les appels API quand on doit importer 500 commandes par exemple. Récupérer une fois la liste des produits au début au lieu de chercher à chaque fois dans Dolibarr.

<source lang="php">
// créer une commande avec 2 articles

// le tableau qui contiendra toutes les lignes d'articles de la commande
$newCommandeLine = [];

// article 1
$ref1 = "ma_reference_produit_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// article 2
$ref2 = "ma_reference_produit_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "Commande importée automatiquement depuis l'application",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</source>
Commentaires :
* $clientDoliId vaut l'id du client dans la base doli. Soit vous le connaissez, soit vous pouvez le chercher auparavant
* type => 0, c'est une commande client (par opposition à 1 = commande fournisseur)

<source lang="php">
// Valider une commande
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);
</source>
Commentaires :
* on voit dans cet exemple, en avant dernière lignes, on a : $apiUrl."orders/".$newCommandeResult."/validate". 
$newCommandeResult est l'id de la commande crée (récupéré dans l'exemple précédent)

<source lang="php">
// chercher si le client existe dans la base
$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$nom_client."')"
)
), true);
</source>
Commentaires :
* limit => 1 pour ne renvoyer que 1 client
* mode => 1 car on cherche un client (on aurait aussi pu chercher un fournisseur qui est aussi un tiers mais avec un statut différent)
* sqlfilters syntaxe un peu particulière mais il y a qq autres exemples sur la page d'explorer d'API

<source lang="php">
//client n'existe pas. le crée puis on récupère son id
$newClient = [
"name" => "nom société client",
"email" => "email société client",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</source>
Commentaires :
* client => 1 car c'est un client (et pas un fournisseur)
* code_client => -1 pour que le code client soit généré automatiquement.
* on récupère l'id du client dans $clientDoliId

= Développer un nouveau service / sa propre API =

Ajouter un nouveau service est aussi facile qu'ajouter un fichier nommé '''api_monmoduleobject.class.php''' dans le dossier '''htdocs/monmodule/class'''.
Si vous utilisez le "modulebuilder" pour développer sur Dolibarr, cette API avec les méthode CRUD pourra même être générée pour vous.
Sinon, un copié-collé d'un fichier API existant fera l'affaire. Vous pouvez prendre comme exemple le fichier dans '''htdocs/commande/class/api_orders.class.php''' et l'adapter à votre classe / besoin.

Le framework détecte automatiquement les API et elle devrait être visible dans l'explorateur.

Les méthodes et paramètres sont détectées en fonction de l'introspection réalisée dans les classes PHP de l'objet ('''htdocs/monmodule/class/object.class.php''') en utilisant les '''annotations''' trouvées dans la classe.

Pour une documentation à propos des annotations : https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

Vous trouverez pas mal d'autres informations dans le code de Dolibarr, en regardant dans '''htdocs/<dossier>/class/api_xxx_class.php''' 
Ex pour les tiers: htdocs/societe/class/api_thirdparties.class.php pour les tiers. 
Ex pour les factures: htdocs/compta/facture/class/api_invoices.class.php 
...

= Vidéos sur le sujet (documentation utilisateurs) =
<youtube width="200" height="180">WHV22L8enWw</youtube>

<youtube width="200" height="180">RPUcoweeuR8</youtube>

(Si un contributeur avec les droits nécessaires peut créer la page pour les utilisateurs de ce module, je transférerai les vidéos)

Module Web Services API REST (développeur)

2023-01-19T15:45:31Z

Techsc: Ajout de vidéo par TechSC (si un contributeur peut créer la page utilisateur, je n'ai pas les droits)

[[en:Module_Web_Services_API_REST_(developer)]]


{{TemplateDocDevFr}}
{{TemplateModFR}}
[[Category:Liste des Modules (développeur)]]
{{BasculeDevUser|
nom=Web services|
num=2610|
devdoc=Cette page|
userdoc=Non applicable|}}

= Fonction =
Quand ce module est activé, vous activez l'utilisation des Webservices fournis par Dolibarr. Vous pouvez alors faire des appels REST sur différents Webservices fournis par Dolibarr.

= Installation =

Pour l'installer, ouvrez la page des modules et activez le module "API REST".

Une fois que le module Web services REST est activé, Dolibarr devient également un serveur de Web services REST. Vous pouvez alors envoyer vos propres requêtes sur l'url relative :
'''/api/index.php/xxx''' où xxx est l'API à appeler.

= Liste des services fournis =
Seuls quelques services sont disponibles. À compter de la version 5.0 de Dolibarr, vous pouvez consulter la liste complète des web services proposés en appelant l'explorer à cette adresse :

'''http://yourdolibarrurl/api/index.php/explorer'''.

Par exemple, vous pouvez essayer l'explorateur sur l'instance de démonstration à l'adresse suivante :

'''https://demo.dolibarr.org/api/index.php/explorer'''

Dans le coin supérieur droit, collez le <token> de l'utilisateur que vous souhaitez utiliser pour appeler l'API, puis cliquez sur le bouton "explorer". Remarque: Le jeton de chaque utilisateur peut être défini sur la page d'enregistrement de l'utilisateur.

Vous pouvez aussi préférer faire un premier appel au service '''login''' pour obtenir le jeton API. Vous aurez en réponse le jeton à utiliser pour obtenir et appeler la liste des services proposés.

Après avoir saisi le jeton et cliqué sur "Explore", vous devriez voir toutes les actions disponibles avec ce jeton. Si vous n'avez pas beaucoup d'actions, c'est probablement parce que les modules correspondants ne sont pas activés. Si vous voulez voir les factures, vous devez activer le module Factures dans la configuration de Dolibarr. Même chose pour les Produits, les Tiers, etc.

Vous pouvez ensuite tester directement à partir de cet explorateur n'importe quelle API. Ceci est la solution recommandée pour tester toute API Dolibarr, car toutes les API et paramètres sont documentés ici. À la suite d'un test, vous obtiendrez la réponse, mais également un exemple sur la façon d'appeler l'API à partir de la ligne de commande à l'aide de curl.

Sur cette page d'exploration de l'API, vous pouvez faire beaucoup de tests. Lire des données de Dolibarr et écrire, modifier et supprimer également. Attention: les données sont vraiment modifiées dans votre base de données.

= Utilisation =

Grosso modo, pour utiliser REST, il faut appeler une url du genre suivant <nowiki>http://<mon_serveur>/api/index.php/<action></nowiki> 
avec une des 4 méthodes : GET, POST, PUT, DELETE, en remplaçant <action> par l'action sur laquelle vous voulez intervenir. Ex : <nowiki>http://<mon_serveur>/api/index.php/invoices</nowiki>

Avant d'utiliser une API, vous devez d'abord obtenir une clé API personnalisée. Vous devez créer un nouvel utilisateur et générer ou définir sa "clé pour l'API".

[[File:Dolibarr user for api.png|400px]]

Vous devrez utiliser cette clé API dans n'importe lequel de vos programmes clients devant appeler une API Dolibarr.

Pour ce faire, il existe plusieurs méthodes. Voici un morceau de code opérationnel pour appeler une API, mais il existe également des librairies qui simplifie le travail, telles que phphttpclient.com.

<source lang="php">
function CallAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}
</source>

Ce n'est qu'un exemple, ce n'est pas sécurisé, cela ne prend pas en compte les codes erreurs mais vous pouvez le modifier et l'adapter à vos besoins.
la fonction prend 4 paramètres :
* $method : string "GET", "POST", "PUT", "DELETE"
* $apikey : string "votre <token> généré plus haut"
* $url : string l'url à appeler. Ex : "<nowiki>http://<mon_serveur>/api/index.php/invoices</nowiki>"
* $data : string flux au format json. Ce champ est requis pour les appels POST ou PUT.

= Exemples avec PHP =

Maintenant, quelques exemples opérationnels pour différents cas d'utilisation. 

Dans tous les cas, on a :
* $apiKey = "<mon token>";
* $apiUrl = "<nowiki>http://<mon_serveur>/api/index.php/</nowiki>";

<source lang="php">
// Récupérer la liste des produits
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</source>
Commentaires :
* récupérer les 10'000 premiers produits triés par leur id dans la base
* html_entity_decode est nécessaire car les apostrophes sont encodés
* il est facile d'utiliser la même méthode (en remplaçant products par dictionnarycountries) pour récupérer la liste des pays

<source lang="php">
// Créer un produit
$ref = "ma_reference_produit_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</source>
Commentaires :
* avant de créer un produit, il peut être sage de vérifier qu'il existe. En reprenant le premier exemple, cela fait :

<source lang="php">
// ma référence
$ref = "ma_reference_produit_X203ZZ";
// existe-t-elle dans mon tableau
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// oui
$fk_product = $produitKey;
} else {
// non
// Créer un produit
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// il y a eu une erreur
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// tout va bien
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</source>
Commentaires :
* je regarde si la référence de mon article existe dans le tableau créé dans le premier exemple.
* si elle existe, j'utilise sa clé dans le tableau comme id
* si elle n'existe pas, je crée l'article puis le j'ajoute à mon tableau pour les prochaines fois et je récupère l'id créé
* cette méthode permet de limiter les appels API quand on doit importer 500 commandes par exemple. Récupérer une fois la liste des produits au début au lieu de chercher à chaque fois dans Dolibarr.

<source lang="php">
// créer une commande avec 2 articles

// le tableau qui contiendra toutes les lignes d'articles de la commande
$newCommandeLine = [];

// article 1
$ref1 = "ma_reference_produit_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// article 2
$ref2 = "ma_reference_produit_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "Commande importée automatiquement depuis l'application",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</source>
Commentaires :
* $clientDoliId vaut l'id du client dans la base doli. Soit vous le connaissez, soit vous pouvez le chercher auparavant
* type => 0, c'est une commande client (par opposition à 1 = commande fournisseur)

<source lang="php">
// Valider une commande
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);
</source>
Commentaires :
* on voit dans cet exemple, en avant dernière lignes, on a : $apiUrl."orders/".$newCommandeResult."/validate". 
$newCommandeResult est l'id de la commande crée (récupéré dans l'exemple précédent)

<source lang="php">
// chercher si le client existe dans la base
$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$nom_client."')"
)
), true);
</source>
Commentaires :
* limit => 1 pour ne renvoyer que 1 client
* mode => 1 car on cherche un client (on aurait aussi pu chercher un fournisseur qui est aussi un tiers mais avec un statut différent)
* sqlfilters syntaxe un peu particulière mais il y a qq autres exemples sur la page d'explorer d'API

<source lang="php">
//client n'existe pas. le crée puis on récupère son id
$newClient = [
"name" => "nom société client",
"email" => "email société client",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</source>
Commentaires :
* client => 1 car c'est un client (et pas un fournisseur)
* code_client => -1 pour que le code client soit généré automatiquement.
* on récupère l'id du client dans $clientDoliId

= Développer un nouveau service / sa propre API =

Ajouter un nouveau service est aussi facile qu'ajouter un fichier nommé '''api_monmoduleobject.class.php''' dans le dossier '''htdocs/monmodule/class'''.
Si vous utilisez le "modulebuilder" pour développer sur Dolibarr, cette API avec les méthode CRUD pourra même être générée pour vous.
Sinon, un copié-collé d'un fichier API existant fera l'affaire. Vous pouvez prendre comme exemple le fichier dans '''htdocs/commande/class/api_orders.class.php''' et l'adapter à votre classe / besoin.

Le framework détecte automatiquement les API et elle devrait être visible dans l'explorateur.

Les méthodes et paramètres sont détectées en fonction de l'introspection réalisée dans les classes PHP de l'objet ('''htdocs/monmodule/class/object.class.php''') en utilisant les '''annotations''' trouvées dans la classe.

Pour une documentation à propos des annotations : https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

Vous trouverez pas mal d'autres informations dans le code de Dolibarr, en regardant dans '''htdocs/<dossier>/class/api_xxx_class.php''' 
Ex pour les tiers: htdocs/societe/class/api_thirdparties.class.php pour les tiers. 
Ex pour les factures: htdocs/compta/facture/class/api_invoices.class.php 
...

= Vidéos sur le sujet (documentation utilisateurs) =
<youtube width="200" height="180">WHV22L8enWw</youtube>

(Si un contributeur avec les droits nécessaires peut créer la page pour les utilisateurs de ce module, je transférerai les vidéos)

Módulo Terceros

2022-10-30T08:35:35Z

Techsc: /* Videos */ Révision de la taille des vidéos

[[en:Module_Third_Parties]]
[[fr:Module_Tiers]]
[[de:Modul_Partner]]
[[pt:Módulo_Terceiros]]
[[zh:合伙人模块]]


[[Category:Empresas]]
{{TemplateDocUsuario}}
{{TemplateModES}}
{{BasculeDevUsuario|
nom=Terceros|
num=1|
devdoc=[[Módulo Terceros (desarrollador)]]|
userdoc=Esta página|}}

= Introducción =
El módulo Terceros permite gestionar clientes, clientes potenciales y/o proveedores.

Se trata de un requisito esencial para muchos otros [[Primeras_configuraciones#Módulos|módulos]] que se basan en estos conceptos (facturas, pedidos, contratos, presupuestos, etc...).

También puede crear de 1 a varios Contactos dentro de la Empresa (necesarios para poder crear y tener un seguimiendo de un [[Presupuestos|presupuesto]] o una [[Facturas_a_clientes|factura]]).

Una empresa es una entidad comercial: cliente, proveedor o cliente potencial (Ejemplo: Una SL, una asociación, un particular).

El contacto, a su vez, representa a un individuo o una persona de contacto genérico (por ejemplo, director general o trabajador de la empresa, comercial, presidente o tesorero de la asociación, o un particular).

Dolibarr gestiona de la misma manera los individuos y los negocios.Tambien a los particulares, que suelen tener un "contacto", que contiene las mismas características que el objeto "Empresa".

= Instalación =
{{NoInstallModuleEs}}

= Configuración =
{{ActivationModuleEs}}
La descripción de la configuración del módulo está disponible en la página [[Configuración del módulo terceros]]

= Crear una nueva empresa =
Ir a Clientes - Nuevo Cliente o Cliente Potencial - Nuevo cliente potencial o proveedor - Nuevo proveedor. Escriba la información solicitada (no es necesario que rellene todos los campos).

Una vez que la nueva empresa esté creada, puede agregar notas en la ficha, y adjuntar documentos relacionados.

= Modificar una empresa =
Ir al menú de Empresas, haga clic en la empresa a modificar y seleccione la pestaña ficha.

Haga clic en "Modificar" (abajo a la derecha).

Introduzca los cambios.

Haga clic en "Grabar".

= Eliminar una empresa =
Ir a la ficha de la empresa y haga clic en "Eliminar".
Sólo una empresa que no tenga objetos por cobrar (facturas, contratos, pedidos, etc) puede ser borrada.

= Crear un contacto =
Existen varias posibilidades de creación de contactos:
*Ir al menú Terceros - Contactos - Nuevo Contacto. Escriba la información solicitada (no es necesario que rellene todos los campos). De esta forma creará un contacto que puede no estar vinculado a un tercero.

*Desde un Tercero, ir a la pestaña cliente o proveedor y hacer clic en "Crear contacto". Escriba la información solicitada (no es necesario que rellene todos los campos). Así creará un contacto vinculado a un tercero.

= Modificar un contacto =
Ir al menú de Terceros - Contactos - Listado, haga clic en el contacto a modificar y seleccione la pestaña ficha o información personal.

Haga clic en "Modificar" (abajo a la derecha).

Introduzca los cambios.

Haga clic en "Grabar".

= Eliminar un contacto =
Vaya a la ficha del contacto y haga clic en "Eliminar"

= Ciclo de vida / Reglas de gestión =
Una empresa sólo puede tener una condición: Existe o no.
Una empresa eliminada no cambia el estado, sino que desaparece por completo de Dolibarr.

Puede crear de 1 a varios Contactos físicos en la empresa (serán utlizados como destinatarios de los envíos de e-mail de los [[Módulo Presupuestos| presupuestos]], [[Módulo_Pedidos_de_clientes|pedidos de clientes]] o de [[Módulo_Facturas_a_clientes|facturas a clientes]]...).

= Videos =
<youtube width="280">vH03SiSy0eI</youtube>

Los tercios:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">eJUJUPDCOh8</youtube>

Los contactos:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">B3lYZgc5KAE</youtube>

Los prospectos:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">L1qAVRXjAXE</youtube>

Los clientes:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">49VOibps4Vw</youtube>

Los proveedores:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">HNstNg_AxHM</youtube>

Module Third Parties

2022-10-30T08:34:36Z

Techsc: /* Related videos */ Révision de la taille des vidéos

[[fr:Module_Tiers]]
[[es:Módulo_Terceros]]
[[de:Modul_Partner]]
[[pt:Módulo_Terceiros]]
[[zh:合伙人模块]]


[[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 prerequisite for many other modules that are based on these concepts (invoices, orders, contracts, proposals, etc. ...).

A Third Party means any customer, prospect or supplier. These can be a corporation/business entity (e.g.: an LLC, a trade association etc.) or an individual person.
A contact, on the other hand, is an individual: a representative of the business entity (e.g. the CEO or any other person of an LLC, the sales manager of a trade customer, president or treasurer of an association etc.) or a person.

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

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}
A description of the setup of the 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''').
Enter the information, not all fields are mandatory.

Once the Third Party has been created, you can add Notes and add linked files using the 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 to the Third party card and click on the "Delete" button.
If a third party has linked objects (invoices, contracts, orders, etc), it cannot 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 information (you do not have to complete all fields). This will create a contact that cannot 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...).

= Related videos =
<youtube width="280">9ETxdpVsgU0</youtube>

Third parties:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">eJUJUPDCOh8</youtube>

Contacts:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">B3lYZgc5KAE</youtube>

Prospects:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">L1qAVRXjAXE</youtube>

Customer:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">49VOibps4Vw</youtube>

Suppliers:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">HNstNg_AxHM</youtube>

Module Tiers

2022-10-30T08:33:02Z

Techsc: /* Vidéos sur le sujet */ Révision de la taille des vidéos

[[en:Module_Third_Parties]]
[[es:Módulo_Terceros]]
[[de:Modul_Partner]]
[[pt:Módulo_Terceiros]]
[[zh:合伙人模块]]


[[Category:Société]]
{{TemplateDocUserFR}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Tiers|
num=1|
devdoc=[[Module Tiers (développeur)]]|
userdoc=Cette page|}}

=Introduction=
Le module Tiers-Société permet de gérer les entités clients, prospects, partenaires et/ou fournisseurs (appelés Tiers).
Ce module est un pré-requis indispensable pour de nombreux autres [[Premiers paramétrages#Modules|modules]] qui se basent sur ces notions (factures, commandes, contrats, propositions commerciales, etc...).

Une société est donc une entité métier: client, prospect, fournisseur ou simple partenaire (Exemple: Une SARL, un commerce, une association, un particulier).
Le contact quant à lui représente une personne physique ou un contact générique au sein du Tiers (Exemple: PDG ou ouvrier de la SARL, vendeur principal du commerce, président ou trésorier de l'association, service contentieux).

Dolibarr gère de la même manière les tiers particuliers et les entreprises, mais un typage "Type du tiers" pourra être renseigné avec le type "Particulier" si le besoin de faire la distinction est nécessaire, pour une exploitation statistique par exemple.

=Installation=
{{NoInstallModuleFr}}

=Configuration=
{{ActivationModuleFr}}
La description du paramétrage possible du module est disponible sur la page [[Paramétrage du module Tiers]].

=Créer une nouvelle société=

Aller dans le menu Tiers - Nouveau client, ou Prospect - Nouveau prospect, ou encore Fournisseur - Nouveau fournisseur.
Saisissez les informations demandées (vous n'êtes pas obligé de remplir tous les champs) et cliquez sur Créer.

En sélectionnant les options : "Nouveau prospect", "Nouveau Client" ou "Nouveau fournisseur" vous donnez à Dolibarr une indication qui permet de pré-remplir les champs '''Prospect/Client''' et '''Fournisseur Oui/Non'''

- Prospect -> Prospect/Client = '''Prospect''' , Fournisseur = '''non'''

- Client -> Prospect/Client = '''Client ''' , Fournisseur = '''non'''

- Fournisseur -> Prospect/Client = '''Ni client, ni prospect''' , Fournisseur = '''Oui'''

''Comme indiqué dans le paragraphe ''Configuration'', il est possible de générer automatiquement le champ "'''Code client/Fournisseur'''.''
Cela permet une gestion univoque des références fournisseurs/clients/prospects

Une fois la société créée , vous pouvez ajouter des Notes dans l'onglet correspondant, et joindre des documents liés.

=Modifier une société=
Aller dans le menu Société, cliquer sur le nom de la société à modifier.

Cliquer sur le bouton "éditer" (en bas à droite).

Saisir les modifications.

Cliquer sur le bouton "enregistrer".

=Supprimer un Tiers=
Aller sur la fiche du Tiers et cliquer sur le bouton "Supprimer".
Seule une société qui n'a pas d'objets rattachés (factures, contrats, commandes, etc) peut être supprimée.
Si le Tiers a besoin d'être écarté mais ne peut être supprimé, on la placera plutôt au statut "Inactive" plutôt que de la supprimer physiquement.

=Créer un contact-adresse=
Il existe plusieurs possibilités pour créer des contacts-adresses secondaires pour un Tiers (Contact trésorier, Contact facturation, ...)

*Allez dans le menu Tiers - Contacts - Nouveau contact. Entrez les informations demandées (vous n'êtes pas obligé de remplir tous les champs). Cela va créer un contact qui peut ne pas être liée à un tiers.

*Sur un tiers, allez à l'onglet client ou fournisseur et cliquez sur "Créer un Contact". Entrez les informations demandées (vous n'êtes pas obligé de remplir tous les champs). Cela va créer un contact lié à un tiers.

=Modifier un contact=
Aller au menu Tiers - Contact - Liste, cliquez sur le contact à modifier et sélectionnez l'onglet Fiche ou des infos personnelles.

Cliquez sur "Edit" (en bas à droite).

Entrez les modifications.

Cliquez sur "Enregistrer".

=Supprimer un contact/adresse=

Aller au contact et cliquez sur "Supprimer"

=Cycle de vie / Règles de gestion=

Une société n'a que 2 états: Active ou Inactive.
Une société supprimée ne change pas d'état, mais elle disparaît complètement de Dolibarr.

Le Tiers comme les contacts adresses peuvent être importés ou exportés par les [[Module Imports]] et [[Module Exports]].
Ils peuvent être aussi exploités pour les envois d'emails de masse via le module [[Module Mailing]].

Vous pouvez créer 1 à plusieurs Contacts/Adresses à l'intérieur de la Société (ils pourront ensuite être utilisés comme destinataire pour les envois email, par exemple sur les [[Module Propositions commerciales|proposition commerciales]], [[Module Commandes Clients|commandes clients]] ou [[Module Factures Clients|factures clients]]...).

=Vidéos sur le sujet=
<youtube width="280">4Xw-GpRWKMs</youtube>

Les tiers:

<youtube width="200" height="120">eJUJUPDCOh8</youtube>

Les contacts:

<youtube width="200" height="120">B3lYZgc5KAE</youtube>

Les prospects:

<youtube width="200" height="120">L1qAVRXjAXE</youtube>

Les clients:

<youtube width="200" height="120">49VOibps4Vw</youtube>

Les fournisseurs:

<youtube width="200" height="120">HNstNg_AxHM</youtube>

Módulo Agenda

2022-10-30T08:28:32Z

Techsc: /* Videos */ Revision de la taille de la vidéo

[[en:Module_Agenda_En]]
[[fr:Module_Agenda]]
[[de:Modul_Terminplanung]]


[[Category:AgendaEs]]
{{TemplateDocUsuario}}
{{TemplateModES}}
{{BasculeDevUsuario|
nom=Agenda|
num=2400|
devdoc=[[Módulo Agenda (desarrollador)]]|
userdoc=Esta página|}}

= Introducción =
El módulo Agenda permite tener un calendario en Dolibarr y la generación de anotaciones, tales como eventos o tareas.

= Instalación =
{{NoInstallModuleEs}}

= Configuración =
{{ActivationModuleEs}}

Para saber como configura el móduloa para exportar los eventos de la agenda Dolibarr a la agenda de Google, vea [[FAQ Agenda ES]].

= Definiciones =
Antes de seguir adelante en el uso del módulo Agenda es importante comprender los términos de
« Eventos / Tareas / Diario ».
Estos conceptos se confunden a menudo, por lo que es importante familiarizarse con estos términos aceptados en la mayoría de ERP. Para ello, se da una definición en la página [[EventoTareaDiario]]

= Los eventos (event) =

En Dolibarr a los eventos también los llamamos las acciones. Hay acciones automáticas (creadas automáticamente por Dolibarr) y manuales (creada expresamente por el usuario).
Este es el objetivo del módulo Agenda, la gestión de este tipo de eventos

== Los eventos automáticos ==
En el módulo Agenda, podemos configurar los eventos que queremos que se creen automáticamente en el calendario.
Los eventos elegidos (creación de factura, validación de pedido) se guardarán automáticamente en el calendario.
Simbolizan una acción que se ha realizado. Son creados con el estado realizado (porcentaje progreso = 100%).
La duración de estos eventos es normalmente 0 segundos (fecha de finalización = fecha de inicio)

== Los eventos manuales y las citas ==
También podemos crear eventos manualmente a través de los menús de la Agenda
Podemos crear, editar, eliminar un evento (llamado acción en Dolibarr).
Estos eventos tienen una fecha de inicio y fin así como un estado de realización elegido por el usuario que se puede cambiar posteriormente.

=Videos=

Agenda :

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">v_VyYlwhBZQ</youtube>

Module Agenda

2022-10-30T08:28:14Z

Techsc: /* Related videos */ Revision de la taille de la vidéo

[[fr:Module_Agenda]]
[[es:Módulo_Agenda]]
[[de:Modul_Terminplanung]]


[[Category:AgendaEn]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Agenda|
num=2400|
devdoc=[[Module Agenda (developer)]]|
userdoc=This page|}}

= Introduction =
The Agenda Module is a core Dolibarr module. It is optional and part of the Projects/Collaborative work group in module list.

The main purpose of the module is to add a calendar into Dolibarr and manage events.

Current documentation applies to 4.0.2 Dolibarr release.

== Important notice regarding definitions ==

The term '''Events''' is often confused with terms like "Tasks", "Action", "list of Tasks", "Journal".

Before you read this documentation, it is important to know the meanings of each terms which have been defined and normalized by the norm RFC2445.

If you are not familiar with these, read this summary page : [[Events-Todo-Journal]].

== What this module does ==

* Manage a calendar of events (also called Agenda).
* Support day, week, month view for calendar.
* Support displaying other external calendars in agenda using ical URL.
* Support also user and list view of events.
* Allow to define and use types for event categorization.
* Allow to link a project, a third party and a contact to an event.
* Allow to link documents and/or URL to an events.
* If the [[Module_Resources| Resources module]] is activated, you could link resources to an event.
* Support extra fields for event.
* Support the automatic agenda filling by Dolibarr workflow events.
* Support calendar events export using vcal, ical or rss.

== What this module does not ==

* Does not support updating external calendar. (see commercial modules for this).
* Does not support recurring events.

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

To know how to setup the module to export Dolibarr agenda events it into the Google agenda, see [[FAQ Agenda EN]].

= The events (event) =
In Dolibarr, we also call this events the ''actions''. There is some automatic actions (created automatically by Dolibarr) and manual actions (created explicitly by users).
This is the role of Agenda module to manage this kind of events.

== Automatic events ==
We can setup in the Agenda module, which event we want to create automatically into the calendar.
Events chosen (invoice creation, order validation...) are then created automatically into the calendar.
So such events are business actions that has just been done. They are created with status realized (percentage of accomplishment = 100%).
Duration of such events are in general 0 seconds (end date = start date)

== Manual events and rendez-vous ==
You can also create yourself events from Agenda menus.
So you create, modify, delete an event (named ''action'' into Dolibarr).
Such events will have a start date, an end date, an accomplishment percentage, all chosen by user. This properties can also be modified later.

=Related videos=

(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">v_VyYlwhBZQ</youtube>

Module Agenda FR

2022-10-30T08:27:54Z

Techsc: /* Vidéos sur le sujet */ Revision de la taille de la vidéo

[[en:Module_Agenda_En]]
[[es:Módulo_Agenda]]
[[de:Modul_Terminplanung]]


[[Category:Agenda]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Agenda|
num=2400|
devdoc=[[Module Agenda (développeur)]]|
userdoc=Cette page|}}

= Introduction =
Le module Agenda permet de bénéficier d'un calendrier dans Dolibarr et de gérer des notions comme des événements ou rendez-vous.
Ces événements peuvent être enregistrés manuellement ou automatiquement.

= Installation =
{{NoInstallModuleFr}}

= Configuration =
{{ActivationModuleFr}}

Pour savoir comment configurer le module pour exporter l'agenda au sein de l'agenda Google, voir la [[FAQ Agenda]].

= Définitions =
Avant d'aller plus loin sur l'utilisation du module Agenda, il est important de bien comprendre les termes de
« Evénements / Taches / Journaux ».
Ces notions souvent confondues ont des vocations différentes, aussi il est important de se familiariser avec ces termes admis dans la plupart des ERP. Pour cela, une définition est donnée sur la page [[EvenementTacheJournal]]

= Les événements (event) =

Sous Dolibarr, on appelle aussi ces événements, les actions. Il y a les actions automatiques (créés automatiquement par Dolibarr) et les manuelles (crées explicitement par l'utilisateur).
C'est la vocation même du module Agenda que de gérer ce type d'événement.

== Les événements automatiques ==
On configure dans le module Agenda, les événements que l'on veut voir créer automatiquement dans le calendrier.
Les événements choisis (création facture, validation commande) sont alors sauvés dans le calendriers automatiquement.
Ils symbolisent une action métier qui vient d'être réalisé. Ils sont donc crées au statut réalisés (pourcentage avancement = 100%).
La durée de ces événement est en général de 0 secondes (date de fin = date de début)

== Les événements manuels et rendez-vous ==
On peut aussi en créer soi-même manuellement via les menus sous le menu Agenda.
On peut ainsi Créer, Modifier, Supprimer un événement (nommé action dans Dolibarr).
Ces événements auront une date de début, de fin et un état d'avancement choisi par l'utilisateur qui peut être modifié ultérieurement.

=Copie d ecran=

[[File:Agenda_-_2018-.jpg]]

=Vidéos sur le sujet=

<youtube width="200" height="120">v_VyYlwhBZQ</youtube>

Importaciones

2022-10-30T08:26:59Z

Techsc: /* Videos */ Revision de la taille de la vidéo

[[en:Mass_imports]]
[[fr:Imports_de_masse]]
[[zh:批量导入]]
[[ja:一括インポート]]


[[Category:Admin es]]
[[Category:Importaciones]]
{{TemplateDocDesarrollo}}
Tras una nueva instalación de Dolibarr, las bases de datos están vacías. Algunas veces queremos empezar con los datos importados de otro sistema.
Aquí tenemos información para intentar ayudarle. La información relativa a la exportación se describe en la página [[Módulo Exportaciones]].

= [[File:Art.png]] Utilizar el módulo Importación de Dolibarr =
El [[Módulo Importaciones]] se encuentra disponible con la versión 2.7 de Dolibarr.

Para los casos no previstos por este módulo genérico, los otros métodos descritos aquí son igualmente operacionales..

= [[File:OpenOffice.png]] Utilizar OpenOffice =
Puede utilizar OpenOffice, ya que es capaz de insertar el contenido de una tabla en una base de datos Mysql, como la de Dolibarr.
He aquí un tutorial sobre este método : [[Importacion con OpenOffice]]

= [[File:Outils.png]] Desarrollar su própio script de importación =

== Importar terceros y contactos ==
Hay que destinguir entre los terceros de los contactos físicos.
Como terceros estarán todas las entidades sujetas a facturación (indistintamente sean empresas, asociaciones o particulares). Los terceros son obligatorios
Los contactos físicos son opcionales.
Esto es sólo un directorio de personas (con teléfono y función) en relación con un tercero. En el caso de un tercero como empresa, puede haber más de un contacto físico. En el caso de una persona, el contacto físico será único e idéntico al tercero (el contacto físico no se rellenará).

La importación de los terceros consiste en insertar las líneas en la tabla [[Table llx_societe]].
Hay que asegurarse que los campos importantes son bien rellenados:
* Nom: Debe contener el nombre de la empresa
* Client: Debe contener 1 si es cliente, 2 si es cliente potencial, 0 si no es nada
* Fournisseur: Debe contener 1 si es proveedor, 0 si no lo és

La importación de los contactos físicos consiste en insertar las líneas en la tabla [[Table llx_socpeople]].
Hay que asegurarse que los campos importantes son bien rellenados:
* Name: Debe contener el apellido de la persona
* Firstname: Debe de contener el nombre de la persona
* fk_soc: Debe de contener el ID del tercero de la tabla [[Table llx_societe]].

== Importación de facturas ==
A completar

== Puesta en práctica ==
La página [[Desarrollo de scripts]] explica como se pueden crear sus própios scripts para Dolibarr.

== Algunos tutoriales/ejemplos enviados por la comunidad ==
Los scripts de ejemplo se encuentran disponibles con la distribución snapshot de Dolibarr, en la carpeta '''/dev/samples'''.

Otros ejemplos enviados por los colaboradores:
*[[Importación de clientes automática]]
*...

=Videos=

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">WAv9wHIjy9c</youtube>

Mass imports - Migrate my Data To Dolibarr

2022-10-30T08:26:47Z

Techsc: /* Related video */ Revision de la taille de la vidéo

[[fr:Imports_de_masse]]
[[es:Importaciones]]
[[zh:批量导入]]
[[ja:一括インポート]]


[[Category:Admin_en]]
[[Category:ImportsEn]]
{{TemplateDocDevEn}}

Following a new installation of Dolibarr, the database is empty. It is a common requirement to import existing data (suppliers, customers, products etc.) instead of entering the data manually.
There are several possible methods of importing data. The following chapters provide information about this.
Information about exporting data is described on the page [[Module Exports En|Module Exports]].

= [[File:Art.png]] Using the Dolibarr Import Module=
The recommended method for importing data is to use the Dolibarr [[Module Imports En|Module Imports]]. You will find a wizard that will guide you step by step in importing your data. You'll find more information on the page [[Module Imports En|Module Imports]].

For import scenarios not covered by the built-in module, the following alternatives are also possible.

= [[File:OpenOffice.png]] Using OpenOffice =
You can use OpenOffice, which is able to insert the contents of a table into a database such as Mysql Dolibarr. Here is a tutorial on this method: [[Import data with OpenOffice]]

= [[File:Outils.png]] Developing your own import script =

== Import third parties and contacts ==
We must differentiate a third party from a physical contact (person).
The third party information contains all the details pertaining to billing (whether companies, private individuals or associations).
Third party details are compulsory whereas physical contact details are optional.
Contacts are just a directory of physical persons/addresses related to the third party.
In the case of a third party that is a company, there may be several additional physical contacts.
In the case of an individual, there will be only one physical contact which would be identical to the third party.

The import of the third parties inserts rows in the table [[Table llx_societe]]. Ensure that the mandatory fields contain data.

* Name: Must contain the name of the company
* Client: Must contain 1 if third party is a client, 2 if prospect, 0 otherwise.
* Supplier: Must contain 1 if its a supplier, 0 otherwise

The import of physical contacts inserts rows in the table [[Table llx_socpeople]]. Ensure that the mandatory fields contain data.

* Name: Must contain the surname of the contact
* Firstname: Must contain the first name of the contact
* fk_soc: Must contain the id of the third party from table [[Table llx_societe]].

== Import invoices ==
To complete...

== Import products ==
To complete...

== Put into practice ==
Page [[Script development]] explains how to create your own Dolibarr script.

== Some tutorials / examples submitted by the community ==
Some scripts examples are available into Dolibarr snapshot distribution in directory '''/dev/examples'''.

Other examples are provided by contributors:
* [[Importing customers automatically]]
* ...

=Related video=
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">WAv9wHIjy9c</youtube>

Imports de masse - Migrer mes données dans Dolibarr

2022-10-30T08:26:29Z

Techsc: /* Vidéos sur le sujet */ Revision de la taille de la vidéo

[[en:Mass_imports]]
[[es:Importaciones]]
[[zh:批量导入]]
[[ja:一括インポート]]


[[Category:Admin fr]]
[[Category:Imports]]
{{TemplateDocDev}}
Suite à une installation neuve de Dolibarr, les bases sont vides. Parfois on désire démarrer avec des données importées d'un autre système.
Il existe plusieurs méthodes possibles. Les chapitres suivante présentes quelques informations pour vous y aider. Les informations sur l'export sont décrites sur la page [[Module Exports]].
Attention, si l'objectif est d'importer depuis une autre base Dolibarr, ce n'est pas l'import/export de masse qu'il faut utiliser (dédiés aux imports/exports avec d'autres systèmes), mais les procédures de [[Sauvegardes]] et [[Restaurations]].

= [[File:Art.png]] Utiliser le module Import de Dolibarr =
La méthode recommandée pour vos imports est l'utilisation du [[Module Imports]] de Dolibarr. Elle offre un assistant qui vous guide dans les différentes étapes. Voir la page [[Module Imports]] pour plus d'informations.

Pour les cas non prévus par ce module générique, les autres méthodes décrites ci-dessous sont également opérationnelles.

= [[File:OpenOffice.png]] Utiliser OpenOffice =
Vous pouvez utiliser OpenOffice qui est capable d'injecter le contenu d'un tableau dans la base une base de donnée Mysql comme celle de Dolibarr.
Voici un tutorial sur cette méthode : [[Importer des données avec OpenOffice]]

= [[File:Outils.png]] Développer son propre script d'import =

== Import des tiers et contacts ==
Il faut distinguer les tiers des contacts physiques.
Dans les tiers on aura toutes les entités sujettes à facturation (aussi bien entreprises, association que particuliers). Les tiers sont obligatoires.
Les contacts physiques sont optionnels. Il s'agit juste d'un annuaire de personnes (avec téléphone et fonction) liées à un tiers. Dans le cas d'un tiers entreprise, il pourra y avoir plusieurs contacts physiques. Dans le cas d'un particulier, le contact physique sera unique et identique au tiers (voire le contact physique ne sera pas renseigné).

L'import des tiers consiste à insérer des lignes dans la table [[Table llx_societe]].
S'assurer que les champs importants sont bien renseignés:
* Nom: Doit contenir le nom de la société
* Client: Doit contenir 1 si client, 2 si prospect, 3 si prospect+client, 0 sinon
* Fournisseur: Doit contenir 1 si fournisseur, 0 sinon

L'import des contacts physiques consiste à insérer des lignes dans la table [[Table llx_socpeople]].
S'assurer que les champs importants sont bien renseignés:
* Name: Doit contenir le nom de la personne
* Firstname: Doit contenir le prénom de la société
* fk_soc: Doit contenir l'id de la ligne Tiers dans la [[Table llx_societe]].

== Import des factures ==
A compléter

== Import des produits ou services ==
L'import des tiers consiste à insérer des lignes dans la table [[Table llx_product]].
S'assurer que les champs importants sont bien renseignés:
* Ref: Doit contenir la référence courte du produit
* Nom: Doit contenir le libellé du produit
* Type: Doit contenir 0 pour un produit, 1 pour un service

== Mise en pratique ==
La page [[Développement de scripts]] vous explique comment créer votre propre script de traitement Dolibarr.

== Quelques didacticiels/exemples soumis par la communauté ==
Des scripts exemples sont disponibles avec la distribution snapshot de Dolibarr dans le répertoire '''/dev/samples'''.

D'autres exemples sont soumis par des contributeurs:
* [[Importer des clients en automatique]]
* ...

=Vidéos sur le sujet=

<youtube width="200" height="120">WAv9wHIjy9c</youtube>

Módulo Exportaciones

2022-10-30T08:25:53Z

Techsc: /* Videos */ Revision de la taille de la vidéo

[[en:Module_Exports_En]]
[[fr:Module_Exports]]


[[Category:Admin es]]
[[Category:Exportaciones]]
{{TemplateDocUsuario}}
{{TemplateModES}}
{{BasculeDevUsuario|
nom=Exportaciones|
num=240|
devdoc=Esta página|
userdoc=Esta página}}

= Introducción =
Para exportar los datos de Dolibarr, existen varios métodos que vamos a describir. Los métodos de importación se describen en la página [[Importaciones]]

= Instalación =
{{NoInstallModuleEs}}

= Configuración =
{{ActivationModuleEs}}

= Uso =
# El primer paso consiste en seleccionar uno de los lotes de datos predefinidos
# Seguidamente seleccionar los campos que desee insertar en el fichero resultanto, y en que orden.
# Una vez los datos hayan sido seleccionados, es posible elegir el formato del archivo de exportación a generar y haga clic en el botón Generar.
# Después de unos momentos, el archivo está disponible para su descarga.
Los formatos disponibles son CSV o TSV (archivo de texto) o XLS (formato Excel nativo)

= [[File:Outils.png]] Desarrollar su propio script de exportación =
No importa que lenguaje utilize para realizar la tarea en el momento que se pueda leer la base de datos.
Solamente tiene que leer la tabla de la entidad que le interese y crear un fichero de exportación en el formato que desee a partir de los datos de esa tabla.
El único requisito es conocer la tabla que contiene los datos que le interesen.
Para ayudarle, la página [[:Category:Table SQL|Table SQL]] le muestra la lista de tablas de Dolibarr

Las versiones posteriores a la 2.6 permiten a los usuarios "admin" visualizar el código SQL correspondientes a las consultas generadas con la ayuda del asistente de exportación.

=Videos=

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">dc8wfS6VoZ0</youtube>

Module Exports En

2022-10-30T08:25:34Z

Techsc: /* Related videos */ Revision de la taille de la vidéo

[[fr:Module_Exports]]
[[es:Módulo_Exportaciones]]


[[Category:Admin_en]]
[[Category:ExportsEn]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Exports|
num=240|
devdoc=This page|
userdoc=This page}}

= Introduction =
To export Dolibarr data, use the Export module.
Bulk imports are described in the page [[Mass imports]].

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

= Usage =
# Go to Menu-> Tools -> New Export and choose a predefined dataset.
# Choose a predefined (by you) export profile or manually choose the fields you want to include in the export file.
# Add any filters you may wish to place on the values of those fields.
# Change the position/column of the fields in the export file. You may save the selections you have made as an export profile/template for future use.
# Choose a format for the export file from the dropdown list. Possible formats are CSV / TSV (Text files) or XLS 2007 / 95 (native Excel files). Click on Generate.
After few seconds, a link to the file is shown for download.

= [[File:Outils.png]] Develop your own export script =
If there is no predefined dataset that matches your needes and you have program knowledge, you can also develop your own script.
Any language can be used if this language can read a database.
You just have to read the table of the entity you want to export and build a file, using the format of your choice, from any fields available in table.
The only thing to know is which table contains data you want to export.
To help you, the page [[:Category:Table SQL|Table SQL]] lists all the tables used in Dolibarr.

Note that versions above 2.6 allow "admin" users to see the SQL code that was used to build the export file content when using the Export module. This is shown at the moment of file generation.

=Related videos=
Export:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">dc8wfS6VoZ0</youtube>

Module Exports

2022-10-30T08:25:17Z

Techsc: /* Vidéos sur le sujet */ Revision de la taille de la vidéo

[[en:Module_Exports_En]]
[[es:Módulo_Exportaciones]]


[[Category:Admin_fr]]
[[Category:Exports]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Exports|
num=240|
devdoc=Cette page|
userdoc=Cette page}}

= Introduction =
Pour exporter les données de Dolibarr, il existe plusieurs méthode décrites ci-dessous. Cette page décrit la méthode utilisant le module d'export.
Les méthodes d'imports sont décrites sur la page [[Imports de masse]]

= Installation =
{{NoInstallModuleFr}}

= Configuration =
{{ActivationModuleFr}}

= Utilisation =
# Allez dans le menu Outils - Export et choisissez un des lots de données prédéfinis.
# Ensuite choisissez les champs que vous voulez dans votre fichier résultat, et dans quel ordre.
# Une fois les données sélectionnées, il est possible de choisir le format du fichier export généré puis de cliquer sur le bouton Générer.
# Après quelques instants, un fichier est alors disponible pour téléchargement.
Les formats existants sont CSV ou TSV (Fichier texte) ou XLS (Format Excel natif)

= [[File:Outils.png]] Développer son propre script d'export =
S'il n'y a aucun lot de données prédéfini qui convienne et que vous avez des connaissances en programmation informatique, vous pouvez aussi développer votre propre script. N'importe quel langage peut faire l'affaire du moment que vous pouvez lire la base de données.
Il vous suffit de lire la table de l'entité qui vous intéresse et de fabriquer un fichier export au format qu'il vous plaira
à partir des données de cette table.
Le seul pré requis est donc de connaitre la table qui contient les données qui vous intéressent.
Pour vous y aider, la page [[:Category:Table SQL|Table SQL]] vous présente la liste des tables de Dolibarr.

Les versions postérieures à la 2.6 permettent aux utilisateurs "admin" de visualiser le code SQL correspondant aux requêtes élaborées à l'aide de l'assistant export.

=Copies D ecran=

[[File:Nouvel_export_-_2018-Etape1.jpg]]

=Vidéos sur le sujet=

<youtube width="200" height="120">dc8wfS6VoZ0</youtube>

Restauraciones

2022-10-30T08:24:35Z

Techsc: /* Videos */ Revision de la taille de la vidéo

Restores

2022-10-30T08:24:20Z

Techsc: /* Related videos */ Revision de la taille de la vidéo

[[fr:Restaurations]]
[[es:Restauraciones]]


[[Category:Admin_en]]
{{TemplateDocUtil}}

This page describe how to restore a backup of Dolibarr (for example after formatting your hard disk). To know how to do a complete backup, see page [[Backups|Backup]].

= Prerequisites =
For a complete restore on a clean environment, we suppose that you :
* Have a backup of your database (into a dump file, done with mysqldump tool for example if you used a MySQL or MariaDb database).
* Have a backup of your document files directory.
* You know a login of an admin user you used before, when old Dolibarr backup was done.

= Step 1 - Reinstall Dolibarr software =
If you have uninstalled Dolibarr or not yet installed because you are on a new server, you must install Dolibarr as if you want to use it with a new clean database.

Be carefull to choose the same database type than before (Mysql, PostgreSQL...).

You can install any Dolibarr distribution of your choice (Dolibarr, DoliWamp, DoliMamp, any other Linux distribution...), however it must be exactly the same version (vX.Y) than the one used to make the backup. The version may be included in the file name of the database backup.

= Step 2 - Restore documents =
On your new installed Dolibarr, go with an administrator user in the menu '''Home / System Tools / Restore'''.

Dolibarr will show you where your documents files must be stored. This directory must be empty (if not you can purge it).
All you have to do then is to copy content of your saved directory of old documents files into this directory.

= Step 3 - Restore the database =
== MySql ==
Copy the backup dump file into the same directory than the command '''mysql'''.

If your backup file was a compressed archive, unzipping the file before might be required:
For example, a bzip archive backup named mysqldump_dolibarr_2.7.0_200812021800.sql.bz2 must be uncompressed to mysqldump_dolibarr_2.7.0_200812021800.sql (Launch bunzip myfile.bz2 under Linux, or use 7zip under Windows).

On your new installed Dolibarr, go with an administrator user in the menu '''Home / System Tools / Restore'''.

Choose the import method.

Dolibarr offers a command line to launch to restore the database. Click on "Show the full command".
For example, you will have :
<syntaxhighlight lang="bash">
mysql mydatabase -h localhost -u databaseuser -pdatabasepass < mybackupfile.sql
</syntaxhighlight>

Open a command line shell (DOS Command line with Windows or a Shell terminal with Linux).
Go into the directory where command '''mysql''' and your backup file is stored.
Launch the command provided previously.

'''Alternative''': you can also use ''phpMyAdmin'' Import tab to restore your backup file (normally you don't have to check any particular option, but your backup file needs to disable foreign_key_checks, see below). Also this method can not be guaranted and may failed in some cases.

=== Troubleshooting ===

[[File:Warning.png]] ERROR 1005 (HY000) at line 20: Can't create table `dolibarr`.`llx_accounting_account` (errno: 150 "Foreign key constraint is incorrectly formed")

=> If you have such error, you mut manually delete the table llx_accounting_account and llx_accounting_system, before trying again.

[[File:Warning.png]] If you have error with foreign keys, check that '''your sql backup file disable foreign keys prior to restoring''', else your backup won't be restorable because of foreign keys clashing!

Eg: Add FOREIGN_KEY_CHECKS in headers and footers:
<syntaxhighlight lang="sql">
-- SQL Dump
-- Server version: 5.5.8

SET FOREIGN_KEY_CHECKS=0;
SET SQL_MODE="NO_AUTO_VALUE_ON_ZERO";

/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
/*!40101 SET NAMES utf8 */;

CREATE TABLE IF NOT EXISTS `llx_accountingaccount` (

INSERT INTO ...

CREATE TABLE ...

INSERT INTO ...

...

SET FOREIGN_KEY_CHECKS=1;
</syntaxhighlight>

==PostgreSql==
A procedure similar to MySQL but with '''pg_restore'''.

{{ToComplete}}

= Step 4 - Use your restored Dolibarr =
After command is finished, you can go on Dolibarr logon.
Now you must use a login account that was existing when the backup was done.

=Related videos=

Data restoration on a Docker installation:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">6H9ItBB_jK8</youtube>

Restaurations

2022-10-30T08:24:01Z

Techsc: /* Vidéos sur le sujet */ Revision de la taille de la vidéo

[[en:Restores]]
[[es:Restauraciones]]


[[Category:Admin fr]]
{{TemplateDocUtil}}

Cette page décrit comment restaurer une sauvegarde de Dolibarr (par exemple après avoir formatté votre disque dur). Pour savoir comment faire une sauvegarde complète, voir la page [[Sauvegardes]].

= Prérequis =
Pour une restauration complète, on suppose que :
* Vous avez une sauvegarde de votre base de donnée (dans un fichier dump, fait par mysqldump avec mysql par exemple).
* Vous avez une sauvegarde de vos fichiers du répertoire documents.
* Vous connaissez le login et mot de passe d'un utilisateur administrateur que vous utilisiez pour accéder au Dolibarr qui a été sauvegardé.

= Etape 1 - Réinstaller le logiciel Dolibarr =
Si vous avez désinstallé Dolibarr ou pas encore installé car vous êtes sur un nouveau serveur, vous devez installer Dolibarr comme si vous vouliez l'utiliser pour la première fois avec des données fraiches.

Faites attention à utiliser le même type de base de données qu'auparavant (Mysql, PostgreSQL...).

Vous pouvez installer toute distribution de votre choix de Dolibarr (Dolibarr, DoliWamp, DoliDeb, ou toute autre distribution de tout Linux...), cependant il doit s'agir '''exactement de la même version''' (vX.Y) que celle qui était utilisée lors de votre sauvegarde (si vous voulez en profiter pour monter de version, il est recommandé de le faire dans un second temps). Remaqure: Si la sauvegarde a été faite depuis Dolibarr, la version de Dolibarr sauvegardé est incluse dans le nom du fichier de sauvegarde de base de donnée.

= Etape 2 - Restaurer les fichiers documents =
Sur votre nouvelle installation de Dolibarr, aller avec un compte administrateur dans le menu '''Accueil > Outils Système > Restauration'''.

Dolibarr vous montrera où doit être stocké votre répertoire des fichiers documents par un message de ce genre:

Pour restaurer une sauvegarde de Dolibarr, vous devez:

* Reprendre le fichier archive (fichier zip par exemple) du répertoire documents et en extraire l'arborescence dans le répertoire documents d'une nouvelle
installation de dolibarr ou dans le répertoire documents de cette installation ('''''chemin du répertoire des documents''''').

Ce répertoire doit être vidé (vous pouvez purger son contenu).
Tout ce que vous avez à faire est de copier le contenu de votre répertoire sauvegardé de vos anciens fichiers dans ce répertoire.

= Etape 3 - Restaurer la base de donnée =

==MySQL==
Sur les installations autres que Linux, si la commande '''mysql''' n'est pas reconnue dans une ''Commande DOS'', cela signifie que la variable PATH ne liste pas le répertoire dans lequel est mysql.exe.
Il faut :
* soit compléter la variable PATH par l'ajout de ce répertoire dans lequel est mysql.exe,
* soit copier le fichier dump de sauvegarde dans ce même répertoire.

Si votre fichier de sauvegarde est une archive compressée, décompresser le fichier auparavant.

Par exemple, une sauvegarde archive bzip nommée mysqldump_dolibarr_2.7.0_200812021800.sql.'''bz2''' doit être décompressée en mysqldump_dolibarr_2.7.0_200812021800.sql (Lancer la commande bunzip nomdufichier.bz2 sous Linux, ou utiliser 7zip avec Windows).

Sur votre nouvelle installation de Dolibarr, connectez-vous avec un compte administrateur et allez dans le menu '''Accueil > Outils système > Restauration'''.

Choisir la méthode d'import MySQL.

Dolibarr affiche alors une commande à lancer en ligne de commande avec le mot de passe masqué pour réaliser la restauration de la base de donnée.
Cliquez sur "Afficher la commande complète" pour avoir la commande complète avec le mot de passe non masqué.
Par exemple, on aura :
<syntaxHighlight lang="bash">
mysql base_de_donées -h nom_ou_ip_serveur -P 3306 -u utilisateur -pvotremotdepasse < monfichiersauvegarde.sql
</syntaxHighlight>
où :
* ''base_de_données'' est le nom de la base de données MySQL qui contiendra vos données Dolibarr,
* ''nom_ou_ip_serveur'' est le nom de la machine sur laquelle sera restaurée la base de données. Cela peut être 'localhost' qui est le nom ''générique'' de la machine locale sur laquelle vous opérez. Si la base doit être restaurée sur un autre système que la machine locale, remplacer localhost par le nom ou l'adresse IP du système distant en question.
* -P 3306 est l'indication du port TCP/IP utilisé par MySQL (peut être omis, sauf cas particuliers),
* ''utilisateur'' est l'utilisateur privilégié MySQL que Dolibarr utilise pour se connecter à la base de données,
* ''votremotdepasse'' est le mot de passe du compte utilisateur MySQL (attention pas d'espaces entre le p et le mot de passe),
* ''monfichiersauvegarde.sql'' est le nom du fichier dump (ex. mysqldump_dolibarr_2.7.0_200812021800.sql).

Ouvrir un shell de ligne de commande (Commande DOS sous Windows, Terminal shell sous Linux...).
Aller dans le répertoire où est enregistré le fichier de sauvegarde à restaurer.
Lancer la commande fournie précédemment, sachant que chaque espace (ou absence d'espace), signe "-" ou "<" est impérieusement requis, sous peine de générer une erreur de syntaxe.

'''Alternative''': vous pouvez également utiliser ''phpMyAdmin'', onglet Importer, pour restaurer votre fichier de sauvegarde (normalement, vous n'aurez à cocher aucune option en particulier, mais votre fichier de sauvegarde doit absolument désactiver FOREIGN_KEY_CHECKS, voir ci-dessous). Cette méthode offre des résultats qui ne sont toutefois pas garantie contrairement à la méthode précédente.

=== Troubleshooting ===

[[File:Warning.png]] ERROR 1005 (HY000) at line 20: Can't create table `dolibarr`.`llx_accounting_account` (errno: 150 "Foreign key constraint is incorrectly formed")

=> Si vous avez cette erreur, vous devez manuellement détruire la table llx_accounting_account et llx_accounting_system, avant de recommencer la tentative de chargement.

[[File:Warning.png]] Erreur au chargement de table sur des foreign keys.

=> Votre '''dump sql doit désactiver les vérifications de Foreign Keys pendant la restauration''', sinon votre backup SQL ne pourra pas être restauré à cause des clashs entre les Foreign Keys! Ceci devrait être le cas par défaut si vous avez effectué votre sauvegarde correctement.
Exemple: Ajouter FOREIGN_KEY_CHECKS au tout début et à la fin du fichier sql:
<syntaxHighlight lang="sql">
-- SQL Dump
-- Server version: 5.5.8

SET FOREIGN_KEY_CHECKS=0;
SET SQL_MODE="NO_AUTO_VALUE_ON_ZERO";

/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
/*!40101 SET NAMES utf8 */;

CREATE TABLE IF NOT EXISTS `llx_accountingaccount` (

INSERT INTO ...

CREATE TABLE ...

INSERT INTO ...

...

SET FOREIGN_KEY_CHECKS=1;
</syntaxHighlight>

==PostgreSql==
Une procédure similaire à MySQL avec '''pg_restore'''.

{{ToComplete}}

= Etape 4 - Utiliser votre Dolibarr restauré =
Une fois la commande de restauration de base terminée, vous pouvez vous reloguer sous Dolibarr.
Maintenant, vous devez utiliser un login qui existait lorsque la sauvegarde a été faite.
Toutes les données sont celles datant de la sauvegarde.

=Vidéos sur le sujet=

Restauration des données sur une installation Docker:

<youtube width="200" height="120">6H9ItBB_jK8</youtube>

Copias de seguridad

2022-10-30T08:23:27Z

Techsc: /* Videos */ Revision de la taille de la vidéo

[[en:Backups]]
[[fr:Sauvegardes]]
[[de:Datensicherung]]


[[Category:Admin es]]
{{TemplateDocUsuario}}

= [[File:Who.png]] ¿Por qué salvaguardar? =
Existen varias razones por las que es muy importante poder "salvaguardar" una instancia completa de Dolibarr. Por ejemplo:
* En previsión de una actualización con el fin de poder volver atrás.
* Para cambiar Dolibarr de un servidor a otro
* Finalmente y sobretodo, para poder realizar una restauración en caso de un siniestro o de una mala manipulación.
Por todas estas razones, es recomendable realizar copias de seguridad de los datos propios de Dolibarr.

= [[File:Who.png]] Información a guardar =
Dolibarr guarda sus datos en 3 sitios. Estos 3 sitios deberán ser guardados antes de cada actualización a fin de asegurar que, si surge algún problema, los datos puedan ser recuperados o simplemente con regularidad para ser capaz de restaurar su trabajo en caso de problemas. A continuación les describimos los 3 tipos de datos necesarios a copiar para poder realizar una restauración sin pérdidas.

== Los ficheros de configuración ==
Aunque los ficheros de configuración no suelen ser modificados nunca por los procesos de actualización, más vale prevenir que curar.
El archivo de configuración se llama conf.php y se encuentra en dolibarr/htdocs/conf/. Haga una copia de ese archivo en su espacio dedicado a las copias de seguridad. Sin embargo, esta copia de seguridad puede obviarse si sabe su identificador de conexión (y cualquier otra configuración no sea la predeterminada). Al restaurar, el archivo puede ser recreado por una instalación limpia.

== La base de datos ==
La base de datos contiene todos los datos que se han introducido (exceptuando los documentos adjuntados, descritos en el párrafo siguiente). Su copia de seguridad se hará de manera global. Vea los siguientes capítulos.

== Los documentos ==
Todos los documentos relativos a su instalación se conservan en la carpeta indicada por la variable $dolibarr_main_document_root en el fichero de configuración ''dolibarr/htdocs/conf/conf.php''. Si ha dejado el ofrecido por defecto, se encuentra en ''dolibarr/documents''. Esta carpeta debe de ser guardada imperativamente. Aunque el proceso de actualización no interviene normalmente en esta carpeta, esta debe de ser accesible en escritura por el servidor web en todo momento, y este último '''podrá''' realizar cambios si es necesario. Para garantizar la conservación de los documentos oficiales en su estado original, haga una copia de seguridad de esta carpeta!

==Las modificaciones del código==
Por último, toda evolución de los módulos, es decir, todos los archivos PHP (u otros) que se han añadido o modificado para tener en cuenta desarrollos a medida, deben también ser salvaguardados.
En la mayoría de los casos, no se verá afectado por este punto.

= [[File:Who.png]] Cuándo =
La frecuencia recomendada depende de la intensidad de su uso de Dolibarr y la tolerancia en términos de pérdida de datos que acepta. Cuanto mayor sea la frecuencia, menor, en caso de restauración, es la pérdida de datos.

= [[File:Who.png]] Comentarios =

== El fichero de configuración ==
Una simple copia del archivo ''conf/conf.php'' en una carpeta dedicada al salvaguardado es suficiente.

== La base de datos ==
Existen 4 métodos para salvaguardar su base de datos:

=== Mediante las utilidades de copia de Dolibarr ===

Esta es la forma más fácil de hacer su copia de seguridad, además todas las copias de seguridad se almacenan en el servidor y serán listadas, de modo que pueda recuperar cualquier versión anterior en cualquier momento.

Si está utilizando una versión bastante reciente de Dolibarr, inicie sesión como administrador en Dolibarr(sólo los administradores pueden utilizar las herramientas del sistema).

Seguidamente vaya a '''Inicio -> Utilidades del sistema -> Copias'''.

A continuación, seleccione las opciones de copia de seguridad (se puede mantener todos los valores por defecto).

Atención: Algunos usuarios han informado de que las copias de seguridad quedan a veces incompletas (faltan algunas tablas) cuando se habilita la compresión. Aunque este problema no ha podido ser reproducido, no olvide verificar el contenido de la copia de seguridad o, si quiere ser prudente, no habilitar la compresión.

''Alternativo'': el método por defecto '''MySQL Dump (mysqldump)''' necesita tener un acceso al archivo binario mysqldump en ejecución sobre su servidor. Si se encuentra en un servidor compartido que desactiva este acceso, puede probar el otro método disponible '''Dump MySQL (php)'''. En este método la copia de seguridad no está garantizada, por lo que debería comprobar usted mismo si le funciona correctamente realizando una copia y restaurándola en local para verificar que los datos están correctamente.

=== Mediante la herramienta mysqldump ===
Si prefiere el modo manual, puede usar directamente la herramienta de copias de su base de datos.
Con MySQL, el comando para salvaguardar su base de datos a un archivo es:
<syntaxHighlight lang="bash">
mysqldump -u usuario -psucontraseña --result-file=dolibarr.version.date.sql base_de_datos
</syntaxHighlight>
donde :
* ''usuario'' es el usuario MySQL con priviliegios que Dolibarr usa para conectarse a la base de datos,
* ''sucontraseña'' es la contraseña del usuario MySQL (sin espacios entre la p y la contraseña),
* ''base de datos'' es el nombre de la base de datos que usa Dolibarr.
Estos datos (usuarios, contraseña y base de datos) están disponibles en su archivo de configuración ''dolibarr/htdocs/conf/conf.php''

El archivo (llamado "archivo dump"), se llama dolibarr.version.fecha.sql, donde
* ''version'' est la version actual de su dolibarr (ej: 3.2)
* ''fecha'' estará reemplazado por una fecha, por ejemplo en formato AAAAMMJJ, donde AAAA es el año (ex. 2011), MM el número de mes (ej. 05) y JJ el día del mes (ej. 18).
En el ejemplo, el archivo dump sería creado como ''dolibarr.3.2.20110518.sql''.

Un truco para conseguir un menor tamaño de archivo (comprimido):
<syntaxHighlight lang="bash">
mysqldump -u usuario -pcontraseña | bzip2 >dolibarr.version.fecha.sql base_de_datos.bz2
</syntaxHighlight>
El archivo recuperado será comprimido en formato bzip.

=== Mediante phpMyAdmin ===

Puede usar phpMyAdmin para salvaguardar su base de datos, pero es necesario desactivar una opción para que pueda restaurar después el backup (si se olvida de hacerlo, mire más abajo la nota sobre los FOREIGN_KEY_CHECKS).

En phpMyAdmin, haga clic en la pestaña '''Exportar''', seguidamente selecciona su base de datos de Dolibarr a continuación, seleccione las su base de datos Dolibarr o las tablas de Dolibarr (según la ventana en la que esté: vista de base de datos o vista de tablas), y seleccione '''Deshabilitar la revisión de las claves foráneas''', verifique que el resultado será en formato SQL, y continúe la exportación.

=== Mediante otros programas ===

Puede usar otros programas de copias de bases de datos, como scripts PHP que puede subir a su servidor, (como DB2SQL de Howard Yeend o
BigDump), o utilizar un diseñador de base de datos / workbench que generalmente ofrecen la posibilidad de conectarse de forma remota a su base de datos y le permiten hacer una copia de seguridad completa.

----

[[File:Warning.png]] En todos los casos, su '''dump sql debe deshabilitar la revisión de las claves foráneas durante la copia''', de lo contrario su backup no podrá ser restaurado!
Ejemplo: Añadir FOREIGN_KEY_CHECKS en el inicio y fin del archivo sql:
<syntaxHighlight lang="sql">
-- SQL Dump
-- Server version: 5.5.8

SET FOREIGN_KEY_CHECKS=0;
SET SQL_MODE="NO_AUTO_VALUE_ON_ZERO";

/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
/*!40101 SET NAMES utf8 */;

CREATE TABLE IF NOT EXISTS `llx_accountingaccount` (

INSERT INTO ...

CREATE TABLE ...

INSERT INTO ...

...

SET FOREIGN_KEY_CHECKS=1;
</syntaxHighlight>

[[File:Warning.png]] Mysqldump (ya sea mediante la herramienta desde la línea de comandos o la función de copia de Dolibarr) es la forma más segura para salvaguardar los datos, ya que está siendo desarrollado por los mismos desarrolladores de MySQL, por lo que está siempre al día. '''PhpMyAdmin''' y otros programas pueden generar un volcado válido de SQL, pero el código SQL resultante puede estar desactualizado o falto de algunas características (dependiendo de las opciones que elija).

== Los documentos ==
Una copia de la carpeta de documentos (''dolibarr/documents'' por defecto) en una carpeta de copia de seguridad debería ser suficiente.
Si ha realizado una copia de la base de datos via la utilidad sistema de Dolibarr, el fichero dump de la base de datos se encuentra incluido en esta copia.

Nota: Si ha realizado la copia de seguridad de la base de datos a través de la utilidad del sistema de Dolibarr (véase el párrafo anterior), el archivo de volcado de la base de datos se encuentra también incluido en esta copia (dentro del directorio ''dolibarr/documents/admin/backup'').

= [[File:Astuces.png]] Restauración =
Este tema se trata en la página [[Restauraciones]]

=Videos=

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">XDJOl77kVeY</youtube>

Backups

2022-10-30T08:23:12Z

Techsc: /* Related videos */ Revision de la taille de la vidéo

[[fr:Sauvegardes]]
[[es:Copias_de_seguridad]]
[[de:Datensicherung]]


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

= [[File:Who.png]] Why ? =
There is several reason why it is important to "backup" a complete instance of Dolibarr. For example:
* Because you plan to make an upgrade and want to do a go back to previous version if it fails.
* Because you want to move Dolibarr from one server to another server.
* And of course, to be able to make a restore to be safe if something bad happens (crash disk, hack corruption, ...)
For all the above reasons, it is recommended to '''regularly''' make a new backup of all data used and saved by Dolibarr.

= [[File:Who.png]] What to save ? =
Dolibarr save its data in 3 different spaces. They all must be saved before each version upgrade to be sure to be able to get back its data if a problem occurs or if you want to go back on previous version. This is the 3 kind of data you need to save to be sure to loose nothing.

== A) The database ==
The database contains all data you have added from Dolibarr screens (except the attached/generated files that are presented in next chapter).
Saving the database must be done in a global way (all content). It is advised to '''save the database regularly'''. See the chapter "How" later in this document.

== B) Documents ==
All documents related to your Dolibarr instance are saved into directory defined into your config file ''dolibarrdir/htdocs/conf/conf.php''. If you kept the choice by default during first installation, it should be something like ''dolibarrdir/documents''. This directory must be completely saved.
When making an upgrade, the upgrade process should not change this directory, however this directory can be read and write by web server at any time, it might be altered by a bad action or a bug. To be sure to keep all your joined files and be able to restore them if they are accidentally deleted or altered, just make a copy of all content of this directory.

''Note'': copying the whole folder containing all your documents might be an heavy process, so if you can't do this regularly, at least make a backup of your database (which should be a lot smaller and would still enable you to recover most of your data, which can then be used to regenerate most of your documents).

== C) The configuration file ==
The configuration file should not be modified by upgrade process, but it is more prudent to save it also when you do an upgrade.
The configuration file is called ''conf.php'' and you can find it into directory ''dolibarrdir/htdocs/conf/''.
Make a copy of this file into the dedicated area of your backup.

''Note'': This backup is however optional as you can still rebuild this file manually from scratch or with the Dolibarr install wizard if you know your database credentials (this file contains only parameters to connect to database and directory where you Dolibarr is installed). When making a restore, it is still possible to rebuild this file by an installation from scratch.

== D) Code change ==

Finally, any custom development of modules, ie: all php files (or others) that would have been added or modified to accommodate specific needs, should also be saved. In most cases, you are not concerned by this point.

= [[File:Who.png]] When ? =
Frequency of backups depends on how often you use Dolibarr and what you accept to loose if something happens. More often the frequency, less data will be lost in case of a crash/failure.

Also, you can choose to backup more often one part (like the database) that is more critical, and less regularly others because they are more heavy (like the documents).

As a good starting point, you database should be backed every 1 month or even every 1 week depending on your usage, while documents can be backed every 6 months or every 1 month depending on your usage once again.

Also, the conf.php file needs to be backed only once (since it only changes if you change your host, and anyway can be made manually).

= [[File:Who.png]] How ?=

== A) The database ==
There are 4 ways to backup your database:

=== Using Dolibarr system backup tool ===

This is the simplest way to make your backup, and in addition all your backups will be stored on server and will be listed, so that you can retrieve any version anyday.

If you use a recent enough version of Dolibarr, just log into Dolibarr with an administrator account (only admins can use system tools).

Then go to '''Home -> System tools -> Backups'''.
Choose your options for your backup (you can keep all default values).

''Alternative'': the default method '''MySQL Dump (mysqldump)''' also needs that you have access to the mysqldump binary in execution on your server. If you are on a shared host that disable the mysqldump usage, you can try other method called '''MySQL Dump (php)'''. This method is not guaranted at 100%, so please try it first by yourself by making a backup and then restoring it on a local non production server to check that your data is correctly saved.

=== Using mysqldump ===
If you prefer a manual mode, you can also use the backup tool designed for your database.
With Mysql, the command to backup your database into a file is :
<syntaxHighlight lang="bash">
mysqldump -u user -pyourpass --result-file=mysqldump_databasename_version_date.sql databasename
</syntaxHighlight>
where :
* ''user'' is MySQL user that Dolibarr use to connect to database,
* ''yourpass'' is password of MySQL account user (warning, no space between the p and yourpass),
* ''databasename'' is the name of Dolibarr database.
Those informations (user, password and database) are available into your configuration file ''dolibarrdir/htdocs/conf/conf.php''

The result file ("dump file"), is called mysqldump_databasename_version_date.sql where
* ''version'' is the dolibarr version (ex: 3.7).
* ''date'' can be replaced with a date, recommanded format is YYYYMMDD, with YYYY the year (ex. 2011), MM is month number (ex. 05) and DD is day in month (ex. 18).
With value used as example, we will get a dump file called ''mysqldump_databasename_3.7_20110518.sql.

If you want to have your file compressed (compressé) :
<syntaxHighlight lang="bash">
mysqldump databasename -h host -u user -pyourpass -l --single-transaction -K --add-drop-table=TRUE --tables -c -e --hex-blob --default-character-set=utf8 | bzip2 > mysqldump_databasename_version_date.bz2
</syntaxHighlight>
Dump file will be generated with a bzip compressed format.

'''Example:'''

With Linux, to make a regular backup at 1:30 each day into file mysqldump_databasename_DD.sql.bz2, you can add this into your cron file:
<syntaxHighlight lang="bash">
30 1 * * * mysqldump databasename -h host -u user -pyourpass -l --single-transaction -K --add-drop-table=TRUE --tables -c -e --hex-blob --default-character-set=utf8 | bzip2 > mysqldump_databasename_`date +%d`.sql.bz2
</syntaxHighlight>

=== Using phpMyAdmin ===

Do not use phpMyAdmin to save your database ! phpMyAdmin generates some dump files, but if you used default option, you won't be able to restore it. You must enable one specific option for you to be able to restore your backup later on (if you forgot to do so and already have a backup that you want to restore, please read the note about FOREIGN_KEY_CHECKS below).

In phpMyAdmin, click on the tab '''Export''', then select your Dolibarr's database/tables (depending whether you are in multi-database view or tables view), and then '''enable''' the option '''Disable foreign key checks''', also check that the output will be SQL, and then you can validate your export. Also, not that, even with this option, backup is NEVER guaruanted with phpMyAdmin and is OFTEN useless. The only secured method is to use mysqldump (from Dolibarr or manually. See the two previous chapters).

=== Using another Third-Party Tools ===

You can also use third-party database backup softwares, like php scripts that you can upload on your server (such as db2SQL by Howard Yeend or BigDump), or also use database designer/workbench softwares which generally offer to remotely connect to your database and allow you to make a full backup (along to remotely manage your database).

----

[[File:Warning.png]] in any case, '''your sql backup file should disable foreign keys prior to restoring''', else your backup won't be restorable because of foreign keys clashing!
Eg: Add FOREIGN_KEY_CHECKS in headers and footers:
<syntaxHighlight lang="sql">
-- SQL Dump
-- Server version: 5.5.8

SET FOREIGN_KEY_CHECKS=0;
SET SQL_MODE="NO_AUTO_VALUE_ON_ZERO";

/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
/*!40101 SET NAMES utf8 */;

CREATE TABLE IF NOT EXISTS `llx_accountingaccount` (

INSERT INTO ...

CREATE TABLE ...

INSERT INTO ...

...

SET FOREIGN_KEY_CHECKS=1;
</syntaxHighlight>

[[File:Warning.png]] Mysqldump (using command line tool or using Dolibarr backup tool) is the most secure way to backup your data because it is developed along MySQL and thus is always up-to-date. '''PhpMyAdmin''' and other thirdparty tools may generate a correct SQL dump but may be outdated or miss some features (depending on options you choose).

== B) The documents ==
Just copy the Documents folder (''dolibarr/documents'' by default) to your local backup directory.

Note: If you made a backup of the database with the System Tools of Dolibarr, the sql dump files also resides in the Documents folder, and thus will be copied along.

== C) The configuration file ==
A simple copy of file ''conf/conf.php'' into a directory dedicated to your backup is enough.

= [[File:Astuces.png]] Restore =
This topic is explained into page [[Restores]].

=Related videos=
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">XDJOl77kVeY</youtube>

Sauvegardes

2022-10-30T08:22:52Z

Techsc: /* Vidéos sur le sujet */ Revision de la taille de la vidéo

[[en:Backups]]
[[es:Copias_de_seguridad]]
[[de:Datensicherung]]


[[Category:Admin fr]]
{{TemplateDocUtil}}

=[[File:Who.png]] Pourquoi sauvegarder=
Il existe plusieurs raisons pour lesquels il est très important de pouvoir "sauvegarder" une instance complète de Dolibarr. Par exemple:

*En prévision d'une mise à jour afin de pouvoir faire un retour arrière.
*Pour faire un déplacement de son Dolibarr d'un serveur à un autre.
*Enfin et surtout, afin de pouvoir réaliser une restauration pour se prémunir d'un sinistre, d'une fausse manipulation.

Pour toutes ces raisons, il est recommandé de réaliser des sauvegardes des données propres à Dolibarr.

=[[File:Who.png]] Quoi sauvegarder=
Dolibarr stocke des données à 3 endroits. Ces 3 endroits devraient être sauvegardés avant chaque mise-à-jour afin de s'assurer que, si un problème survient, les données peuvent être récupérées, ou tout simplement régulièrement pour être capable de restaurer son travail en cas de problème.
Voici les 3 typologies de données qu'il est nécessaire de sauvegarder pour une restauration sans perte.

==A) La base de données==
La base de données contient toutes les données que vous avez saisies (hors documents pièces jointes évoqués dans le paragraphe suivant).
Sa sauvegarde doit être faite de manière globale. Voir la suite pour le comment.

==B) Les documents==
Tous les documents relatifs à votre instance Dolibarr sont conservés dans le répertoire indiqué par la variable ''$dolibarr_main_document_root'' dans votre fichier de configuration ''dolibarr/htdocs/conf/conf.php''. Si vous avez laissé le choix par défaut, il s'agit de ''dolibarr/documents''. Ce répertoire doit impérativement être sauvegardé car contient toutes les pièces jointes que vous avez éventuellement téléversées dans l'application (comme les photos des employés ou des produis) ainsi que tous les documents générés par l'applications, comme les PDF.

==C) Le fichier de configuration==
Bien que les fichiers de configuration ne soient normalement jamais modifiés par le processus de mise-à-jour, il vaut mieux parer à toute éventualité.
Le fichier de configuration s'appelle ''conf.php'' et se trouvent dans ''dolibarr/htdocs/conf/''. Faire une copie de ce fichier dans un espace dédiée à la sauvegarde. Cette sauvegarde peut toutefois ne pas être réalisée si vous connaissez vos identifiant de connexion (et tout autre paramètre non standard) par ailleurs. En cas de restauration, le fichier peut être recréé par une installation vierge.

==D) Les modifications de code==
Enfin, toute évolution de modules, c'est à dire tous fichiers php (ou autre) qui aurait été ajouté ou modifié pour prendre en compte des évolutions spécifiques, doivent également être sauvegardés.
Dans la plupart des cas, vous n'êtes pas concernés par ce point.

=[[File:Who.png]] Quand=
La fréquence conseillée dépend de l'intensité de l'utilisation que vous faites de Dolibarr et de la tolérance en terme de donnée perdu que vous acceptez. Plus la fréquence est élevé, moins, en cas de restauration, vous n'aurez de données perdues.

=[[File:Who.png]] Comment=

==A) La base de données==
Il y a 4 méthodes pour sauvegarder votre base de données:

===Par les outils de sauvegarde de Dolibarr (recommandé si disponible)===

Il s'agit de la façon la plus simple pour faire de votre sauvegarde, et en plus toutes vos sauvegardes seront stockées sur le serveur et seront listées, de sorte que vous pouvez récupérer n'importe quelle ancienne version n'importe quand.

Si vous utilisez une version assez récente de Dolibarr, connectez-vous dans Dolibarr avec un compte administrateur (seuls les administrateurs peuvent utiliser les outils système).

Ensuite, allez à '''Accueil -> Outils d'administration -> Sauvegarde'''.

Choisissez ensuite vos options pour votre sauvegarde (vous pouvez conserver toutes les valeurs par défaut).

Attention: Certains utilisateurs ont reporté que les sauvegardes sont parfois incomplètes (certaines tables manquantes) quand la compression est activée. Bien que ce problème n'ait pu être reproduit, pensez à vérifier le contenu de votre sauvegarde ou à ne pas activer la compression si vous voulez être prudent.

''Alternative'': la méthode par défaut '''MySQL Dump (mysqldump)''' nécessite d'avoir un accès au fichier binaire mysqldump en exécution sur votre serveur. Si vous êtes sur un hébergement mutualisé qui désactive cet accès, vous pouvez essayer une autre méthode en définissant MAIN_FEATURES_LEVEL = 1, ce qui fera apparaître une nouvelle méthode '''Dump MySQL (php)'''. Cette méthode est encore expérimentale, donc s'il vous plaît essayez d'abord par vous-même en faisaint une sauvegarde puis en la restaurant sur une base locale de test pour vérifier que vos données sont correctement enregistrées et restaurées.

===Par l'outil mysqldump (pour les experts)===
Si vous préferez le mode manuel, vous pouvez utiliser directement l'outil de sauvegarde de votre base.
Avec MySQL, la commande pour sauvegarder votre base de données dans un fichier est:
<syntaxHighlight lang="bash">
mysqldump nombase -h nomserveur -u utilisateur -pmotdepasse -l --single-transaction -K --add-drop-table=TRUE --tables -c -e --hex-blob --default-character-set=utf8 --result-file=mysqldump_nombase_version_date.sql
</syntaxHighlight>
où :

*''utilisateur'' est l'utilisateur privilégié MySQL que Dolibarr utilise pour se connecter à la base de données,
*''motdepasse'' est le mot de passe du compte utilisateur MySQL (attention pas d'espaces entre le p et le mot de passe),
*''nomserveur'' est le nom ou l'ip du serveur de base de donnée.
*''nombase'' est le nom de la base de données que Dolibarr utilise.

Ces informations (utilisateur, mot de passe et base de données) sont disponibles dans votre fichier de configuration ''dolibarr/htdocs/conf/conf.php''

Le fichier résultant (appelé "fichier dump"), est nommé mysqldump_nombase_version_date.sql, où

*''version'' est la version en cours de votre dolibarr (ex: 3.7)
*''date'' peut-être remplacé par une date, par exemple au format AAAAMMJJ, avec AAAA l'année (ex. 2011), MM le numéro du mois (ex. 05) et JJ le jour dans le mois (ex. 18).

Pour reprendre les valeurs données en exemple, le fichier dump sera baptisé ''mysqldump_nombase_3.7_20110518.sql''.

Une astuce pour récupérer un fichier de petite taille (compressé) :
<syntaxHighlight lang="bash">
mysqldump nombase -h nomserveur -u utilisateur -pvotremotdepasse -l --single-transaction -K --add-drop-table=TRUE --tables -c -e --hex-blob --default-character-set=utf8 | bzip2 > mysqldump_nombase_version_date.bz2
</syntaxHighlight>
Le fichier ainsi récupéré est directement compressé au format bzip.

'''Exemple:'''

Sous Linux, pour réaliser une sauvegarde régulière à 1h30 dans le fichier mysqldump_nombase_DD.sql.bz2, vous pouvez ajouter ceci dans votre fichier cron:
<syntaxHighlight lang="bash">
30 1 * * * mysqldump nombase -h nomserveur -u utilisateur -pvotremotdepasse -l --single-transaction -K --add-drop-table=TRUE --tables -c -e --hex-blob --default-character-set=utf8 | bzip2 > mysqldump_nombase_`date +%d`.sql.bz2
</syntaxHighlight>

===Par phpMyAdmin===

Vous pouvez également utiliser phpMyAdmin pour sauvegarder votre base de données, mais il est nécessaire d'activer une option afin que vous puissiez restaurer le backup plus tard (si vous avez oublié de le faire, lisez la note à propos des FOREIGN_KEY_CHECKS plus bas).

Dans phpMyAdmin, cliquez sur l'onglet '''Exporter''', puis sélection votre base de données Dolibarr ou les tables de Dolibarr (suivant la fenêtre dans laquelle vous étiez - vue base de données ou vue tables), et cochez '''Désactiver la vérification des clés étrangères''', et enfin vérifiez quand même que le résultat sera au format SQL, et vous pouvez valider l'exportation.

===Par un autre Logiciels tiers===

Vous pouvez également utiliser des logiciels tiers de sauvegarde de bases de données, comme les scripts PHP que vous pouvez uploader (téléverser) sur votre serveur (comme DB2SQL par Howard Yeend ou BigDump), ou encore utiliser un concepteur de base de données / workbench qui offrent généralement la possibilité de se connecter à distance à votre base de données et vous permettra de faire une sauvegarde complète.

Ce fichier dump est l'élément le plus important de votre sauvegarde. Conservez le dans un endroit sur ou confiez le au prestataire chargé de restaurer votre environnement.
Attention, il n'est pas suffisant, la sauvegarde du répertoire documents (Etape B, voir chapitre suivant) est aussi cruciale.

----

Remarques pour les experts:

[[File:Warning.png]] Dans tous les cas, votre '''dump sql doit désactiver les vérifications de Foreign Keys pendant la restauration''', sinon votre backup sql ne pourra pas être restauré à cause des clashs entre les Foreign Keys!
Exemple: Ajouter FOREIGN_KEY_CHECKS au tout début et à la fin du fichier sql:
<syntaxHighlight lang="sql">
-- SQL Dump
-- Server version: 5.5.8

SET FOREIGN_KEY_CHECKS=0;
SET SQL_MODE="NO_AUTO_VALUE_ON_ZERO";

/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
/*!40101 SET NAMES utf8 */;

CREATE TABLE IF NOT EXISTS `llx_accountingaccount` (

INSERT INTO ...

CREATE TABLE ...

INSERT INTO ...

...

SET FOREIGN_KEY_CHECKS=1;
</syntaxHighlight>

[[File:Warning.png]] Mysqldump (que ce soit par l'outil en ligne de commande ou par la fonction Sauvegarde de Dolibarr) est le moyen le plus sûr de sauvegarder vos données, car il est développé par les même développeurs que MySQL et est donc toujours à jour. '''PhpMyAdmin''' et les logiciels tiers peuvent générer un dump SQL valide, mais le code SQL résultant peut être obsolète ou manquer de certaines fonctionnalités (en fonction des options que vous choisissez).

==B) Les documents==
Une copie de l'intégralité du répertoire des documents dans un répertoire/disque de sauvegarde dédié suffit. Voici comment savoir où se trouve ce répertoire:
Ce répertoire s'appelle par défaut ''dolibarr/documents'' mais vous trouverez le chemin complet en allant dans le fichier '''conf.php''' au niveau de la variable '''$dolibarr_main_data_root'''. Vous pouvez aussi trouvez l'information du chemin complet de ce répertoire depuis le menu '''Accueil - Outils d'administration - Sauvegarde - étape 2'''.

Il vous faut réaliser une archive zip de ce répertoire. Pour cela, il y a 2 solutions:

===Par les outils de sauvegarde de Dolibarr (recommandé si disponible)===
Si vous utilisez une version assez récente de Dolibarr, connectez-vous dans Dolibarr avec un compte administrateur (seuls les administrateurs peuvent utiliser les outils système).

Ensuite, allez à '''Accueil -> Outils Système -> Sauvegarde''' et cliquez sur le bouton "Générer sauvegarde" de l'étape 2.

===Par votre outil de zip habituel===
Aller dans votre gestionnaire de fichier, aller sur le répertoire identifié précédemment. Faire un clic droit sur ce répertoire et choisissez dans le menu contextuel "Compresser" ou "Zipper" ou "Créer un package zip" ou "Créer archive" ou quelque chose de similaire pour fabriquer le fichier zip.

Ce fichier archive est le 2eme élément cruciale de votre sauvegarde (avec le fichier dump de l'étape A). Conservez le dans un endroit sur ou confiez le au prestataire chargé de restaurer votre environnement.

Bon à savoir: Si vous avez réalisez la sauvegarde de la base de donnée via l'outil système de Dolibarr et son étape 1 (voir paragraphe précédent), le fichier dump base de donnée se trouvera également inclus dans cette archive (dans le sous répertoire ''dolibarr/documents/admin/backup'').

==C) Le fichier de configuration==
C'est mieux si vous l'avez (cela peut aider à du dépannage), mais sa conservation n'est pas obligatoire si il faut restaurer un jour votre sauvegarde.
Une simple copie du fichier ''conf/conf.php'' dans un répertoire dédié à la sauvegarde suffit.

=[[File:Astuces.png]] Restauration=
Ce sujet est traité dans la page [[Restaurations]]

=Vidéos sur le sujet=

<youtube width="200" height="120">XDJOl77kVeY</youtube>

Module Categories

2022-10-30T08:21:51Z

Techsc: /* Related videos */ Revision de la taille de la vidéo

[[fr:Module_Catégories]]
[[de:Modul_Kategorien]]


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

=Introduction=
The module category allows you to manage categories for

- third parties (customers or suppliers)

- contacts

- members

- user

- products / services (same list)

- stocks

 

=Installation=
{{NoInstallModuleEn}}

=Configuration=
{{ActivationModuleEn}} 

After getting on to the Home -Setup- modules, this module can be viewed under “'''Multi-modules tools''' ->'''Tags/Categories”.'''

=Related videos=

(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">gaKPBYqRK8A</youtube>

=Usage=
{{ToComplete}}

Module Catégories

2022-10-30T08:21:34Z

Techsc: /* Vidéos sur le sujet */ Revision de la taille de la vidéo

[[en:Module_Categories]]
[[de:Modul_Kategorien]]


[[Category:Catégories]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Catégories|
num=1780|
devdoc=[[Module Catégories (développeur)]]|
userdoc=Cette page|}}

= Introduction =
Le module catégorie permet de gérer des catégories sur les tiers clients, tiers fournisseurs ou les produits.

= Installation =
{{NoInstallModuleFr}}

= Configuration =
{{ActivationModuleFr}}

=Vidéos sur le sujet=

<youtube width="200" height="120">gaKPBYqRK8A</youtube>

Módulo Contabilidad

2022-10-30T08:20:39Z

Techsc: /* Videos */ Revision de la taille de la vidéo

Module Accounting Simplified

2022-10-30T08:20:21Z

Techsc: /* Related videos */ Revision de la taille de la vidéo

[[fr:Module Comptabilité Simplifié]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
This module allows you to get simplified accounting reports.
If you need to make double entry accounting, or edit a ledger, you should use instead the [[Module Double Entry Accounting]].

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

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

=Related videos=
Accounting Simplified:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">pL9EHwPoUms</youtube>

Module Comptabilité Simplifiée

2022-10-30T08:19:58Z

Techsc: /* Vidéos sur le sujet */ Revision de la taille de la vidéo

[[en:Module_Accounting_Simplified]]
[[es:Módulo_Contabilidad]]


[[Category:Compta]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Comptabilité|
num=10|
devdoc=[[Module Comptabilité (développeur)]]|
userdoc=Cette page|}}

=Introduction=
Ce module offre des fonctions très simplifiés pour sa comptabilité. Il permet d'offrir des rapports de comptabilités en se basant sur les informations métiers (factures, paiements, saisies des paiements de TVA, salaires, etc...) mais sans avoir à gérer de comptes comptables. Pour une comptabilité complète en partie double (mais qui requiert une connaissance de ce qu'est un plan de compte comptable et de son utilisation), il faut plutôt utiliser le [[Module Comptabilité en Partie Double]].

=Installation=
{{NoInstallModuleFr}}

=Configuration=
{{ActivationModuleFr}}

=Utilisation=
L'avantage de ce module est qu'il n'y a rien à faire de plus que la saisie simple de ses factures, paiements et éventuellement rapprochement bancaire si on veut être sur de l'exhaustivité des résultats, pour obtenir des informations de comptabilité. C'est donc un module qui s'utilise par de la consultation des rapports qu'il apporte. Il ne nécessite donc aucune connaissance en comptabilité.

Ce module offre de plus une fonction qui permet d'exporter dans un fichier zip, après sélection des éléments à exporter et de la plage de date concernée, l'ensemble des éléments à transmettre à son comptable (listing dans des fichiers CSV et liste de PDF assorties).

Pour réaliser une comptabilité double partie complète et pouvoir agir sur les codes comptables ou le grand livre, il faut remplacer ce module par le [[Module Comptabilité en Partie Double]].
=Vidéos sur le sujet=
<youtube width="200" height="120">pL9EHwPoUms</youtube>

Documentación usuarios

2022-10-30T08:16:09Z

Techsc: Agregando un video (no en el lengua de la pagina pero es mejor que nada y puede ayudar)

[[en:User_documentation]]
[[fr:Documentation_utilisateur]]
[[de:Benutzerdokumentation]]
[[pt:Documentação dos utilizadores]]
[[zh:用户手册]]


<seo metak="usuario, documentación, guía, doc, tutorial, utilización, ayudante" />
Esta página es el índice de artículos relacionados con la documentación del usuario. Para documentación del desarrollador ver [[Documentación_Desarrolladores|aqui]]

= Funcionalidades =
* [[Lo que hace Dolibarr]]
* [[Lo que no hace Dolibarr]]

= Instalación | Actualización | Inicio =
* [[Prerrequisitos]]
* [[Instalación / Actualización]]
* [[Primeras configuraciones]]

= Administración =
* [[Importaciones|Importación de mis datos]] / [[Exportaciones]]
* [[Copias de seguridad]] / [[Restauraciones]]

Video :
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">lTriUeIdiNs</youtube>

=El tablero=

Video :
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">VieSairH_ZQ</youtube>

=La tabla instrumentos=

Video :
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">gbfLLlp14FA</youtube>

=La tabla estadísticos incrustados en los objectos de Dolibarr=

Video :
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">L_3Qft8MLXA</youtube>

= Uso (módulos) =
Saber usar Dolibarr es conocer los menús y funciones de los módulos que han sido activados. Pero veamos primero la introducción o el uso en general:
* [[Uso general de Dolibarr]]
La documentación específica de un módulo funcional estándar de Dolibarr se encuentra en la página del módulo.
* El listado de módulos estándar está disponible en la página [[:Category:Listado de Módulos|Listado de Módulos]]
* El Listado de módulos complementarios se encuentra en la página [[:Category:Módulos_complementarios|Módulos complementarios]]

= Glosario =
Ver la página [[Glosario]]

= FAQ =
Todos los FAQ se encuentran disponibles desde la página índice [[:Category:FAQ ES|FAQ ES]]

Instalación - Actualización

2022-10-30T08:08:01Z

Techsc: Agregando un video (no en el lengua de la pagina pero es mejor que nada y puede ayudar)

Installation - Upgrade

2022-10-30T08:02:48Z

Techsc: /* Related videos */ Révision de la taille des vidéos

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


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

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

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

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

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

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

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

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

*Download last Dolibarr version for Windows DoliWamp.

For this, see at {{TemplateURLToDownloadDoliWamp}}

*Run the downloaded .exe and follow instructions.

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

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

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

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

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

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

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

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

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

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

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

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

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

====Preparation of MySQL or MariaDB database====

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

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

====Preparation of PostgreSQL database====

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

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

====Install Dolibarr files on the web server====

*Go into the directory where to install Dolibarr (the web root directory defined for your web server virtual host. Example of setup of virtual host are available on [[Webserver|this page]]).

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

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

*Get the application archive of last stable version '''from zip file''' <source lang="bash">
$ wget http://www.dolibarr.org/files/dolibarr.zip
</source> Uncompress archive<source lang="bash">
$ unzip dolibarr.zip
</source> '''or from git repository'''<source lang="bash">
$ git clone --depth 1 -b X.Y http://github.com/Dolibarr/dolibarr.git dolibarr
</source> Replace X.Y with the version you want to get. Remove "--depth 1" if you don't mind downloading the entire history of the project (programmers may find it useful but end users probably won't).

*Rename directory dolibarr-x.y.z into dolibarr to have a directory name that does not depends on version (replace x.y.z with source version)<source lang="bash">
$ mv dolibarr-x.y.z dolibarr
</source>

*Change permissions and owner of the 'dolibarr' directory to that of the group under which the web server runs (assumed to be 'www-data' for debian, 'apache' for redhat, mandriva, fedora)<source lang="bash">
$ chmod -R 755 /var/www/dolibarr
$ chown -R www-data.www-data /var/www/dolibarr
or
$ chmod -R 755 /var/www/html/dolibarr
$ chown -R apache.apache /var/www/html/dolibarr
</source>

*For Fedora, since SELinux is usually enabled, it is also advisable to run the following commands to make the 'dolibarr' directory compliant with the SELinux requirement (else you are likely to get quite a few alerts) :<source lang="bash">
$ semanage fcontext -a -t httpd_sys_rw_content_t '/var/www/html/dolibarr(/.*)?'
$ restorecon -R -v '/var/www/html/dolibarr'
</source>

*As a root user, create, into directory dolibarr/htdocs/conf, an empty configuration file called conf.php and set the web server user as owner (for instance www-data on Debian, apache on Mandriva, RedHat, Fedora or other distributions ...). This is required because the web server will have to write into this file during install process.<source lang="bash">
$ cd dolibarr ; touch htdocs/conf/conf.php ; chown www-data htdocs/conf/conf.php
</source> Note: For Ubuntu no need of htdocs, you just have to make dolibarr root by placing all files and folders of htdocs in /var/www/dolibarr then from browser do <MyIP>/dolibarr/index.php (see this discussion as reference to this addendum [http://askubuntu.com/questions/874456/php-code-displays-in-browser?noredirect=1#comment1357943_874456])

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

*Now call your browser to point to the main page<source lang="ini">
http://127.0.0.1/dolibarr/htdocs/
</source> or if you didn't create the htdocs directory<source lang="ini">
http://127.0.0.1/dolibarr/
</source>

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

*For security reason, we recommend, once setup is finished, to create a file install.lock into Dolibarr document directory that only root user can delete. This will lock the call of the install process again (you will have to remove this file for upgrades). If this is not done, Dolibarr will show you a warning once logged by an administrator user.<source lang="bash">
$ touch /var/lib/dolibarr/documents/install.lock; chmod go-w /var/lib/dolibarr/documents;
</source>

==== Additional information on setting up a Debian or Ubuntu server ====
If you are planning to configure a Debian or Ubuntu server for Dolibarr to provide the aforementioned prerequisites, there are detailed step-by-step instructions available in German:

*[https://wiki.dolibarr.org/Installieren_und_H%C3%A4rten_von_Dolibarr Installation and hardening] ''(German)''

*''[https://wiki.dolibarr.org/ModSecurity_f%C3%BCr_Dolibarr Install ModSecurity für Dolibarr] (German)''

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

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

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

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

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

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

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

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

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

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

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

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

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

See page [[Cloud Solutions]].

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

See page [[Cloud Solutions]].

==Installation using Docker==
For admins with Docker experience, it is possible to use the docker build files located in the source repo here: https://github.com/Dolibarr/dolibarr/tree/develop/build
git clone https://github.com/Dolibarr/dolibarr/
cd ./dolibarr
git checkout tags/<desiredrelease>

cd build/docker

docker-compose up

Read the README carefully. As of version 12+ it recommends to use the built in docker files for development only, while an outside repo: https://hub.docker.com/r/tuxgasy/dolibarr is recommended for production environments.

=Setup=

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

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

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

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

'''Note''' (optional but recommended):

It's better to delete old scripts (and programms if included in the downloaded file) before installing new ones: old files can remain, causing bug and malfunctions.

Before deleting, remember to save what you have customiz in your installation:

*your data (documents folder and database)
*/custom if you have external modules -> be sure your external modules are compatible with the new version before updating !
*/conf/conf.php : main parameter of dolibarr
*your customized models and/or customized php scripts (it's recommended to report your modification in the new files cause yours are based on old version)

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

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

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

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

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

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

 

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

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

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

*First make a backup of your current installation

*Go into the directory where you installed Dolibarr (it might be the root directory of your web, for example /var/www under Debian)<source lang="bash">
$ cd /var/www
</source>

===For installation that used the zip file===

*Get archive of last version<source lang="bash">
$ wget https://www.dolibarr.org/files/dolibarr.zip
</source>

*Uncompress the archive<source lang="bash">
$ unzip dolibarr.zip
</source>

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

*If no error, you can now remove the directory of source files<source lang="bash">
$ rm -fr dolibarr-x.y.z
</source>

*Now open your Dolibarr in your browser. It should open automatically the install/ and choose ''Update'' in suggested menu.

===For installation that used GIT===

*If you already cloned the repo simply upgrade by checking out a version tag like so:<source lang="bash">
$ git checkout 13.0
$ git pull origin 13.0
</source>

*Now open your Dolibarr in your browser. It should open automatically the install/ and choose ''Update'' in suggested menu.

==Notes on the Upgrade==

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

*'''For security reasons''', once setup is finished, you should create a file install.lock into Dolibarr documents directory. This will lock the call of the install process again (you will have to remove this file for future upgrades). If this is not done, Dolibarr will show you a warning once logged with an administrator user.<source lang="bash">
$ echo > documents/install.lock
$ chmod 444 documents/install.lock
</source>

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

=Related videos=
Install on local :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">N0iweN8ukVU</youtube>

Install on server Infomaniak :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">jsi1D4L1WAI</youtube>

Installation and migration to V15 on local :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">LKdQvRVxYKs</youtube>

Installation - Mise à jour

2022-10-30T08:01:54Z

Techsc: /* Vidéos sur le sujet */ Révision de la taille des vidéos

[[en:Installation_-_Upgrade]]
[[es:Instalación_-_Actualización]]
[[zh:安装_-_升级]]


[[Category:Admin fr]]
{{TemplateDocUtil}}

Les procédures suivantes décrivent comment installer ou mettre à jour Dolibarr.

=Installer Dolibarr - Procédure d'installation=
Ce chapitre décrit les différentes méthodes possibles (des plus simples, aux manuelles) pour une première installation. Voir plus loin pour la mises à jour.

==Sur votre poste/serveur dédié==
===[[File:Logo_windows.png]] En manuel ou avec DoliWamp===
- '''Prérequis''': Windows

- '''Niveau''': Débutant

Si vous maîtrisez l'installation d'un serveur Web Apache, de PHP et MySQL, la section [[Installation - Mise à jour#Avec Dolibarr (package standard .zip ou sources Git)|Avec Dolibarr (package standard .zip ou sources Git)]] est plus appropriée.

Si vous avez du temps et que vous souhaitez apprendre à installer un serveur Web Apache, PHP et MariaDB, consultez la page [[Installation manuelle sous Windows]] pour des instructions pas à pas.

Pour les moins expérimentés qui sont sous Windows, il existe une distribution Dolibarr nommée '''DoliWamp''' qui permet de faire une installation Dolibarr sous Windows avec tous ses prérequis (Apache, Mysql, PHP) sans connaissance informatiques. Voici comment l'installer:

*Récupérez la version de Dolibarr pour Windows.

Pour cela, voir le site {{TemplateURLToDownloadDoliWamp}}

*Lancer le .exe téléchargé et suivez les instructions.

===[[File:Apple logo black.svg|35x35px]] Avec MAMP (pour macOS / MAC OS X)===
- '''Prérequis''' : Mac OS X / macOS 10.10 ou supérieur

- '''Niveau''' : Intermédiaire

Référez vous à la page [[Installation sur MacOSX]].

===[[File:Logo_ubuntu.png]] Avec DoliDeb (package Debian / Ubuntu .deb)===
- '''Prerequis''': Linux Debian, Ubuntu, ...

- '''Niveau''' : Débutant

Cette procédure fonctionne uniquement pour les utilisateurs Linux Debian, Ubuntu et dérivés et est recommandée pour ceux qui n'ont pas de connaissances informatiques particulières. Si vous êtes un administrateur expérimenté d'Apache, PHP et Mysql, le chapitre '''Avec Dolibarr (package standard zip)''' sera peut-être plus approprié. Dans le cas contraire, vous pouvez utilisez DoliDeb. DoliDeb est un package de Dolibarr spécialisé pour la distribution Debian ou Ubuntu. Ce package vous permet d'installer Dolibarr sous Ubuntu ou Debian (ou dérivé) avec tous ces prérequis (Apache, Mysql, PHP) s'ils ne sont pas déjà installés et ce sans connaissances techniques particulières.

*La procédure pour installer DoliDeb est décrite sur la page [[Dolibarr pour Ubuntu ou Debian]].

===[[File:Logo_rpm.png|40px]] Avec DoliRpm (package Fedora, Redhat, Mandriva, Mageia ou OpenSuse .rpm)===
- '''Prerequis''' : Linux Fedora, Redhat, Mandriva, Mageia or OpenSuse (peut également fonctioner pour toute distribution Linux à rpm)

- '''Niveau''' : Débutant

Cette procédure fonctionne uniquement pour les utilisateurs Linux d'une distribution gérant les packages rpm et est recommandée pour ceux qui n'ont pas de connaissances informatiques particulières. Si vous êtes un administrateur expérimenté d'Apache, PHP et Mysql, le chapitre suivant '''Avec Dolibarr (package standard zip)''' sera peut-être plus approprié. Dans le cas contraire, vous pouvez utilisez DoliRpm. DoliRpm est un package de Dolibarr spécialisé pour la distribution Fedora, Redhat, Mandriva, Mageia ou OpenSuse. Ce package vous permet d'installer Dolibarr sous ces OS avec tous ces prérequis (Apache, Mysql, PHP) s'ils ne sont pas déjà installés et ce sans connaissances techniques particulières.

*La procédure pour installer DoliRpm est décrite sur la page [[Dolibarr pour Redhat ou Fedora (package rpm)]] ou [[Dolibarr pour Mandriva ou Mageia (package rpm)]] ou [[Dolibarr pour OpenSuse (package rpm)]].

===[[File:Gnu.png]] Avec Dolibarr (package standard .zip ou sources Git)===
====Prérequis====
Apache, PHP et un serveur de base de données (MySQL ou PostgreSQL) sont présents et opérationnels, et le login/mot de passe d'accès (à une nouvelle base ou au serveur) est connu.

- '''Niveau''' : Un peu de connaissances informatiques en administration Web.

Cette procédure décrit l'installation manuelle (recommandée) sur un système GNU/Linux (Debian, Mandriva, ...) mais elle est valable avec d'autres systèmes moyennant une adaptation des chemins à ceux de votre OS.

Elle est applicable pour toute version de Dolibarr >= 2.0.0

Pour des instructions spécifiques à une installation sous Windows, vous pouvez consulter la page [[Installation manuelle sous Windows]].

*Vérifiez que vous avez bien Apache, PHP {{PHPMinVersion}} et un serveur de base de données (MySQL {{MySqlMinVersion}}, MariaDB ou PostgreSQL) d'installés (consulter pour cela la liste des packages installés sur votre machine grâce au gestionnaire de mise à jour de package de votre distribution).
*Vérifiez que le serveur Web est lancé (<code>systemctl status httpd.service</code> par exemple). L'activer le cas échéant (<code>systemctl enable --now httpd.service</code>)

*Vérifiez que l'utilisateur root ou admin principal pour le serveur de base de donnée est connu et fonctionne correctement. Si cet utilisateur root ou admin est inconnu car pas encore défini, lisez le chapitre qui suit. Sinon vous pouvez passez au point suivant:

====MySql ou MariaDB====
Vérifiez que le serveur de base de données est lancé (<code>systemctl status mysqld.service</code> par exemple). L'activer le cas échéant (<code>systemctl enable --now mysql.service</code>).

Pour les utilisateurs Linux utilisant MySql ou MariaDB, si vous venez juste d'installer la base de donnée, le login administrateur est '''root'''. Vous devez exécuter la commande suivante pour initialiser le mot de passe:
<source lang="bash">
mysql
</source>
Une fois dans l'interface Mysql, taper la commande de modification du mot de passe de root:
<source lang="sql">
grant all privileges on *.* to root@'localhost' identified by 'newrootpass' with grant option;
</source>
Puis entrée et pour quitter \q

Pour vérifier que l'accès avec ce couple user/mot de passe fonctionne, lancer la commande
<source lang="bash">
mysql -u root -p
</source>
Et taper votre mot de passe ''newrootpass'' suivi de \q pour quitter la sessions si la connexion a réussie.

====Postgresql====
Pour les utilisateurs Linux utilisant Postgresql, si vous venez juste d'installer la base de donnée PostgreSQL, vous devez d'abord créer un utilisateur administrateur et son mot de passe. Pour cela, ajouter la ligne suivante dans le fichier '''/etc/postgresql/x.x/main/pg_hba.conf''' (remplacer x.x avec votre version de postgres)
<source lang="ini">
local all dolibarrowner md5
</source>
De plus, mettez en commentaire la ligne
<source lang="ini">
#local all all ident
</source>
qui impose que le compte système utilisé pour accéder à la base (ce sera le compte sous lequel tourne l'application web), ait le même nom que le compte dans la base (ce n'est jamais le cas).

Ensuite, lancer la commande sous un shell root
<source lang="bash">
sudo -s -u postgres
createuser dolibarrowner
psql -d template1 -c "alter user dolibarrowner with password 'dolibarrownerpass'"
exit
psql
create database databasename;
grant all privileges on database databasename to dolibarrowner;
ALTER DATABASE databasename OWNER TO dolibarrowner;
\q
sudo /etc/init.d/postgresql restart
</source>
Vous pouvez tester la connexion pour l'utilisateur crée avec la commande
<source lang="bash">
psql -h localhost -d postgres -U dolibarrowner -W
</source>
Et entrez le mot de passe ''dolibarrownerpass'' et \q pour quitter la session si la connexion est ok.
====Copie des fichiers====

*Placez-vous dans le répertoire dans lequel installer Dolibarr (le répertoire racine défini pour votre serveur web)

#Pour Debian et les familles Ubuntu, il s'agit en général de: /var/www
#Pour Mandriva, Mageia, RedHat, Fedora: /var/www/html
#Pour Suse: /srv/www/htdocs

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

*Récupérez l'application

=====Avec l'archive=====
Si vous partez du fichier dolibarr.zip, récupérez le fichier et décompressez l'archive de l'application (ex: version 12.0.4)

<source lang="bash">
$ wget 'https://sourceforge.net/projects/dolibarr/files/Dolibarr ERP-CRM/12.0.4/dolibarr-12.0.4.zip'
$ unzip dolibarr.zip
</source>

Renommez le répertoire dolibarr-x.y.z en dolibarr afin d'avoir un nom de répertoire indépendant de la version (où x.y.z correspond à la version source)
<source lang="bash">
$ mv dolibarr-x.y.z dolibarr
</source>

=====Avec les sources Git=====
Si vous partez des sources Git, récupérer les sources par

<source lang="bash">
$ git clone -b X.Y http://github.com/Dolibarr/dolibarr.git dolibarr
</source>

'''X.Y''' est la version à installer(Par exemple 9.0, 11.0, ...). Il est possible de remplacer '''X.Y''' par '''develop''' pour récupérer la version en cours de développement.

====Gestion des droits====
Modifiez les permissions et propriétaires du répertoire 'dolibarr' pour être sur que tous les fichiers soient en lecture pour l'utilisateur sur lequel tourne le serveur (on supposera qu'il s'agit de l'utilisateur 'www-data' pour debian ou ubuntu, 'apache' pour Redhat, Mandriva, Mageia, Fedora)
<source lang="bash">
$ chmod -R 755 /var/www/dolibarr
$ chown -R www-data.www-data /var/www/dolibarr
ou
$ chmod -R 755 /var/www/html/dolibarr
$ chown -R apache.apache /var/www/html/dolibarr
</source>

====Fichier de configuration====
En tant que root, créez, dans le répertoire dolibarr/htdocs/conf, un fichier de configuration vide, et attribuez-lui comme propriétaire du fichier, l'utilisateur du serveur web (exemple www-data sur debian, nobody sur une vieille RedHat, apache sur une autre version ...). Ceci est requis car le serveur web a besoin d'écrire dans ce fichier lors de l'installation.
<source lang="bash">
$ cd dolibarr ; touch htdocs/conf/conf.php ; chown www-data htdocs/conf/conf.php
</source>
====SELinux sur Fedora====
Sur Fedora, comme SELinux est activé en général, il est aussi conseillé de lancer les commandes pour rendre le répertoire 'dolibarr' accepté par l'environnement SELinux (an absence de commande, vous devriez recevoir des nombreuses alertes d'anomalies) :
<source lang="bash">
$ semanage fcontext -a -t httpd_sys_rw_content_t '/var/www/html/dolibarr(/.*)?'
$ restorecon -R -v '/var/www/html/dolibarr'
</source>

====Répertoire de documents====
Toujours en root, créez le répertoire qui servira aux documents générés ou stockés par Dolibarr (factures pdf, images, ...), et attribuez lui comme propriétaire, l'utilisateur du serveur web (exemple www-data sur Debian, nobody sur une vieille RedHat, apache sur une Mandriva, Mageia ou une RedHat récente, ...). Le serveur web doit avoir les droits en écriture dans ce répertoire. Il faut choisir un répertoire en dehors de la racine du site web. Par exemple "/var/lib/dolibarr/documents"
<source lang="bash">
$ mkdir -p /var/lib/dolibarr/documents ; chown www-data /var/lib/dolibarr/documents
</source>

====Installation====

*Pointez votre navigateur sur la page principale

<source lang="ini">
http://127.0.0.1/dolibarr/htdocs/
</source>

*Suivez les instructions de l'installation

*Pour des raisons de sécurité nous vous conseillons, une fois l'installation terminée, de créer un fichier install.lock dans le répertoire dédiés aux documents, que seul root doit avoir le droit d'effacer. Ceci va verrouiller la procédure d'installation qui ne pourra plus être appelée par erreur (Il faudra le supprimer pour les mises à jour).

<source lang="bash">
$ touch /var/lib/dolibarr/documents/install.lock; chmod go-w /var/lib/dolibarr/documents;
</source>

==Sur un hébergement mutualisé (à accès restreint)==
Certains hébergeurs proposaient une installation "en un clic" (OVH par exemple) : ils ont pour la plus part abandonné car trop questionnés pour des questions d'utilisation/administration : ils vous renverront maintenant vers ce wiki ou vers le forum dolibarr.

Procédure générique:

- '''Prerequis''':
Un serveur web Apache, PHP et une base de donnée (MySQL ou PostgreSQL) tourne correctement et le compte login/mot de passe (de la nouvelle base de donnée ou d'administration du serveur) est connu (sinon les demander à l'hébergeur).

- '''Niveau''': Utilisateurs avec quelques notions d'administration Web and base de donnée. Maitrise d'un outil de transfert de fichier (FTP, SFTP, ...) pour uploader les fichiers sur le serveur.

*Vérifiez que vous avez un serveur Web Apache, PHP et une base de donnée (MySQL ou PostGreSQL) qui fonctionne correctement.

[[File:warning.png]] Attention, la page de code du serveur PHP et de la base de donnée doivent être identique.

*Vérifiez que vous avez un compte root ou administrateur avec login/mot de passe connu et que ces comptes fonctionnent. Si inconnu, demandez les à votre hébergeur.

*Récupérer l'archive de la dernière version stable de Dolibarr et décompressez la localement..

*Uploadez tout le contenu du répertoire dans le répertoire racine de votre site web, par exemple par FTP en mode binaire. NB : seul le contenu de htdocs est nécessaire au fonctionnement de dolibarr)

*Créez un répertoire nommé "documents", dans cette racine, qui servira à sauver tous les documents générés et stockés par Dolibarr (factures PDF, images uploadées, ...). Le serveur web doit avoir les permissions d'écrire dedans. Vous pouvez attribuer ces permission avec un client FTP.

*Maintenant appeler la page principale index.php de dolibarr avec votre navigateur.

*Suivez les instructions pas à pas du processus d'installation.

*Pour des raisons de sécurité, il est recommandé, une fois l'installation terminée, de créer un fichier install.lock dans le répertoire de Dolibarr. Ceci verrouillera l'appel au processus d'installation (il vous faudra supprimer ce fichier pour permettre les mise à jour). Si ceci n'est pas fait, Dolibarr vous affichera un warning lorsque vous êtes loggués comme administrateur.

==Sur un hébergeur SaaS ou Cloud==
Dolibarr est aussi disponible en version "pré-installée" chez de nombreux hébergeurs payants, fournissant des instances hébergées "prêtes à l'emploi".

Voir la page [[Solutions de Cloud]].

Dolibarr peut aussi être installé manuellement sur toute plateforme Cloud (gratuite ou payante) qui supporte le PHP et Mysql.

Voir la page [[Installation - Mise à jour]]

=Configuration=

==Premiers paramétrages==
Voir la page [[Premiers_paramétrages|Configuration/Paramétrage]].

==Configurer une connexion LDAP==
Si vous désirez utiliser LDAP: Voir [[Installer et configurer OpenLDAP]].

=Importer des données externes=
Pour cette opération, consulter la page [[Imports_de_masse]].

=Procédure de mise à jour=
Ce chapitre décrit le processus pour mettre à niveau une installation existante de Dolibarr d'une ancienne version vers une autre. Le processus est le même quel que soit la version depuis laquelle vous venez et la version vers laquelle vous allez, mais sera différent selon la distribution ou système d'exploitation utilisé pour votre première installation. Il est recommandé d'utiliser le même type de distribution pour la mise à jour que celle utilisée pour la première installation.

==Sauvegarde avant mise à jour==

Avant de faire une mise à jour, il est recommendé de faire un sauvegarde de la base de donnée mais aussi des documents, de cette façon même en cas de catastrophe vous ne perdrez pas vos précieuses données
https://wiki.dolibarr.org/index.php/Sauvegardes

Note : (facultatif mais recommandé)

Il est préférable de supprimer les anciens script (et les programmes s'ils sont inclus dans l'archive téléchargée) avant de déployer les nouveaux: des anciens fichiers pourraient rester dans la novuelle installation, causant bug ou dysfonctionnement.

Avant d'effacer quoi que ce soit, penser à sauvegarder les scripts spécifiques de votre installation:

* /custom si vous avez des modules externes (dolistore) -> assurez vous que vos modules sont compatibles avec la nouvelle version avant de mettre à jour !
* /conf/conf.php : les principaux paramètres de dolibarr
* Vos modèles et/ou script php personnalisés (il est recommandé de reporter vos modifications dans les nouveaux fichier car les votres sont basées sur l'ancienne version)

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

Si vous aviez installé la version de Dolibarr spécifique nommé DoliWamp (qui embarque le serveur Web, PHP et Mysql), la procédure à suivre est celle-ci (Dans tout autre cas, utilisez une des procédures des chapitres suivant):

*Télécharger la nouvelle version de DoliWamp.

*Lancer le .exe et laissez vous guider dans toutes les étapes de migration en cliquant suivant,suivant,... à chaque fois sans rien changer aux valeurs proposées par défaut.

*Au premier accès de Dolibarr, l'application détectera que vous avez une base en version ancienne. Choisissez le menu proposé pour migrer à la version supérieure. Si vous avez fait un saut de plusieurs version, garder le choix proposer de migrer d'une seule version, à la fin le menu vous sera reproposé pour migrer à la suivante et ainsi de suite jusqu'à atteindre la version qui a été installé (par si vous avez installer Dolibarr 3.5 par dessus votre version courante qui était Dolibarr 3.2, choisissez le menu de migration pour passer de 3.2 à 3.3, puis 3.3 à 3.4 puis 3.4 à 3.5).

==[[File:Logo_ubuntu.png]] Avec DoliDeb (package Debian / Ubuntu .deb)==
Si vous aviez installé Dolibarr via un packagage Debian-Ubuntu, sa mise a jour se fait simplement de la même manière qu'une première installation. Il suffit d'installer le nouveau package .deb.
Par exemple en suivant la procédure [[Dolibarr pour Ubuntu ou Debian]].

*Au premier accès de Dolibarr, l'application détectera que vous avez une base en version ancienne. Choisissez le menu proposé pour migrer à la version supérieure. Si vous avez fait un saut de plusieurs version, garder le choix proposer de migrer d'une seule version, à la fin le menu vous sera reproposé pour migrer à la suivante et ainsi de suite jusqu'à atteindre la version qui a été installé (par si vous avez installer Dolibarr 3.5 par dessus votre version courante qui était Dolibarr 3.2, choisissez le menu de migration pour passer de 3.2 à 3.3, puis 3.3 à 3.4 puis 3.4 à 3.5).

==[[File:Logo_rpm.png|40px]] Avec DoliRpm (package Fedora, Redhat, Mandriva, Mageia ou OpenSuse .rpm)==
Si vous aviez installé Dolibarr via un packagage rpm, sa mise a jour se fait simplement de la même manière qu'une première installation. Il suffit d'installer le nouveau package .rpm.

*Au premier accès de Dolibarr, l'application détectera que vous avez une base en version ancienne. Choisissez le menu proposé pour migrer à la version supérieure. Si vous avez fait un saut de plusieurs version, garder le choix proposer de migrer d'une seule version, à la fin le menu vous sera reproposé pour migrer à la suivante et ainsi de suite jusqu'à atteindre la version qui a été installé (par exemple si vous avez installé Dolibarr 3.5 par dessus votre version courante qui était Dolibarr 3.2, choisissez le menu de migration pour passer de 3.2 à 3.3, puis 3.3 à 3.4 puis 3.4 à 3.5).

==[[File:Gnu.png]] Avec Dolibarr (package standard .zip)==

Cette procédure décrit la mise à jour de Dolibarr depuis une ancienne version vers une plus récente par la méthode manuelle, avec la distribution standard.

===Cas d'un hébergement où vous disposez d'un accès SSH===

*Placez-vous dans le répertoire dans lequel a été installé Dolibarr (le répertoire racine de votre serveur web, par exemple /var/www sous Debian)

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

*Récupérez l'archive de la nouvelle version (ex: 12.0.4)

<source lang="bash">
$ wget 'https://sourceforge.net/projects/dolibarr/files/Dolibarr ERP-CRM/12.0.4/dolibarr-12.0.4.zip'
</source>

*Décompressez l'archive

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

*Recopiez les nouveaux fichiers (qui ont été décompressés dans le répertoire dolibarr-x.y.z) vers le répertoire où vous avez votre ancienne version de Dolibarr. Ceci a pour effet de remplacer les anciens fichiers par les nouveaux tout en conservant les fichiers qui vous sont spécifiques (comme le fichier conf.php ou encore vos modules complémentaires non officiels installés).
*Si vous déplacez ou renommez également le dossier de votre ancienne version de Dolibarr, pensez à modifier les chemins dans le fichier '''conf/conf.php''' (sinon vous risquez un fatal error: Cannot redeclare versiontostring)

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

*Vous pouvez alors supprimer le répertoire des fichiers sources

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

*Lancer Dolibarr dans votre navigateur habituel. Ceci fera apparaître l'assistant de migration: L'application détectera que vous avez une base en version ancienne. Choisissez le menu proposé pour migrer à la version supérieure. Si vous avez fait un saut de plusieurs versions, garder le choix proposé de migrer d'une seule version, à la fin le menu vous sera reproposé pour migrer à la suivante et ainsi de suite jusqu'à atteindre la version qui a été installée (par si vous avez installé Dolibarr 3.5 par dessus votre version courante qui était Dolibarr 3.2, choisissez le menu de migration pour passer de 3.2 à 3.3, puis 3.3 à 3.4 puis 3.4 à 3.5).

ou

Lancer les 3 étapes de migration en ligne de commande:
<source lang="bash">
$ cd htdocs/install
$ php upgrade.php oldx.oldy.oldz x.y.z > output.html
$ php upgrade2.php oldx.oldy.oldz x.y.z > output2.html
$ php step5.php oldx.oldy.oldz x.y.z > output3.html
</source>
Note: z doit être "0" car seules les versions majeures ont un script de migration à exécuter.

Le code retour sera 0 en cas de succès, 1 en cas d'erreur (voir alors le fichier sortie output.html ou output2.html)

Note: Si vous avez un message signalant que le processus de mise à jour est verrouillé par un fichier install.lock, supprimer ce fichier (il est stocké dans le répertoire racine ou "documents" de Dolibarr) puis rafraîchissez la page.

*Pour des raisons de sécurité nous vous conseillons, une fois la mise à jour terminée, de verrouiller le répertoire d'installation en créant un fichier install.lock dans le répertoire de donnée de Dolibarr. Dans le cas contraire, Dolibarr vous avertira d'un message dans l'interface une fois connecté

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

===Cas d'un hébergement sans accès SSH (mutualisé)===
Cette procédure a été vérifiée pour les mises à jours mineures de v10.0, soit v10.0.n vers v10.0.m (m > n). Dolibarr est installé sur un hébergement mutualisé que l'on peut paramétrer par une interface dédiée et à laquelle on accède par ftp/sftp.

La mise à jour pourra prendre de 2 à 4 heures en fonction de votre bande passante internet. Dolibarr sera inaccessible à tous les utilisateurs entre les étapes 3 et 6.

Chaque étape doit être réalisée dans l'ordre. L'interruption du processus est possible entre chaque étape.

====Étape 1 - Téléchargement de la nouvelle version====
Téléchargez l’archive de la nouvelle version sur votre disque local.

Décompressez l’archive de la nouvelle version sur le disque local.

====Étape 2 - Sauvegarde de votre installation actuelle====
Se reporter à la page [[Sauvegardes]].

=====À partir de votre interface d'administration Dolibarr, sauvegardez :=====

*le répertoire <code>/documents</code>,
*la base de donnée.

Les fichiers de sauvegarde créés sont enregistrés dans votre répertoire /documents.

=====Récupération de la sauvegarde distante (obligatoire, le fichier conf.php sera réutilisé plus tard)=====
Copier les répertoires distants suivants sur votre disque local :

*<code>/documents</code>,
*<code>/htdocs/conf</code> (pour sauver <code>conf.php</code>).

====Étape 3 - Mettre le site hors ligne====
Rendez l'accès à Dolibarr impossible à vos utilisateurs. Dans la plupart des cas, votre hébergement permet de rendre votre site hors ligne. Il ne sera plus accessible via un navigateur. Vous aurez toujours accès aux répertoires via votre logiciel ftp.

====Étape 4 - Supprimez l'ancienne version sur le serveur====
Avec votre logiciel ftp, '''supprimez''' les fichiers et répertoires suivants :

*les fichiers à la racine de votre répertoire distant,
*install.lock dans le répertoire <code>/documents</code> (s'il existe),
*les répertoires :
**<code>/build</code>,
**<code>/dev</code>,
**<code>/doc</code>,
**<code>/htdocs</code>,
**<code>/scripts</code>.

Il ne doit plus rester que le répertoire <code>/documents</code> dans votre espace distant.

====Étape 5 - Envoyer les nouveaux fichiers sur le serveur distant====
Avec votre logiciel ftp, '''envoyer''' :

*tous les fichiers et répertoires de l'archive décompressée de la nouvelle version,
*<code>config.php</code> de votre sauvegarde dans <code>/htdocs/config</code>

====Étape 6 - Lancer la mise à jour====
Remettre votre site en ligne.

Avec votre navigateur, connectez-vous à votre instance Dolibarr avec l'URL que vous utilisez habituellement (généralement : ''<nowiki>https://monsite.re/htdocs/index.php</nowiki>''). Dolibarr détecte la présence de fichiers d'une nouvelle version. Il lance le processus de mise à jour.

À l'issue de ce processus, vous arrivez sur votre page de connexion habituelle. Vous noterez que le numéro de votre nouvelle version sera indiqué au-dessus du formulaire de connexion.

====Étape 7 - Opération de sécurité finale====
'''Envoyer''' <code>install.lock</code> depuis votre sauvegarde dans le répertoire <code>/documents</code>.

=Vidéos sur le sujet=
Installation en local :

<youtube width="200" height="120">N0iweN8ukVU</youtube>

Installation sur serveur distant Infomaniak :

<youtube width="200" height="120">jsi1D4L1WAI</youtube>

Installation et migration vers V15 en local :

<youtube width="200" height="120">LKdQvRVxYKs</youtube>

Módulo Usuarios

2022-10-30T07:58:25Z

Techsc: /* Videos */ Agregando un video (no en el lengua de la pagina pero es mejor que nada y puede ayudar)

[[en:Module_Users]]
[[fr:Module_Utilisateurs]]
[[de:Modul_Benutzer]]


[[Category:Usuarios]]
[[Category:Listado de Módulos]]
{{TemplateDocUsuario}}
{{TemplateModES}}
{{BasculeDevUsuario|
nom=Usuarios|
num=0|
devdoc=[[Módulo Usuarios (desarrollador)]]|
userdoc=Esta página|}}

= Introducción =
El módulo usuarios es un módulo obligatorio. Es el único módulo de Dolibarr que no puede ser desactivado. Su función es la de gestionar en Dolibarr las siguientes entidades:
* Usuarios de Dolibarr
* Grupos de usuarios de Dolibarr

= Instalación =
{{NoInstallModuleEs}}

= Configuración =
No existe ninguna configuración en particular para este módulo.

= Ciclo de vida /Reglas de gestión =
Un usuario '''interno''' es un usuario que pertenece a su empresa/institución.

Un usuario '''externo''' es un usuario cliente, proveedor u otro.

En los 2 casos, los permisos de usuario indican los derechos de acceso, pero el usuario externo puede tener un gestor de menú diferente al del usuario interno (Ver Inico - Configuración - Entorno).

== Crear un usuario interno ==
Ir al menú Inicio -> Usuarios y grupos -> Nuevo usuario.

== Crear un usuario externo ==
Para crear un usuario externo, vaya a la ficha de un tercero, seguidamente haga click en el botón "Crear usuario".

== Definir los permisos ==
Ir a la pestaña "Permisos usuario" de la ficha usuarios y haga click en el + o en el - para dar o quitar el permiso

Tenga en cuenta que un usuario sin permisos heredará todos los permisos de los grupos a los que pertenezca.

= Videos =
<youtube width="280">Qroo4w8ybHU</youtube>

Los usuarios (no los grupos) :
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="280">Xrf16rs2gG8</youtube>

First setup

2022-10-30T07:55:48Z

Techsc: /* Related videos */ Revision de la taille de la vidéo

[[fr:Premiers_paramétrages]]
[[de:Grundeinstellungen]]
[[es:Primeras_configuraciones]]
[[zh:设置]]


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

After completing the initial installation, you must configure parameters in Dolibarr to match your needs.

=Company/Organization=
The first mandatory step is to define your company/organization information. For this, from home page, choose menu "'''Home->Setup->Company/Organization'''" and add the information for your company/organization.

*'''Name:''' Name of your company/organization
*[[File:Logo size.jpg|thumb]]'''Logo:''' Add here a logo of your company (.png, .jpg or .gif). It can accept any size but it is recommended to use a logo with 130 pixels height and up to 800 pixels width. Here is a little scheme on what will be the result on the PDF. The recommended format is png.
*'''Logo (squared):''' Add here your squared logo (.png or .jpg) that will be used in the top right corner of the application
*'''Fiscal Year:''' Define your starting month of yiscal Year
*'''Country:''' Define your country: other options depend on this selection.

*'''Prof ID X:''' The fields Prof ID are used to store the professional IDs of a company. Each country requires its own professional ID. For example, for a company in France you may find a SIRET, SIREN, NAF, RCS and EORI number, and for a company in Argentia, you will find CUIT/CUIL, Ingresos Brutos, CIF Intra. Dolibarr is able to manage 6 Professional ID. The label of each of them is defined with the translation key ProfIdXCC (where X is 1 to 6 and XX the country code of the company, for example XX=FR). To add a new Professional ID, you can add a new translation from menu Home - Setup - Translation for the key ProfIdXCC. If you set the value of translation to "-", it means that the professional ID is hidden when using the application in the language of translation on every company that has the country code XX.

*'''Sales Tax (VAT) Management:''' Define how you manage Sales Tax (or not).
*'''Second type of tax:''' Define if you would like to use second type of taxe (or not).
*'''Third type of tax:''' Define if you would like to use third type of taxe (or not).

=Modules=
[[File:List of modules en.png|alt=List of modules|thumb|List of modules]]
The activation of modules is the second mandatory step. Which modules you will activate depends on what you want to do with Dolibarr. In most cases, you may want to use all modules. You have to activate each module one by one. For example, to manage a company, you might activate at least modules Third party, Invoices, and Products, but probably many more.

To activate a module, go to page "'''Home->Setup->Modules'''" and click the button 'on/off' in the "Status" column to enable it.
*The module is '''on''' if the 'on/off' button is like [[File:On off button on.png|alt='on/off' button in on position|'on/off' button in on position]]
*The module is '''off''' if the 'on/off' button is like [[File:On off button off.png|alt='on/off' button in off position|'on/off' button in off position]]

The list of standard modules is defined on page [[:Category:List of Modules|List of Modules]].

If you are unsure of the function of a module, you may activate it and see what new menu item appears in Dolibarr (the horizontal bar), also after activating a module, check that you grant to yourself permissions on new features that were enabled. You can activate or deactivate a module when you want.

Once a module has been activated, it may need further configuration (click on the setup icon that appears on the right of module line if a module needs its own setup). See [[:Category:List of Modules|documentation of module]] for more information.

Related videos:

Modules:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">qfYP-iKWd7U</youtube>

Module settings:
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">toT0jfmMCoU</youtube>

=Display=
[[File:Display settings EN.png|alt=Display settings|thumb|Display settings]]
On this page, you can set the default language of application and the look and feel of screens. In a first use, you can keep everything with default values.

==Language==
In the language settings, you can set the Default Language. By default it is set to "Auto Detect".
''Note:'' Activating multilanguage option will allow you to be able to set the preferred language of customers, to print their Invoice/Proposal/Order in their own language. Product translations will also be available.

==Default skin theme==
In Dolibarr you have two different skins :
* eldy [[File:Eldy Theme thumb.png]]
* md [[File:Md theme thumb.png]]
More skins can be downloaded on the dolistore [https://www.dolistore.com/4-skins]
 
You can also personalize the skin color, and look in this setup

==Miscellaneous==
On this section, you have all the default values of features like, javascript functions, length of lists, first day of the week, etc.
 
You can also put a "Message of day" that will be displayed for all the users. In this message, you can use the [[Variable substitution system]]

==Login page==
On this section, you can customize the login page with a message and a background image. In this message, you can use the [[Variable substitution system]]
 
It is also possible to hide/show the "'''Need help or support'''" link on login page

=Menus=
[[File:Menu Setup.png|alt=Menu Setup|thumb|Menu Setup]]
Choose here which menu manager you want to use for internal and external users and for computer or smartphone. The menu manager changes the labels, orders and organization of the left and top menus.
See page [[Menus system]] for more information.

==Menu handlers==
The software comes with two different menu handler :
* Eldy : It is the default menu, the menu entries are centralized and hard coded. You can add entries on this menu but not change the default menu entries.
* Auguria : It is a database menu manager. This menu can be fully customized to your needs.
In the Menu handlers tab, you can choose the menu for internal and external users and for computer or smartphone.

==Menu Editor==
In this tab, you can customize each menu entry of '''auguria''' menu or the additional entries of '''eldy '''menu and create new entries

==Miscellaneous==
In this tab, you can choose the behavior of the unauthorized menu entry. By default, the unauthorized menu entry are in gray, but can be hidden.

=Other (Widgets, Alerts, Security, Limits and accuracy, Emails, SMS, Dictionary setup...)=
Other entries in Setup menu are advanced options. You can ignore them if you want.

*[[Setup Translation]]
*[[Setup Default values/filters/sorting]]
*[[Setup Widgets]]
*[[Setup Alerts]]
*[[Setup Security]]
*[[Setup Limits and accuracy]]
*[[Setup PDF]]
*[[Setup EMails]]
*[[Setup SMS]]
*[[Setup Dictionnary|Setup Dictionary]]
*[[Setup Other]]

=Users=
The last step is to create users and assign permissions. Almost all the modules even activated earlier, are not accessible if you do not give permissions. To do this, you can go to the menu '''Home -> Users & Groups''' to define users and their rights. Attention, you should consider to check and reset the user rights when you enable a new module. The list of rights available depends on the activated modules (see above). It is recommended to configure permissions after activating the modules you want to use. For certain actions, if you do not have the rights to do an action, Dolibarr will not show you the action. You might miss some useful or important features. '''To give rights to a user or yourself, if you are an administrator, go to Home -> Users & Groups, select the desired user, then click on its 'Permission' tab.'''

You can avoid these configuration steps for each newly created user, by configuring the default rights (understand rights allocated automatically each time a new user created) by configuring the default permissions on the menu [[Setup Security]].

=Related videos=
Basic setup :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">S5Rm9ixHNRA</youtube>

Configuration options :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">o5VOYomd_Ns</youtube>

Visual setup : Darkmode :
(vocal in french but subtitles are available and review in this language)

<youtube width="200" height="120">cdhWVmTg54U</youtube>

Primeras configuraciones

2022-10-30T07:54:59Z

Techsc: /* Videos */ Révision de la taille des vidéos

[[en:First_setup]]
[[fr:Premiers_paramétrages]]
[[de:Grundeinstellungen]]
[[pt:Configuração_inicial]]
[[zh:设置]]


[[Category:Admin es]]
{{TemplateDocUsuario}}

Después de la instalación de Dolibarr, debe establecer los parámetros para adaptar Dolibarr a sus necesidades antes de su puesta en funcionamiento.

= Empresa/Institución =
Para empezar, desde la página principal, vaya a "'''Configuración->Empresa/Institución'''" y edite la información de su institución.
* '''Nombre:''' Nombre de la empresa o asociación
* '''Logo:''' Añada aquí su logo (.png, .jpg or .gif). No hay recomendación de tamaño, pero es mejor un formato png SIN fondo transparente (Dolibarr usa FPDF que no gestiona ese tipo de fichero). En caso de duda, utilice un logotipo en formato jpg con un fondo blanco.
* '''País''' No olvide indicar su país, ya que algunas opciones dependen de ello.
* '''IVA:''' Indique si usted se encuentra sometido o no a IVA.

= Módulos =
La activación de los módulos es muy importante. Depende de lo que planee hacer con Dolibarr. Es muy poco probable que usted necesite todos los módulos.
Debe activar los módulos que probablemente necesite. Por ejemplo: Empresas, Facturas, Contabilidad.

Para activar los módulos que necesite, vaya a la página "'''Configuración -> Módulos'''" y haga click en el link "Activar" en cada módulo que necesite.

El listado de módulos estándar está disponible en la página [[:Category:Listado de Módulos|Listado de Módulos]].

Si no está seguro de que módulos activar, vaya uno tras otro y vea las características que ofrecen en Dolibarr (compruebe los derechos, ver más adelante). Por supuesto, es posible deshabilitar los módulos después.

Una vez activados, algunos módulos requieren configuración adicional (haga clic en el icono que aparece en la misma línea).
Véase [[:Category:Listado de Módulos|Listado de Módulos]] para más información.

Videos:

Los módulos:

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">qfYP-iKWd7U</youtube>

Configuración de los módulos:

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">toT0jfmMCoU</youtube>

= Menús =
Elija en esta sección que gestor de menús usar para los usuarios internos y externos. El gestor de menú influye en las etiquetas, orden y organización de los menús superiores e izquierdos. Vea la página [[Sistema de menús]] para más información.

= Entorno =
Esta sección le permite elegir el idioma y la presentación de páginas. Como primer paso debería mantener las opciones por defecto.

La opción multi-idioma permite gestionar las traducciones para cada idioma de los productos, así como la elección del idioma por defecto de los terceros, con el fin de crear los documentos PDF en el idioma por defecto del tercero

= Otros (Paneles, Alertas, Seguridad, Límites y precisiones, E-Mails, Diccio...)=
Las otras entradas en el menú de configuración son opciones avanzadas.
No es obligatorio ir.
* [[Configuración Paneles]]
* [[Configuración Alertas]]
* [[Configuración Seguridad]]
* [[Configuración Límites y precisiones]]
* [[Configuración PDF]]
* [[Configuración E-Mails]]
* [[Configuración SMS]]
* [[Configuración Diccionarios]]
* [[Configuración Varios]]

= Usuarios =
El último paso es crear los usuarios. Casi todos los módulos, previamente activados, no son accesibles si no les damos el permiso.
Para hacer esto, usted puede ir a los '''Usuarios y Grupos''' para identificar a los usuarios y sus derechos. Atención, tenga en cuenta la definición de los derechos de los usuarios, y también las comprobaciones en el momento de agregar un módulo.
La lista de derechos adquiridos depende de los módulos activados (véase más arriba), por lo que se recomienda que configure esta después de activar los módulos deseados.
Para algunas acciones, si no se tiene el derecho a una acción, Dolibarr no se lo propondrá. Es posible que pierda algo útil y / o importante.
A fin de dar derechos a un usuario o a usted mismo si es un administrador, vaya a '''Inicio->Usuarios y grupos''', escoja la ficha del usuario deseado y haga clic en la pestaña '''Permisos usuario'''.

=Videos=

La configuración básica :

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">S5Rm9ixHNRA</youtube>

Los opciones de configuración :

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">o5VOYomd_Ns</youtube>

La configuración visual : Darkmode :

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">cdhWVmTg54U</youtube>

Premiers paramétrages

2022-10-30T07:53:42Z

Techsc: /* Vidéos sur le sujet */ Révision de la taille des vidéos

[[en:First_setup]]
[[de:Grundeinstellungen]]
[[pt:Configuração_inicial]]
[[es:Primeras_configuraciones]]
[[zh:设置]]


[[Category:Admin fr]]
{{TemplateDocUtil}}

Après l'installation proprement dite de Dolibarr, vous devez le paramétrer pour l'adapter à vos besoins avant de l'utiliser réellement.

=Société/Institution=

Pour commencer, à partir de la page d'accueil, rendez-vous dans le menu "'''Configuration -> Société/Institution'''" et éditez les informations de votre institution.

*'''Nom:''' Nom de la société ou association
*[[File:Logo size.jpg|thumb]]'''Logo:''' Ajouter ici votre logo (.png, .jpg or .gif). Le logiciel accpete toutes les tailles mais il est recommandé d'utiliser un logo de 130 pixels de hauteurs et jusqu'à 800 pixels de largeur. Voici un petit schéma de ce que cela peut donner sur les documents PDF. Il vaut mieux un format png SANS fond transparent (Dolibarr utilise FPDF qui ne gère pas ce genre de fichier). Dans le doute, utilisez un logo au format jpg sur fond blanc.
*'''Pays:''' N'oubliez pas de définir votre pays car des options en dépendent
*'''TVA:''' Définissez si vous êtes soumis ou non à la TVA.

=Modules=

L'activation des modules est très importante. Elle dépend de l'utilisation que vous prévoyez de faire de Dolibarr. Il est très peu probable que vous ayez besoin de la totalité des modules.
Il vous faut donc activer les modules dont vous aurez très probablement besoin. Par exemple: Sociétés, Factures éventuellement Comptabilité.

Pour activer les modules qui vous intéressent, rendez-vous dans le menu "'''Configuration -> Modules'''" et cliquez sur le lien "Activer".

La liste des modules standards est définie sur la page [[:Category:Liste des Modules|Liste des Modules]].

Si vous n'êtes pas sûr de vous, activez les modules les uns après les autres et voyez les fonctionnalités qu'ils ajoutent dans Dolibarr (vérifiez avant les droits, voir ci-dessous). Il est bien sûr possible de désactiver des modules après coup.

Une fois activés, certains modules nécessitent une configuration supplémentaire (cliquer sur l'icône qui apparait tout à droite sur la même ligne). Voir la [[:Category:Liste des Modules|documentation du module]] pour plus d'information.

Vidéos sur le sujet:

Les modules:

<youtube width="200" height="120">qfYP-iKWd7U</youtube>

Le paramétrage des modules:

<youtube width="200" height="120">toT0jfmMCoU</youtube>

=Menus=
Choisissez dans cette rubrique quel gestionnaire de menu utiliser pour les utilisateurs internes et externes. Le gestionnaire de menu influe sur les libellés, ordres et organisation des menus haut et gauches. Voir la page [[Système de menus]] pour plus d'information.

=Affichage=

Cette partie vous permet de choisir la langue et la présentation des pages. Dans un premier temps vous devriez conserver les options par défaut.

L'option multilangue permet de gérer différente traduction pour la traduction des produit par exemple, ainsi que de choisir la langue par défaut des clients afin d'éditer les documents PDF dans la langues par défaut du tiers. Une synthèse des paramétrages à effectuer à la suite de l'activation de l'option multilangue est disponible sur la page dédiée : [[Mode multilangue]]

copie d'écran

[[File:Configuration_-Affichage_2018.jpg]]

=Autres (Boites, Alertes, Sécurité, Limites et précisions, EMails, Dico...)=
Les autres entrées du menu Configuration sont des options avancées. Il n'est pas obligatoire de les parcourir.

*[[Paramétrage Traduction]]
*[[Paramétrage Valeurs par défaut]]
*[[Paramétrage Boites]]
*[[Paramétrage Alertes]]
*[[Paramétrage Sécurité]]
*[[Paramétrage Limites et précisions]]
*[[Paramétrage PDF]]
*[[Paramétrage EMails]]
*[[Paramétrage SMS]]
*[[Paramétrage Dictionnaires]]
*[[Paramétrage Divers]]

=Utilisateurs=
La dernière étape consiste à créer les utilisateurs et à attribuer les permissions.
Presque tous les modules, même activés précédemment, ne sont pas accessibles si on n'en donne pas la permission.
Pour cela, vous pouvez vous rendre dans le menu '''Accueil -> Utilisateurs & Groupes''' pour définir les utilisateurs et leurs droits. Attention, il faudra penser à vérifier et redéfinir les droits utilisateurs quand vous activerez à nouveau de nouveaux modules.
La liste des droits disponibles dépendant des modules activés (voir plus haut) et des permissions par défaut, il est recommandé de configurer cette partie après avoir activé les modules désirés.
Pour certaines actions, si vous n'avez pas les droits pour faire une action, Dolibarr ne vous la proposera pas. Vous risquez de rater des choses utiles et/ou importantes.
Pour donner les droits à un utilisateur ou vous-même si vous êtes administrateur, aller dans '''Accueil -> Utilisateurs & Groupes''', choisissez la fiche de l'utilisateur désiré, puis cliquer sur l'onglet '''Permission'''.

Il est possible d'éviter ces étapes de configuration à faire pour chaque nouvel utilisateur en configurant les droits par défaut (comprendre droits attribués automatiquement à chaque nouvel utilisateur créé), en configurant les permissions par défaut sur la page [[Paramétrage_Sécurité]].

=Vidéos sur le sujet=
Configuration basique :

<youtube width="200" height="120">S5Rm9ixHNRA</youtube>

Options de configuration :

<youtube width="200" height="120">o5VOYomd_Ns</youtube>

Configuration visuelle : Darkmode :

<youtube width="200" height="120">cdhWVmTg54U</youtube>

Módulo Presupuestos

2022-10-30T07:51:37Z

Techsc: /* Videos */ Agregando un video (no en el lengua de la pagina pero es mejor que nada y puede ayudar)

[[en:Module_Commercial_Proposals_-_Quotes]]
[[fr:Module Propositions commerciales - Devis]]
[[de:Modul_Angebote]]


[[Category:Presupuestos]]
{{TemplateDocUsuario}}
{{TemplateModES}}
{{BasculeDevUsuario|
nom=Presupuestos|
num=20|
devdoc=[[Módulo Presupuestos (desarrollador)]]|
userdoc=Esta página|}}

= Introducción =
Podríamos decir que un presupuesto es una estimación.

= Instalación =
{{NoInstallModuleEs}}

= Configuración =
{{ActivationModuleEs}}

= Ciclo de vida / Reglas de gestión =

Cuando se crea un Presupuesto, su primer estado es Borrador, a la espera de ser validado. Una vez que ha sido validado, pasa al estado Abierto, de este estado puede pasar a; no firmado, si el cliente no acepta el presupuesto acaba, su ciclo de vida. A firmado si si lo acepta, en este último caso se creará, el pedido correspondiente.

Desde la pestaña Ficha Contable, se puede crear directamente la factura del presupuesto que nos ocupa. Una vez que se ha finalizado el ciclo de vida de la factura, se debe volver al presupuesto y clasificarlo como "Facturado", para así dar por finalizado su ciclo de vida.

= Crear un presupuesto =
La creación de un presupuesto es hace desde la ficha Cliente o Clientes Potenciales en el Área Comercial. Para crear un presupuesto debe tener definido un contacto para este cliente y el [[Primeras_configuraciones#Módulos|módulo]] debe de estar activado !).

Siga las indicaciones para crear un presupuesto borrador y, a continuación, confirme cuando esté listo (contrariamente a las facturas, se puede modificar un presupuesto validado).

= Cierre de un presupuesto =
Cierre un presupuesto como firmado cuando el cliente haya dado su consentimiento. En el cierre de un presupuesto se creará un cliente en caso de que este fuera un cliente potencial y un [[Módulo Pedidos de clientes|pedido]] borrador será creado.

= Modelos =
Dolibarr puede generer muchos modelos de presupuestos, que necesitan estar activos en la configuración del módulo. Puede crear sus propias plantillas, sólo tiene que entender el lenguaje php. Los modelos de los presupuestos se encuentran en /includes/modules/propale/

= Videos =
<youtube width="200" height="120">YT9M6-oVYcg</youtube>

Los presupuestos:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">2xcEjyGFSg8</youtube>

Módulo Bancos y Cajas

2022-10-30T07:49:08Z

Techsc: Agregando un video (no en el lengua de la pagina pero es mejor que nada y puede ayudar)

[[en:Module_Banks_and_Cash]]
[[fr:Module_Banques_et_Caisses]]
[[de:Modul_Banken_und_Barbestände]]


[[Category:Banco]]
{{TemplateDocUsuario}}
{{TemplateModES}}
{{BasculeDevUsuario|
nom=Bancos|
num=85|
devdoc=[[Módulo Banco-Caja (desarrollador)]]|
userdoc=Esta página|}}

= Introduccón =
Este módulo le permite controlar una cuenta bancaria o de caja.

= Instalación =
{{NoInstallModuleEs}}

= Configuración =
{{ActivationModuleEs}}

= Definiciones =
* '''Una cuenta bancaria''' es una cuenta que tenemos en un banco (a menudo permite trabajar con cheques o pagar con tarjeta de crédito).
* '''Una caja''' es la caja de pastel de la abuela en la que ponemos el dinero, su billetera o la caja registradora de los comercios.
Al recibir un pago por cheque, es inevitable que se deposite en una cuenta bancaria , pero a partir de la recepción de dinero en efectivo, es posible almacenar los billetes en una billetera, una caja registradora (cuenta de efectivo) para dejar a un lado para ingresar al banco, etc.
Dolibarr puede crear tantas cuentas bancarias o cuentas de efectivo como se necesiten. Para la gestión de la tesorería, se tiene por lo menos una (por lo general, una cuenta bancaria, a menos que gestionen el comercio sin aceptar cheques o tarjeta de crédito y que se haga todo en efectivo: compras, ventas), pero esto es opcional. Si la tesorería no debe ser administrada por Dolibarr, el módulo Bancos/Cajas puede estar desactivado.

= Ciclo de vida / Reglas de gestión =
{{ToComplete}}

= Creación de una nueva cuenta bancaria / de caja =
Ir al menú Financiera, seguidamente a Bancos/Cajas y seleccionar "Nueva cuenta".

= Transferencias bancarias =

Tiene la opción de trasladar saldo de una cuenta/caja a otra, solo debe tener más de una registrada. Aparecerá en la lista de transacciones como un movimiento de tipo "especies" y la con la descripción que se le halla añadido en el momento de realizar la transferencia

= Eliminar / Desactivar una cuenta =
== Desactivar una cuenta ==
Para desactivar (cerrar) una cuenta, ir al menú Bancos/Cajas. Escoger la cuenta en el menú izquierdo.
Será mostrada la ficha de la cuenta.
Haga clic en el botón "Modificar" y cambie el estado a "Cerrada".

== Eliminar una cuenta ==
Atención, la eliminación de una cuenta financiera también elimina todos los sus registros. Es preferible desactivar la cuenta (ver el párrafo anterior).
Para eliminar una cuenta, ir al menú Bancos/Cajas. Escoger la cuenta en el menú izquierdo.
Será mostrada la ficha de la cuenta.
Haga clic en el botón "Eliminar" y confirme.

= Ejemplos casos de uso =
{{ToComplete}}
{{ExamplesCaseEs
|nombre=UCBC01:
|situacion=
|acciones=
}} 

=Videos=

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">9fYFWA9FXeo</youtube>

Module Banques et Caisses

2022-10-30T07:48:19Z

Techsc: Revision de la taille de la vidéo

[[en:Module_Banks_and_Cash]]
[[es:Módulo_Bancos_y_Cajas]]
[[de:Modul_Banken_und_Barbestände]]


[[Category:Banque]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Banque|
num=85|
devdoc=[[Module Banques et Caisses (développeur)]]|
userdoc=Cette page|}}

=Introduction=
Ce module permet de suivre un compte bancaire ou compte de caisse.

=Installation=
{{NoInstallModuleFr}}

=Configuration=
{{ActivationModuleFr}}

=Définitions=

*'''Un compte banque''' c'est un compte bancaire (souvent ce compte permet de faire des chèques ou de payer par carte bancaire).
*'''Une caisse''', c'est la boite à gâteau de grand-mère dans laquelle tu mets de l'argent liquide ou encore ton porte-monnaie ou encore la caisse enregistreuse pour les commerçants.

Quand on reçoit un paiement en chèque, il sera forcement déposé sur un compte bancaire (compte banque) mais en cas de réception d'argent liquide, il est possible de ranger les billets dans un porte monnaie, une caisse enregistreuse (compte caisse) comme de les mettre de coté pour les déposer à la banque.
Dolibarr permet de créer autant de comptes banque ou de comptes caisse que besoin. Pour gérer une trésorerie, il en faudra au moins un (en général compte bancaire, à moins que le commerce géré n'accepte ni chèque, ni carte bleu et que tout soit fait en liquide, achat comme vente), mais ceci reste optionnel. Si la trésorerie ne doit pas être gérée par Dolibarr, le module Banque/Caisse peut être désactivé.

=Cycle de vie / Règles de gestion=
{{ToComplete}}

=Création d'un nouveau compte bancaire / caisse=

Aller dans le menu Compta/Trésorerie puis Banque puis bouton "Créer compte".

1/ Cliquez sur le menu Banques/Caisses.

2/ Cliquez sur le bouton "Nouveau compte" dans le menu de gauche.

3/ Remplissez les détails demandés puis cliquez sur "Créer compte".

4/ Choisissez la page "Compte bancaire" et cliquez sur "Modifier" (en bas à droite) pour remplir les détails RIB etc.

5/ Vous pouvez maintenant sélectionner ce compte pour les virements dans le module "Factures et Avoirs" [login en tant qu'administrateur, menu Configuration/Modules/Modules financiers (Compta/trésorerie)]
=Suppression/Désactivation d'un compte=
==Désactiver un compte==
Pour désactiver (fermer) un compte, aller dans le menu Banques/Caisse. Choisissez le compte voulu dans la liste qui s'affiche.
La fiche du compte s'affiche alors.
Cliquez sur le bouton "Modifier" et changer le statut à "Fermé".

Il sera possible de réactiver le compte à tout moment plus tard. Pour cela, aller dans le menu Banque - Compte bancaire pour afficher la liste des comptes bancaires ouverts. Choisissez "Clôturé" à la place de "Ouvert" puis cliquez sur la loupe afin de faire apparaître les comptes fermés. Cliquer sur son nom affiche la fiche du compte. Puis le bouton "Modifier" pour changer son statut.

==Supprimer un compte==
Attention, la suppression d'un compte financier efface le compte mais aussi tous les enregistrements rapprochés dessus. La plupart du temps, on préférera juste désactiver le compte (voir paragraphe précédent).
Pour supprimer un compte, aller dans le menu Banques/Caisse. Choisissez le compte dans la liste des comptes ouverts (Si le compte est fermé choisissez "Clôturé" à la place de "Ouvert" puis cliquez sur la loupe ).

La fiche du compte s'affiche alors.
Cliquez sur le bouton "Supprimer" et confirmez.

=Exemples de cas d'utilisations=
{{ToComplete}}
{{ExamplesCaseFr
|nom=UCBC01:
|situation=
|actions=
}} 

=Vidéos sur le sujet=

<youtube width="200" height="120">9fYFWA9FXeo</youtube>

Módulo Facturas a clientes

2022-10-30T07:46:21Z

Techsc: /* Videos */ Agregando un video (no en el lengua de la pagina pero es mejor que nada y puede ayudar)

[[en:Module_Customers_Invoices]]
[[fr:Module_Factures_Clients]]
[[pt:Módulo_Faturas_de_Clientes]]


[[Category:Facturas]]
{{TemplateDocUsuario}}
{{TemplateModES}}
{{BasculeDevUsuario|
nom=Facturas|
num=30|
devdoc=[[Módulo Facturas a clientes (desarrollador)]]|
userdoc=Esta página|}}

= Introducción =
El módulo de facturas a clientes permite capturar, editar o crear una factura, compuesta de líneas de facturas. Este es también el módulo que le permite introducir los pagos realizados de una factura. Este módulo también incluye las funciones para generar una factura como un documento en formato PDF.
Las facturas de proveedores son gestionadas por el módulo [[Módulo Facturas de proveedores]] .

= Instalación =
{{NoInstallModuleEs}}

= Configuración =
{{ActivationModuleEs}}

La página [[ConfiguracionFactura|configuración factura]] explica cómo configurar el módulo de facturación y da algunos ejemplos de modelos de facturas.

= Creación de una factura =

En esta fase de desarrollo Dolibarr no incluye una verdadera contabilidad en el sentido legal. Hay que usar conjuntamente un programa de software de contabilidad, o encargar la contabilidad a una asesoría.

Sin embargo Dolibarr le permite emitir facturas a los clientes registrados (ver [[Módulo Terceros]]).

Puede crear una factura directamente desde una ficha de cliente o a partir de un pedido cerrado con estado "aceptado" o de un contrato de servicios.

'''Tipos de facturas'''

Si crea una factura de una ficha de cliente, puede elegir 4 tipos facturas:

* Factura estandard
Es una factura estandard
No exige ningún requisito previo.

* Factura rectificativa
Una factura rectificativa permite rehacer una factura sobre la que existen errores y sobre la que nada se hubiera realizado (antes del pago).

Solamente se puede crear una factura rectificativa para cada factura estandard. Cuando creamos una factura rectificativa R, se elige la factura F a sustituir. Entonces no será posible realizar acciones sobre la factura F, esto último no cambia después de que la factura rectificativa R haya sido creada con estado '''borrador'''.

Si la factura rectificativa R se elimina, la factura F vuelve a su estado inicial y el ciclo de vida de la factura F puede reanudarse.

Si la factura rectificativa R es '''validada''',la factura F pasa entonces al estado '''abandonada''' automáticamente. El ciclo de vida continúa en la factura R.

* Las facturas de abono
Creamos una factura de abono sobre una factura estandard.
Se pueden crear varias facturas de abono sobre una factura estandard. La factura de abono se transforma en reducción que se utilizará para reducir el pago de cualquier otra factura pendiente de pago.

* Las facturas de anticipo
Puede crear las facturas de anticipo que desee. Una factura de anticipo se convertirá en una reducción (ya pagada) para otra factura (la factura definitiva) a la que se le aplicará el anticipo.

'''Procedimiento'''

Una vez la factura se haya creado (en modo ''borrador''), debe introducir en la factura los productos y servicios dados de alta en Dolibarr o bien introducir directamente la descripción, el IVA, el precio unitario.
Para cada línea de la factura se debe definir también la cantidad y eventualmente un descuento.

Una vez la factura esté terminada debe validarse. '''Atención''' esta operación es irreversible. Cuando se valida una factura se le atribuye un número según el modelo de numeración indicada en la configuración del módulo Factura. Si se detecta algún error después de la validación de la factura, habrá que sustituirla por una factura rectificativa o bien por una factura de abono.

= Generación PDF, Impresión =

A completar...
Cuando un documento se genera, es fabricado a partir de un diseño elegido de una lista en la pantalla Inicio - Configuración - Módulos - Factura

= Realizar pagos =

A completar...

Los pagos solamente se pueden efectuar sobre facturas validadas.

Si hay disponible un abono, podrá imputarse sobre una factura con un importe total inferior al del abono.

= Clasificar la factura =
Una factura validada puede ser clasificada definitivamente al estado:
* Pagada (Si la suma de los pagos es igual o superior al importe reclamado).
* Pagada parcialmente (Si la suma de los pagos es superior a 0 pero inferior al importe reclamado).
* Abandonada (Si no se ha recibido pago alguno).

= Exportar las facturas =

Dolibarr proporciona una herramienta genérica que le permite exportar los datos de sus facturas.
Para ello, utilice el asistente para exportación, que se encuentra en el menú '''Utilidades - Nueva exportación'''.

Ver la página [[Módulo Exportaciones]] para más información.

= Facturas predefinidas =
En Dolibarr, una factura designada como predefinida es simplemente una factura que se puede reutilizar muchas veces para emitir otras facturas con su información como base. Esto permite ganar mucho tiempo.

En el caso de la aplicación de los contratos, una factura predefinida puede ser definida con los correspondientes elementos concurrentes del contrato. Esto es muy interesante.
Tener en cuenta que el período especificado para cada uno de los elementos resultantes de la factura abarca todo el período del contrato. Sólo debería cubrir los meses de facturación.

= Videos =

<youtube width="280">0RXJ0MgwNmI</youtube>

Las facturas:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="280">7BVKHt91jrI</youtube>

Los pagos:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="280">ii8kdfa9BxA</youtube>

= Ejemplos de uso =
== Anticipos ==

{{ExamplesCaseEs
|nombre=UCIN01: Recepción de anticipo en el pedido para la factura final
|situacion=Recibo un pago de anticipo.
|acciones=Creo una factura de anticipo con el importe recibido que clasifico como pagada y que enviaré o no.
Convierto esta factura en una reducción futura.
Más tarde creo la factura completa. Incluyo la reducción del anticipo en la factura completa que reducirá el resto a pagar.
Envío la factura completa generada que indica que un anticipo ya ha sido recibido..
}} 

== Facturación y pagos ==

{{ExamplesCaseEs
|nombre=UCIN02: Facturación y pago completo
|situacion=He creado una factura.
He recibido completamente el pago.
|acciones=He indicado todos los pagos de la factura. El saldo queda a 0.
Puedo clasificar la factura como '''Pagada'''.
}}

{{ExamplesCaseEs
|nombre=UCIN03: Facturación y pago superior recibido
|situacion=He creado una factura.
He recibido un pago superior al importe reclamado.
|acciones=Indico el importe recibido.
Cierro la factura como '''Pagada'''.
Creo un abono con lo recibido de más.
}}

{{ExamplesCaseEs
|nombre=UCIN04: Facturación, pago completo y devolución de producto
|situacion=He creado una factura.
Recibo el pago completo. El saldo queda a 0.
Cierro la factura como '''Pagada'''.
Más tarde, recibo una devolución de un producto.
|acciones=Realizo un abono de esa factura.
Este abono se puede convertir en una redución para la próxima factura o devuelvo el dinero.
}}

{{ExamplesCaseEs
|nombre=UCIN05: Facturación, pago completo y error de producto detectado
|situacion=He creado una factura.
Recibo el pago completo. El saldo queda a 0.
Cierro la factura como '''Pagada'''.
Más tarde, descubro un error de producto.
|acciones=Realizo un abono sobre esta factura que contiene el producto erróneo.
Convierto este abono en reducción.
Creo una nueva factura con el producto bueno. Integro el abono en la factura nueva factura.
Eventualmente, si utilizo el módulo stock, corrigo el stock manualmente.
}}

{{ExamplesCaseEs
|nombre=UCIN06: Facturación y pago parcial como anticipo (descuento)
|situacion=He creado una factura.
He recibido un pago del importe de la factura menos un descuento acordado por pago anticipado.
|acciones=Realizo el pago del valor recibido
Clasifico la factura como '''Pagada parcialmente''' e indico el motivo "La falta es un '''Descuento'''".
}}

{{ExamplesCaseEs
|nombre=UCIN07: Facturación, pago parcial o nulo y retorno de producto, corrección de anomalía o de error tolerable
|situacion=He creado una factura.
Si recibo un pago parcial, lo indico.
Recibo una devolución de una partida de productos (retractation du client) o no recibe el pico de los céntimos que faltan.
Finalmente, el cliente espera un abono a pagar al final de la factura
|acciones=Realizo un abono de la factura.
Envío el abono.
Luego convierto este abono en reducción para el cliente.
Eventualmente, creo los pagos recibidos.
Incluyo el abono en la lista de pagos de la factura (de lo contrario puedo incluirlo en otra factura).
Clasifico la factura como '''Pagada'''.

'''NOTA''':Compruebe que cuando realize el abono sobre una factura en estado 'Empezada', usted tiene que poner un mensaje diciendo "Atención, no cree un abono sobre una factura en proceso si el cliente ha cesado los pagos y espere a que este abono sea atendido para agregarlo en la lista de pagos o a que se cierre la factura.
A continuación, compruebe que el importe del abono es menor que el de la factura para que se aplique - la cantidad ya recibida. En caso contrario, rehuse la creación del abono
}}

{{ExamplesCaseEs
|nombre=UCIN08: Facturación, pago parcial, pero pagador moroso
|situacion=He creado una factura.
He recibido un pago parcial, lo registro.
Después de una larga espera, el resto del pago no se recibe y se pierde la esperanza.
|acciones=Clasifico la factura al estado '''Pagada parcialmente''' e indico el motivo '''Moroso'''.
}}

{{ExamplesCaseEs
|nombre=UCIN09: Facturación y ningún pago recibido por morosidad
|situacion=He creado una factura.
Después de una larga espera, el pago no se recibe y se pierde la esperanza.
|acciones=Clasifico la factura como '''Abandonada''' e indico el motivo '''Moroso'''.
}} 

== Corrección errores en facturación ==

{{ExamplesCaseEs
|nombre=UCIN00: Error en el contenido de una factura a corregir por una factura rectificativa|
|situacion=He creado una factura.
La he validado.
Me doy cuenta del error en el contenido (importe, descripción) después de la validación.
'''Nota''': para errores en el cliente, ver el caso UCIN10.|
|acciones=Clasifico la factura como abandonada con motivo 'Otro' (no es obligatorio).
Creo una nueva factura seleccionando '''Factura rectificativa''', escogiendo la factura a reemplazar como factura.|}}

{{ExamplesCaseEs
|nombre=UCIN10a: Error en el cliente detectado antes del envío de la factura
|situacion=He creado una factura.
La he validado.
Me doy cuenta que la factura se ha creado con un cliente que no és el correcto.
|acciones=Clasifico la factura como abandonada con motivo 'Otro' y reseño el motivo "Error cliente incorrecto".
creo una nueva factura de abono al cliente.

'''NOTA''': Confirmar con los asesores fiscales que esto es posible si se realiza antes del envío.
Si no es posible, prohibir esta la posibilidad y utilizar el caso siguiente.
}}

{{ExamplesCaseEs
|nombre=UCIN10b: Error en el cliente (o factura creada 2 veces) detectado después del envío de la factura pero antes del pago
|situacion=He creado una factura.
La he validado y enviado al cliente.
Me doy cuenta que la factura se ha creado con un cliente que no es el correcto o que la factura es un duplicado de otra factura ya enviada.
|acciones=Creo un abono sobre la factura que aún no se ha pagado con un importe inverso exacto a la factura.
Convierto el abono en reducción. El abono se encuentra "tratado", se lo puedo enviar al cliente si lo deseo.
Vuelvo a la factura errónea y aplico la reducción del abono.
El débito queda entonces a cero y la clasifico como '''Pagada''' (pago de 0).
}}

{{ExamplesCaseEs
|nombre=UCIN10c: Error en el cliente detectado después de realizar el pago
|situacion=He creado una factura al cliente con nombre X.
La he validado.
He realizado los pagos.
La he clasificado como pagada.
Me doy cuenta que la factura se ha creado a un cliente con información errónea y el cliente me pide una contrafactura del cliente X y una nueva factura como cliente Y.
|acciones=Creo un abono sobre la factura errónea con todas las líneas invertidas.
Transformo el abono en reducción. El abono se encuentra "tratado".
Edito la ficha del cliente para corregir el nombre de X a Y
Creo una nueva factura al cliente Y e incluyo todas las líneas.
La valido.
Incluyo el pago del abono
El saldo queda entonces a 0 (sin débito).
Puedo clasificar la factura como '''Pagada''' sin indicar otros pagos (el cliente ya ha pagado).
}} 

== Facturas predefinidas ==

{{ExamplesCaseEs
|nombre=UCRIN01: Creación de una factura predefinida
|situacion=Creación de una factura predefinida
|acciones=No es posible crear una factura recurrente en sí. Se compone de una factura normal que se reutiliza.
}}

{{ExamplesCaseEs
|nombre=UCRIN02: Transformación de una factura normal en factura predefinida
|situacion=Transformación de una factura normal en factura predefinida
|acciones=Abro una factura existente. Hago clic en "Convertir en recurrente". Indico un título (por ejemplo, "Actualización trimestral") y eventualmente una nota que podría ser una explicación del motivo de la repetición de esta factura. Mi factura es ahora una factura recurrente. Esto sólo será visible si pido la visualización de facturas recurrentes o creo una nueva factura.
}}

{{ExamplesCaseEs
|nombre=UCRIN03: Utilización de una factura predefinida para la creación de una nueva factura
|situacion=Utilización de una factura predefinida para la creación de una nueva factura
|acciones=Creo una nueva factura ("Crear factura") y selecciono en "Crear desde factura recurrente" la factura recurrente que quiero utilizar como base (template) de la lista. Mi nueva factura está preparada y las modificaciones a realizar son menores.
}}

Módulo Terceros

2022-10-30T07:43:50Z

Techsc: /* Videos */ Agregando un video (no en el lengua de la pagina pero es mejor que nada y puede ayudar)

[[en:Module_Third_Parties]]
[[fr:Module_Tiers]]
[[de:Modul_Partner]]
[[pt:Módulo_Terceiros]]
[[zh:合伙人模块]]


[[Category:Empresas]]
{{TemplateDocUsuario}}
{{TemplateModES}}
{{BasculeDevUsuario|
nom=Terceros|
num=1|
devdoc=[[Módulo Terceros (desarrollador)]]|
userdoc=Esta página|}}

= Introducción =
El módulo Terceros permite gestionar clientes, clientes potenciales y/o proveedores.

Se trata de un requisito esencial para muchos otros [[Primeras_configuraciones#Módulos|módulos]] que se basan en estos conceptos (facturas, pedidos, contratos, presupuestos, etc...).

También puede crear de 1 a varios Contactos dentro de la Empresa (necesarios para poder crear y tener un seguimiendo de un [[Presupuestos|presupuesto]] o una [[Facturas_a_clientes|factura]]).

Una empresa es una entidad comercial: cliente, proveedor o cliente potencial (Ejemplo: Una SL, una asociación, un particular).

El contacto, a su vez, representa a un individuo o una persona de contacto genérico (por ejemplo, director general o trabajador de la empresa, comercial, presidente o tesorero de la asociación, o un particular).

Dolibarr gestiona de la misma manera los individuos y los negocios.Tambien a los particulares, que suelen tener un "contacto", que contiene las mismas características que el objeto "Empresa".

= Instalación =
{{NoInstallModuleEs}}

= Configuración =
{{ActivationModuleEs}}
La descripción de la configuración del módulo está disponible en la página [[Configuración del módulo terceros]]

= Crear una nueva empresa =
Ir a Clientes - Nuevo Cliente o Cliente Potencial - Nuevo cliente potencial o proveedor - Nuevo proveedor. Escriba la información solicitada (no es necesario que rellene todos los campos).

Una vez que la nueva empresa esté creada, puede agregar notas en la ficha, y adjuntar documentos relacionados.

= Modificar una empresa =
Ir al menú de Empresas, haga clic en la empresa a modificar y seleccione la pestaña ficha.

Haga clic en "Modificar" (abajo a la derecha).

Introduzca los cambios.

Haga clic en "Grabar".

= Eliminar una empresa =
Ir a la ficha de la empresa y haga clic en "Eliminar".
Sólo una empresa que no tenga objetos por cobrar (facturas, contratos, pedidos, etc) puede ser borrada.

= Crear un contacto =
Existen varias posibilidades de creación de contactos:
*Ir al menú Terceros - Contactos - Nuevo Contacto. Escriba la información solicitada (no es necesario que rellene todos los campos). De esta forma creará un contacto que puede no estar vinculado a un tercero.

*Desde un Tercero, ir a la pestaña cliente o proveedor y hacer clic en "Crear contacto". Escriba la información solicitada (no es necesario que rellene todos los campos). Así creará un contacto vinculado a un tercero.

= Modificar un contacto =
Ir al menú de Terceros - Contactos - Listado, haga clic en el contacto a modificar y seleccione la pestaña ficha o información personal.

Haga clic en "Modificar" (abajo a la derecha).

Introduzca los cambios.

Haga clic en "Grabar".

= Eliminar un contacto =
Vaya a la ficha del contacto y haga clic en "Eliminar"

= Ciclo de vida / Reglas de gestión =
Una empresa sólo puede tener una condición: Existe o no.
Una empresa eliminada no cambia el estado, sino que desaparece por completo de Dolibarr.

Puede crear de 1 a varios Contactos físicos en la empresa (serán utlizados como destinatarios de los envíos de e-mail de los [[Módulo Presupuestos| presupuestos]], [[Módulo_Pedidos_de_clientes|pedidos de clientes]] o de [[Módulo_Facturas_a_clientes|facturas a clientes]]...).

= Videos =
<youtube width="280">vH03SiSy0eI</youtube>

Los tercios:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="280">eJUJUPDCOh8</youtube>

Los contactos:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="280">B3lYZgc5KAE</youtube>

Los prospectos:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="280">L1qAVRXjAXE</youtube>

Los clientes:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="280">49VOibps4Vw</youtube>

Los proveedores:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="280">HNstNg_AxHM</youtube>

Módulo Pedidos a proveedores

2022-10-30T07:34:52Z

Techsc: Agregando un video (no en el lengua de la pagina pero es mejor que nada y puede ayudar)

Module Fournisseurs Commandes

2022-10-30T07:32:56Z

Techsc: /* Vidéos sur le sujet */ Révision taille vidéo

[[en:Module_Purchase_Orders]]
[[es:Módulo_Pedidos_a_proveedores]]


[[Category:Fournisseur]]
{{TemplateDocUtil}}
{{TemplateModFR}}
{{BasculeDevUser|
nom=Fournisseur|
num=40|
devdoc=[[Module Fournisseurs (développeur)]]|
userdoc=Cette page|}}

= Introduction =
Le module Fournisseurs permet de saisir et modifier des commandes, composées de lignes de commandes pour un tiers qui est de type Fournisseur.

= Installation =
{{NoInstallModuleFr}}

= Configuration =
{{ActivationModuleFr}}

= Cycle de vie / Règles de gestion =
Une commande fournisseur suit le workflow suivant:
<pre>
Brouillon (0) --> Validé (1) --> Approuvé (2) --> Commandé (3) --------------------------------/---> Reçu totalement (5)
\ \ \--> Reçu partiellement (4) --/ \
\ \ \--> Annulé (7) \
\ \ \ \
\ \-----------------\-----------------------------------------\----> Création de la facture (si module facture actif) ou Classer facturé
\ \
\ \- Annulé (6)
\
\- Refusé (9)
</pre>

=Créer une commande fournisseur=
La création d'une commande fournisseur se fait à partir de la fiche fournisseur dans la partie tiers ou fournisseurs de l'application, onglet fournisseur. Le bouton le permettant se trouve dans la barre d'action de la fiche fournisseur.

La commande est alors créée à l'état de brouillon.

Il faut alors sélectionner des produits vendus par le fournisseur dans la liste donnée. Si l'on veut rajouter un nouveau produit, il est nécessaire de passer par l'interface des produits/services, de créer un produit puis d'utiliser l'onglet fournisseur de la fiche produit et d'indiquer le prix et la quantité minimum pour ce fournisseur. Le produit est alors disponible dans la liste des produits de ce fournisseur et peut être ajouté à la ligne de commande.

=Clôturer une commande fournisseur=
Une fois que les produits ou services d'une commande ont bien été reçue, il faut retourner sur la fiche commande pour saisir la réception.
Le statuts de la commande passe alors à reçu partiellement ou reçu complètement selon les informations saisies.

=Supprimer une commande fournisseur=
Pour supprimer une commande il vous faut ouvrir la fiche de celle-ci. Une commande ne peut être supprimée que si celle-ci est à l'état de '''brouillon'''. Une fois validée, elle peut seulement être annulée. La suppression d'un commande entraîne l'effacement de toutes les données s'y référant.

'''Une commande supprimée ne peut pas être récupérée'''.
Mieux vaut donc ne pas donner les droits de suppression et utiliser plutôt le classement de la commande à Annuler que faire une suppression si vous voulez conserver toute traces d'action.

=Modifier une commande fournisseur=
Pour modifier une commande il vous faut ouvrir sa fiche. Une commande ne peut être modifiée que si celle-ci est à l'état de brouillon.

= Cas d'utilisations =

{{ExamplesCaseFr
|nom=UCSOR01: Réception partielle d'une commande fournisseur et ventilation dans le stock
|situation=Vous recevez une commande fournisseur incomplète et vous voulez suivre les éléments arrivés
|actions=il faut :
* un ou plusieurs stocks pour y envoyer les éléments reçus
* Les éléments de la commande doivent être listés dans la partie "produits"
* La commande doit être faite à partir des "produits"
* Le module "stock" est actif avec l'option "Incrémente les stocks physiques sur ventilation manuelle de la réception des commandes fournisseurs dans les entrepôts" à "OUI"

A partir du moment où la commande est envoyée, vous avez accés à l'onglet "Reception vers stocks" qui vous permet de ventiler les produits recus.

Attention, la ventillation des produits n'est pas reliée à l'utilisation de l'onglet "Réceptionner" de la commande, ni à emission de facture partielle. Il convient donc d'être prudent dans son utilisation.

}} 

{{ExamplesCaseFr
|nom=UCSOR02: Commande fournisseur
|situation=
|actions=
}} 

=Vidéos sur le sujet=
<youtube width="200" height="120">g0jfZlNUAZA</youtube>

Les commandes fournisseur:

<youtube width="200" height="120">QL_gZbJToFQ</youtube>

Módulo Facturas de proveedores

2022-10-30T07:31:07Z

Techsc: /* Video */

[[en:Module_Suppliers_Invoices]]
[[fr:Module_Fournisseurs_Factures]]


[[Category:Proveedores]]
{{TemplateDocUsuario}}
{{TemplateModES}}
{{BasculeDevUsuario|
nom=Proveedores|
num=40|
devdoc=[[Módulo Proveedores (desarrollador)]]|
userdoc=Esta página|}}

= Introducción =
El módulo Facturas de Proveedores permite crear o modificar una factura compuesta por líneas de factura de un tercero que sea del tipo Proveedor. Este mismo módulo permite la introducción de los pagos realizados para estas facturas.

= Instalación =
{{NoInstallModuleEs}}

= Configuración =
{{ActivationModuleEs}}

= Creación de factura =

'''Tipos de facturas'''

Actualmente, sólo las facturas de débito son gestionadas por las facturas de proveedores

* Las facturas de débito
Se componen de una factura standard.
No hay prerequisitos.

'''Proceso'''

Una vez la factura haya sido creada (en modo ''borrador''), debe integrar en la factura los Productos o Servicios ya definidos en Dolibarr, tambien puede indicar directamente la descripción, la tasa de IVA y el precio unitario.
Para cada línea de la factura debe indicar también una cantidad y eventualmente un descuento.

Una vez la factura esté lista, debe validarla. '''Atención''' esta operación es irreversible.
Cuando valide la factura se le atribuye un número según el modelo de numeración indicado en la configuración del módulo Proveedores.
Si se detecta un error despues de haber validado la factura, deberá realizar una factura rectificativa, o una factura de abono.

= Introducir los pagos =
Para introducir el pago de una factura de proveedor, simplemente seleccione la factura correspondiente en la lista de facturas de proveedores y haga clic en "Emitir pago".
En la nueva ventana, rellene los campos "Fecha", "Forma de pago", eventualmente el número y la cuenta bancaria en cuestión. Considere la posibilidad de copiar los importes pagados en la(s) casilla(s) "Importe" al final de la línea, seguidamente haga clic en "Grabar".

= Clasificar la factura =
Después de emitir un pago, la factura pasa al estado "Iniciada" (lista de facturas pendientes de cobro) o al estado "Empezada" (en la factura). Para dejarla en estado "Pagada", es aconsejable clasificar la factura como pagada: seleccione la factura correspondiente y haga clic en "Clasificar 'Pagado'", confirme la petición. Si una factura no está clasificada como "pagada", pero el pago ha sido emitido, la factura pasa de "Pendiente de pago" a "Empezada", pero será considera como una factura sin pagar en la lista de las facturas de proveedores.

= Exportar las facturas de proveedores =
Ver el [[Módulo Exportaciones]].

= Facturación de proveedor y recepción de abono por error de factura =
Situacion: Recibo una factura de proveedor y un abono por error en la misma

Acciones:
* Introduzco la factura de proveedor (factura de débito).
* Recibo el abono del proveedor (factura de abono/nota de crédito), y creo una factura de proveedor normal pero con el importe en negativo.
* Pago (Emito el pago).
* Realizo el pago de la factura de proveedor y un pago negativo en la factura de abono del proveedor.
* Clasifico las dos facturas como "pagadas".
Un pago positivo y otro negativo corregirán el problema y aparecerán en la relación bancaria.

= Video =
<youtube width="200" height="120">q0LfpoyEncE</youtube>

Las facturas de proveedores:
(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">UdKV5rA1JI8</youtube>

Módulo Facturas de proveedores

2022-10-30T07:30:51Z

Techsc: /* Video */ Agregando un video (no en el lengua de la pagina pero es mejor que nada y puede ayudar)

[[en:Module_Suppliers_Invoices]]
[[fr:Module_Fournisseurs_Factures]]


[[Category:Proveedores]]
{{TemplateDocUsuario}}
{{TemplateModES}}
{{BasculeDevUsuario|
nom=Proveedores|
num=40|
devdoc=[[Módulo Proveedores (desarrollador)]]|
userdoc=Esta página|}}

= Introducción =
El módulo Facturas de Proveedores permite crear o modificar una factura compuesta por líneas de factura de un tercero que sea del tipo Proveedor. Este mismo módulo permite la introducción de los pagos realizados para estas facturas.

= Instalación =
{{NoInstallModuleEs}}

= Configuración =
{{ActivationModuleEs}}

= Creación de factura =

'''Tipos de facturas'''

Actualmente, sólo las facturas de débito son gestionadas por las facturas de proveedores

* Las facturas de débito
Se componen de una factura standard.
No hay prerequisitos.

'''Proceso'''

Una vez la factura haya sido creada (en modo ''borrador''), debe integrar en la factura los Productos o Servicios ya definidos en Dolibarr, tambien puede indicar directamente la descripción, la tasa de IVA y el precio unitario.
Para cada línea de la factura debe indicar también una cantidad y eventualmente un descuento.

Una vez la factura esté lista, debe validarla. '''Atención''' esta operación es irreversible.
Cuando valide la factura se le atribuye un número según el modelo de numeración indicado en la configuración del módulo Proveedores.
Si se detecta un error despues de haber validado la factura, deberá realizar una factura rectificativa, o una factura de abono.

= Introducir los pagos =
Para introducir el pago de una factura de proveedor, simplemente seleccione la factura correspondiente en la lista de facturas de proveedores y haga clic en "Emitir pago".
En la nueva ventana, rellene los campos "Fecha", "Forma de pago", eventualmente el número y la cuenta bancaria en cuestión. Considere la posibilidad de copiar los importes pagados en la(s) casilla(s) "Importe" al final de la línea, seguidamente haga clic en "Grabar".

= Clasificar la factura =
Después de emitir un pago, la factura pasa al estado "Iniciada" (lista de facturas pendientes de cobro) o al estado "Empezada" (en la factura). Para dejarla en estado "Pagada", es aconsejable clasificar la factura como pagada: seleccione la factura correspondiente y haga clic en "Clasificar 'Pagado'", confirme la petición. Si una factura no está clasificada como "pagada", pero el pago ha sido emitido, la factura pasa de "Pendiente de pago" a "Empezada", pero será considera como una factura sin pagar en la lista de las facturas de proveedores.

= Exportar las facturas de proveedores =
Ver el [[Módulo Exportaciones]].

= Facturación de proveedor y recepción de abono por error de factura =
Situacion: Recibo una factura de proveedor y un abono por error en la misma

Acciones:
* Introduzco la factura de proveedor (factura de débito).
* Recibo el abono del proveedor (factura de abono/nota de crédito), y creo una factura de proveedor normal pero con el importe en negativo.
* Pago (Emito el pago).
* Realizo el pago de la factura de proveedor y un pago negativo en la factura de abono del proveedor.
* Clasifico las dos facturas como "pagadas".
Un pago positivo y otro negativo corregirán el problema y aparecerán en la relación bancaria.

= Video =
<youtube width="200" height="120">q0LfpoyEncE</youtube>

Las facturas de proveedores:

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">UdKV5rA1JI8</youtube>

Módulo Pedidos de clientes

2022-10-30T07:28:45Z

Techsc: Agregando un video (no en el lengua de la pagina pero es mejor que nada y puede ayudar)

[[en:Module_Sales_Orders]]
[[fr:Module_Commandes_Clients]]
[[de:Modul Kundenaufträge]]


[[Category:Pedido]]
{{TemplateDocUsuario}}
{{TemplateModES}}
{{BasculeDevUsuario|
nom=Pedidos|
num=25|
devdoc=[[Módulo Pedidos (desarrollador)]]|
userdoc=Esta página|}}

= Introducción =
Con este módulo puede gestionar (crear, editar, borrar, listar) sus pedidos de clientes.

También podrá convertir los pedidos de clientes en facturas (si usa el [[Módulo Facturas a clientes]]).

Permite la generación de los pedidos en un formato de documento odt así como en PDF.

Los pedidos a proveedor son gestionados por el módulo [[Módulo Pedidos a proveedores]].

= Instalación =
{{NoInstallModuleEs}}

= Configuración =
{{ActivationModuleEs}}

= Ciclo de vida / Reglas de gestión =
Un pedido de cliente habitualmente sigue el siguiente ciclo de vida:

Si el módulo de Expediciones está activado:
<pre>
Borrador --> Validado --> En proceso --> Enviado --> Tratado
--> Anulado
</pre>

Si el módulo de Expediciones no está activado:
<pre>
Borrador --> Validado --> Enviado --> Tratado
--> Anulado
</pre>

* El estado "A facturar" no es un estado específico de pedidos, ya que para algunos usuarios será lo mismo que el estado "Validado", para otros será "Enviado". La factura puede crearse tanto antes como después del envío, dependiendo de la organización de la empresa.

* El estado "Expedición en curso" solo se ve si se usa el [[Módulo Expediciones]].

Una vez que un pedido de cliente haya sido validado por su creador, si tiene activado el [[Módulo Expediciones]], puede generar una o varias notas de entrega, ver hojas de recepción para enviar sus productos. Esto puede hacerse en cualquier momento después de la validación y antes de que el pedido pase al estado de procesado o cancelado.

También puede cerrar el proceso de un pedido (cambio al estado "Enviado") cuando lo desee.

Dispondrá de la posibilidad de crear una o varias facturas a cliente desde el pedido, ya sea desde pedidos validados o enviados. Por defecto las facturas creadas desde un pedido contendrán el mismo contenido/importe, pero puede editar la factura una vez generada desde el pedido para cambiarla.

Si hace clic en "Clasificar facturado", cambiará el estado a "Procesado" (fin de su ciclo de vida) y el pedido desaparecerá del menú "Pedidos a facturar".

=Crear un pedido=
la creación de un pedido se realiza a partir de la ficha cliente dentro del área comercial de la aplicación. El link que permite esto se encuentra dentro de la barra de acciones de la ficha.

Un pedido es creado automáticamente al cerrar un presupuesto, siendo este pedido creado en el estado borrador.

=Modificar un pedido=
Para modificar un pedido es necesario abrir su ficha. Un pedido puede modificarse solamente si se encuentra en el estado borrador.

=Cerrar un pedido=
Una vez que un pedido este totalmente expedido, es necesario ir a su ficha para cerrarlo. Enonces será mostrado en el área de contabilidad como "A facturar"

=Eliminar un pedido=
Para eliminar un pedido es necesario abrir su ficha. Un pedido puede eliminarse solamente si se encuentra en el estado '''borrador'''. Una vez validado, solamente puede ser anulado. La eliminación de un pedido entraña el borrado de todos los datos y referencias

'''Un pedido eliminado no puede ser recuperado'''.

= Ejemplos casos de uso =
{{ExamplesCaseEs
|nombre=UCCU01:
|situacion=
|acciones=
}} 

= Videos =

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">-2pNTeUXQ0o</youtube>

Módulo Contabilidad

2022-10-30T07:27:02Z

Techsc: Agregando un video (no en el lengua de la pagina pero es mejor que nada y puede ayudar)

Primeras configuraciones

2022-10-30T07:24:48Z

Techsc: Agregando un video (no en el lengua de la pagina pero es mejor que nada y puede ayudar)

[[en:First_setup]]
[[fr:Premiers_paramétrages]]
[[de:Grundeinstellungen]]
[[pt:Configuração_inicial]]
[[zh:设置]]


[[Category:Admin es]]
{{TemplateDocUsuario}}

Después de la instalación de Dolibarr, debe establecer los parámetros para adaptar Dolibarr a sus necesidades antes de su puesta en funcionamiento.

= Empresa/Institución =
Para empezar, desde la página principal, vaya a "'''Configuración->Empresa/Institución'''" y edite la información de su institución.
* '''Nombre:''' Nombre de la empresa o asociación
* '''Logo:''' Añada aquí su logo (.png, .jpg or .gif). No hay recomendación de tamaño, pero es mejor un formato png SIN fondo transparente (Dolibarr usa FPDF que no gestiona ese tipo de fichero). En caso de duda, utilice un logotipo en formato jpg con un fondo blanco.
* '''País''' No olvide indicar su país, ya que algunas opciones dependen de ello.
* '''IVA:''' Indique si usted se encuentra sometido o no a IVA.

= Módulos =
La activación de los módulos es muy importante. Depende de lo que planee hacer con Dolibarr. Es muy poco probable que usted necesite todos los módulos.
Debe activar los módulos que probablemente necesite. Por ejemplo: Empresas, Facturas, Contabilidad.

Para activar los módulos que necesite, vaya a la página "'''Configuración -> Módulos'''" y haga click en el link "Activar" en cada módulo que necesite.

El listado de módulos estándar está disponible en la página [[:Category:Listado de Módulos|Listado de Módulos]].

Si no está seguro de que módulos activar, vaya uno tras otro y vea las características que ofrecen en Dolibarr (compruebe los derechos, ver más adelante). Por supuesto, es posible deshabilitar los módulos después.

Una vez activados, algunos módulos requieren configuración adicional (haga clic en el icono que aparece en la misma línea).
Véase [[:Category:Listado de Módulos|Listado de Módulos]] para más información.

Videos:

Los módulos:

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">qfYP-iKWd7U</youtube>

Configuración de los módulos:

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="200" height="120">toT0jfmMCoU</youtube>

= Menús =
Elija en esta sección que gestor de menús usar para los usuarios internos y externos. El gestor de menú influye en las etiquetas, orden y organización de los menús superiores e izquierdos. Vea la página [[Sistema de menús]] para más información.

= Entorno =
Esta sección le permite elegir el idioma y la presentación de páginas. Como primer paso debería mantener las opciones por defecto.

La opción multi-idioma permite gestionar las traducciones para cada idioma de los productos, así como la elección del idioma por defecto de los terceros, con el fin de crear los documentos PDF en el idioma por defecto del tercero

= Otros (Paneles, Alertas, Seguridad, Límites y precisiones, E-Mails, Diccio...)=
Las otras entradas en el menú de configuración son opciones avanzadas.
No es obligatorio ir.
* [[Configuración Paneles]]
* [[Configuración Alertas]]
* [[Configuración Seguridad]]
* [[Configuración Límites y precisiones]]
* [[Configuración PDF]]
* [[Configuración E-Mails]]
* [[Configuración SMS]]
* [[Configuración Diccionarios]]
* [[Configuración Varios]]

= Usuarios =
El último paso es crear los usuarios. Casi todos los módulos, previamente activados, no son accesibles si no les damos el permiso.
Para hacer esto, usted puede ir a los '''Usuarios y Grupos''' para identificar a los usuarios y sus derechos. Atención, tenga en cuenta la definición de los derechos de los usuarios, y también las comprobaciones en el momento de agregar un módulo.
La lista de derechos adquiridos depende de los módulos activados (véase más arriba), por lo que se recomienda que configure esta después de activar los módulos deseados.
Para algunas acciones, si no se tiene el derecho a una acción, Dolibarr no se lo propondrá. Es posible que pierda algo útil y / o importante.
A fin de dar derechos a un usuario o a usted mismo si es un administrador, vaya a '''Inicio->Usuarios y grupos''', escoja la ficha del usuario deseado y haga clic en la pestaña '''Permisos usuario'''.

=Videos=

La configuración básica :

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="280">S5Rm9ixHNRA</youtube>

Los opciones de configuración :

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="280">o5VOYomd_Ns</youtube>

La configuración visual : Darkmode :

(la voz esta en frances pero los subtitulos están disponibles y verificados en este lengua)

<youtube width="280">cdhWVmTg54U</youtube>

Primeras configuraciones

2022-10-30T07:21:02Z

Techsc: /* Módulos */