« ExtraOdt » : différence entre les versions
Page créée avec « <pdf>File:Guide_utilisateur_du_module_ExtraOdt_1.0.0.pdf</pdf> » |
Aucun résumé des modifications |
||
(49 versions intermédiaires par 2 utilisateurs non affichées) | |||
Ligne 1 : | Ligne 1 : | ||
< | {| class="wikitable" | ||
|- style="vertical-align:top;" | |||
| [[File:MyManagement-250x250.jpeg |250px]] | |||
| Le module permet de créer à partir des ODTs (documents textes) natifs de Dolibarr, des documents texte personnalisés à générer depuis les fiches des éléments . | |||
|} | |||
== Pré-réquis d'installation == | |||
Le module <strong>ExtraOdt</strong> fonctionne avec Dolibarr à partir de la version 3.6.1 .<br> | |||
Pour les versions inférieures, un patch est nécessaire : <br> | |||
Le patch est présent dans le fichier <i>"/htdocs/extraodt/core_update/include/odtphp"</i>. Il doit être placé dans le fichier "/htdocs/include/odtphp". | |||
== Configuration du Module == | |||
Le module ExtraOdt s'installe comme n'importe quel module de Dolibarr, en décompressant le dossier .zip dans le dossier \htdocs. <br> | |||
Le module doit être activé dans la configuration de Dolibarr.<br> | |||
{| class="wikitable" | |||
|- style="vertical-align:top;" | |||
| [[File:ExtraOdt_Config1.png |850px]] | |||
|La page de configuration s’affiche en cliquant sur l'icône de configuration en bout de ligne à droite sur la page des modules . | |||
|} | |||
{| class="wikitable" | |||
|- style="vertical-align:top;" | |||
| [[File:ExtraOdt_Config2.png |850px]] | |||
|L’onglet <strong>Configuration</strong> permet l’enregistrement des critères d’affichage des lignes et les conditions de filtrage. <br> | |||
* Le champ <strong>Nombre de ligne</strong> permet de fixer la limite des lignes à afficher.<br> | |||
* Le champ <strong>Condition de filtrage</strong> permet, à partir d'une requête SQL de sélectionner les données à afficher dans le document.<br> | |||
Enregistrer la sélection en cliquant sur le bouton <strong>Modifier</strong>.<br> | |||
* L'onglet <strong>Readme</strong> affiche la liste des balises modifiées dans le module. | |||
* L'onglet <strong>À Propos</strong> affiche la liste des champs utilisables dans les modèles de documents. | |||
|} | |||
== Configuration de Dolibarr == | |||
Pour rendre ExtraOdt opérationnel, il convient d’activer les modèles de documents dans les modules concernés : | |||
{| class="wikitable" | |||
|- style="vertical-align:top;" | |||
| [[File:ExtraOdt_Config3.png |850px]] | |||
|Accueil > Configuration > Modules/Applications > Gestion de la relation client (GRC) > Tiers > L'onglet Divers > Modèle de documents > ODT templates > État "Activé" | |||
|} | |||
Puis d’indiquer dans le champ "Odt template" l’emplacement du document texte modèle en utilisant les sauts de ligne pour séparer les différents emplacements . Enregistrer avec le bouton "Modifier" .<br> | |||
Une fois le nouvel emplacement indiqué, la ligne "Nombre de fichiers modèles ODT/ODS trouvés dans ce(s) répertoire(s)" indique le nombre de modèles trouvés par Dolibarr . <br><br> | |||
<span style="color:orange"><strong>Note ></strong></span> <br> | |||
* Par défaut dans Dolibarr, les modèles de documents sont stockés dans le dossier "\documents\doctemplates".<br> | |||
* ExtraOdt inclut un modèle disponible dans le dossier "\htdocs\extraodt\odtsample". Cet emplacement peut être utilisé en tant que chemin indiqué dans la configuration des modules dans Dolibarr. <br> | |||
* Uns fois enregistré, le nouveau modèle de document apparaitra dans la liste de sélection de documents : <br> | |||
{| class="wikitable" | |||
|- style="vertical-align:top;" | |||
| [[File:ExtraOdt_Config4.png |850px]] | |||
|} | |||
== Création d'un nouveau modéle de document == | |||
=== Document texte === | |||
A partir d’un logiciel de traitement de texte (open office, libre office,…), créer un nouveau document comprenant les informations souhaitées sous forme de balises. Les balises seront modifiées par Dolibarr au moment de la génération du document.<br> | |||
<span style="color:orange"><strong>Note ></strong></span><br> | |||
* Les balises sont entourées de {} et doivent être tapées en une seule fois (sans retour arrière ou effacement, ni par copier-coller). Dans le cas contraire, les balises risquent de ne pas être traitées dans le document généré. <br> | |||
* Il est possible de contourner cette contrainte par copier-coller des balises en passant par un éditeur de texte (bloc-note, notepad++...).<br> | |||
* Enregistrer le document dans le répertoire indiqué dans le champ "Odt templates" du module concerné. | |||
=== Liste des Balises === | |||
{| class="wikitable" | |||
|- | |||
|+ ACTION COMMERCIAL | |||
|- | |||
| style="width: 300pt;"| Nombre de lignes|| style="width: 300pt;" | nbActionOnODT | |||
|- | |||
| Filtrage || CondActionOnODT | |||
|- | |||
| Balise || Companyaction | |||
|- | |||
| Champs || | |||
companyaction_code <br> | |||
companyaction_label <br> | |||
companyaction_datep <br> | |||
companyaction_datep2 <br> | |||
companyaction_datea <br> | |||
companyaction_datea2 <br> | |||
companyaction_percent <br> | |||
companyaction_note <br> | |||
companyaction_location <br> | |||
companyaction_durationa <br> | |||
companyaction_socpeople <br> | |||
companyaction_durationp <br> | |||
companyaction_punctual <br> | |||
companyaction_priority <br> | |||
companyaction_elementtype <br> | |||
companyaction_usertodo <br> | |||
|} | |||
{| class="wikitable" | |||
|- style="vertical-align:top;" | |||
|+ PROPOSITION COMMERCIALE | |||
|- | |||
|- | |||
| style="width: 300pt;" | Nombre de lignes|| style="width: 300pt;" | nbPropaleOnODT | |||
|- | |||
| Filtrage || CondPropaleOnODT | |||
|- | |||
| Balise || companypropale | |||
|} | |||
{| class="wikitable" | |||
|- style="vertical-align:top;" | |||
|+ FACTURES | |||
|- | |||
|- | |||
| style="width: 300pt;" | Nombre de lignes|| style="width: 300pt;" | nbBillOnODT | |||
|- | |||
| Filtrage || CondBillOnODT | |||
|- | |||
| Balise || companybill | |||
|} | |||
{| class="wikitable" | |||
|- style="vertical-align:top;" | |||
|+ COMMANDE FOURNISSEUR | |||
|- | |||
|- | |||
| style="width: 300pt;" | Nombre de lignes|| style="width: 300pt;" | nbSupplierOrderOnODT | |||
|- | |||
| Filtrage || CondSupplierOrderOnODT | |||
|- | |||
| Balise || companysupplierorder | |||
|} | |||
{| class="wikitable" | |||
|- style="vertical-align:top;" | |||
|+ FACTURE FOURNISSEUR | |||
|- | |||
|- | |||
| style="width: 300pt;" | Nombre de lignes|| style="width: 300pt;" | nbSupplierBillOnODT | |||
|- | |||
| Filtrage || CondSupplierBillOnODT | |||
|- | |||
| Balise || companysupplierbill | |||
|} | |||
=== Liste des Codes ODTs === | |||
Remplacer “balise” par le code de l’élément souhaité dans les tableaux ci-dessus : | |||
* balise_ref | |||
* balise_ref_ext | |||
* balise_ref_customer | |||
* balise_ref_supplier | |||
* balise_source_invoice_ref | |||
* balise_hour | |||
* balise_date | |||
* balise_date_rfc | |||
* balise_date_limit | |||
* balise_date_end | |||
* balise_date_creation | |||
* balise_date_modification | |||
* balise_date_validation | |||
* balise_date_delivery_planed | |||
* balise_date_close | |||
* balise_payment_mode_code | |||
* balise_payment_mode | |||
* balise_payment_term_code | |||
* balise_payment_term | |||
* balise_total_ht_locale | |||
* balise_total_vat_locale | |||
* balise_total_localtax1_locale | |||
* balise_total_localtax2_locale | |||
* balise_total_ttc_locale | |||
* balise_total_discount_ht_locale | |||
* balise_total_ht | |||
* balise_total_vat | |||
* balise_total_localtax1 | |||
* balise_total_localtax2 | |||
* balise_total_ttc | |||
* balise_total_discount_ht | |||
* balise_note_private | |||
* balise_note | |||
* balise_already_payed_locale | |||
* balise_remain_to_pay_locale | |||
* balise_already_payed | |||
* balise_remain_to_pay |
Dernière version du 5 avril 2024 à 00:11
Le module permet de créer à partir des ODTs (documents textes) natifs de Dolibarr, des documents texte personnalisés à générer depuis les fiches des éléments . |
Pré-réquis d'installation
Le module ExtraOdt fonctionne avec Dolibarr à partir de la version 3.6.1 .
Pour les versions inférieures, un patch est nécessaire :
Le patch est présent dans le fichier "/htdocs/extraodt/core_update/include/odtphp". Il doit être placé dans le fichier "/htdocs/include/odtphp".
Configuration du Module
Le module ExtraOdt s'installe comme n'importe quel module de Dolibarr, en décompressant le dossier .zip dans le dossier \htdocs.
Le module doit être activé dans la configuration de Dolibarr.
La page de configuration s’affiche en cliquant sur l'icône de configuration en bout de ligne à droite sur la page des modules . |
Configuration de Dolibarr
Pour rendre ExtraOdt opérationnel, il convient d’activer les modèles de documents dans les modules concernés :
Accueil > Configuration > Modules/Applications > Gestion de la relation client (GRC) > Tiers > L'onglet Divers > Modèle de documents > ODT templates > État "Activé" |
Puis d’indiquer dans le champ "Odt template" l’emplacement du document texte modèle en utilisant les sauts de ligne pour séparer les différents emplacements . Enregistrer avec le bouton "Modifier" .
Une fois le nouvel emplacement indiqué, la ligne "Nombre de fichiers modèles ODT/ODS trouvés dans ce(s) répertoire(s)" indique le nombre de modèles trouvés par Dolibarr .
Note >
- Par défaut dans Dolibarr, les modèles de documents sont stockés dans le dossier "\documents\doctemplates".
- ExtraOdt inclut un modèle disponible dans le dossier "\htdocs\extraodt\odtsample". Cet emplacement peut être utilisé en tant que chemin indiqué dans la configuration des modules dans Dolibarr.
- Uns fois enregistré, le nouveau modèle de document apparaitra dans la liste de sélection de documents :
Création d'un nouveau modéle de document
Document texte
A partir d’un logiciel de traitement de texte (open office, libre office,…), créer un nouveau document comprenant les informations souhaitées sous forme de balises. Les balises seront modifiées par Dolibarr au moment de la génération du document.
Note >
- Les balises sont entourées de {} et doivent être tapées en une seule fois (sans retour arrière ou effacement, ni par copier-coller). Dans le cas contraire, les balises risquent de ne pas être traitées dans le document généré.
- Il est possible de contourner cette contrainte par copier-coller des balises en passant par un éditeur de texte (bloc-note, notepad++...).
- Enregistrer le document dans le répertoire indiqué dans le champ "Odt templates" du module concerné.
Liste des Balises
Nombre de lignes | nbActionOnODT |
Filtrage | CondActionOnODT |
Balise | Companyaction |
Champs |
companyaction_code |
Nombre de lignes | nbPropaleOnODT |
Filtrage | CondPropaleOnODT |
Balise | companypropale |
Nombre de lignes | nbBillOnODT |
Filtrage | CondBillOnODT |
Balise | companybill |
Nombre de lignes | nbSupplierOrderOnODT |
Filtrage | CondSupplierOrderOnODT |
Balise | companysupplierorder |
Nombre de lignes | nbSupplierBillOnODT |
Filtrage | CondSupplierBillOnODT |
Balise | companysupplierbill |
Liste des Codes ODTs
Remplacer “balise” par le code de l’élément souhaité dans les tableaux ci-dessus :
- balise_ref
- balise_ref_ext
- balise_ref_customer
- balise_ref_supplier
- balise_source_invoice_ref
- balise_hour
- balise_date
- balise_date_rfc
- balise_date_limit
- balise_date_end
- balise_date_creation
- balise_date_modification
- balise_date_validation
- balise_date_delivery_planed
- balise_date_close
- balise_payment_mode_code
- balise_payment_mode
- balise_payment_term_code
- balise_payment_term
- balise_total_ht_locale
- balise_total_vat_locale
- balise_total_localtax1_locale
- balise_total_localtax2_locale
- balise_total_ttc_locale
- balise_total_discount_ht_locale
- balise_total_ht
- balise_total_vat
- balise_total_localtax1
- balise_total_localtax2
- balise_total_ttc
- balise_total_discount_ht
- balise_note_private
- balise_note
- balise_already_payed_locale
- balise_remain_to_pay_locale
- balise_already_payed
- balise_remain_to_pay